Skip to content

Add description to response headers #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add description to response headers #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions src/Servant/OpenApi/Internal.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,11 +447,15 @@ instance (Accept c, AllAccept cs) => AllAccept (c ': cs) where
class ToResponseHeader h where
toResponseHeader :: Proxy h -> (HeaderName, OpenApi.Header)

instance (KnownSymbol sym, ToParamSchema a) => ToResponseHeader (Header sym a) where
toResponseHeader _ = (hname, mempty & schema ?~ hschema)
instance (KnownSymbol sym, ToParamSchema a, KnownSymbol (FoldDescription mods)) => ToResponseHeader (Header' mods sym a) where
toResponseHeader _ = (hname, header)
where
hname = Text.pack (symbolVal (Proxy :: Proxy sym))
hschema = Inline $ toParamSchema (Proxy :: Proxy a)
transDesc "" = Nothing
transDesc desc = Just (Text.pack desc)
header = mempty
& description .~ transDesc (reflectDescription (Proxy :: Proxy mods))
& schema ?~ Inline (toParamSchema (Proxy :: Proxy a))

class AllToResponseHeader hs where
toAllResponseHeaders :: Proxy hs -> InsOrdHashMap HeaderName OpenApi.Header
Expand Down