Skip to content

Set required attribute for request bodies #57

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

Set required attribute for request bodies #57

Show file tree
Hide file tree
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
9 changes: 6 additions & 3 deletions src/Servant/OpenApi.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,8 @@ import Servant.OpenApi.Internal.Orphans ()
-- "$ref": "#/components/schemas/User"
-- }
-- }
-- }
-- },
-- "required": true
-- },
-- "responses": {
-- "200": {
Expand Down Expand Up @@ -288,7 +289,8 @@ import Servant.OpenApi.Internal.Orphans ()
-- "$ref": "#/components/schemas/User"
-- }
-- }
-- }
-- },
-- "required": true
-- },
-- "responses": {
-- "200": {
Expand Down Expand Up @@ -420,7 +422,8 @@ import Servant.OpenApi.Internal.Orphans ()
-- "$ref": "#/components/schemas/User"
-- }
-- }
-- }
-- },
-- "required": true
-- },
-- "responses": {
-- "200": {
Expand Down
3 changes: 2 additions & 1 deletion src/Servant/OpenApi/Internal.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ instance (KnownSymbol sym, ToParamSchema a, HasOpenApi sub, SBoolI (FoldRequired
& in_ .~ ParamHeader
& schema ?~ (Inline $ toParamSchema (Proxy :: Proxy a))

instance (ToSchema a, AllAccept cs, HasOpenApi sub, KnownSymbol (FoldDescription mods)) => HasOpenApi (ReqBody' mods cs a :> sub) where
instance (ToSchema a, AllAccept cs, HasOpenApi sub, KnownSymbol (FoldDescription mods), SBoolI (FoldRequired mods)) => HasOpenApi (ReqBody' mods cs a :> sub) where
toOpenApi _ = toOpenApi (Proxy :: Proxy sub)
& addRequestBody reqBody
& addDefaultResponse400 tname
Expand All @@ -402,6 +402,7 @@ instance (ToSchema a, AllAccept cs, HasOpenApi sub, KnownSymbol (FoldDescription
(defs, ref) = runDeclare (declareSchemaRef (Proxy :: Proxy a)) mempty
reqBody = (mempty :: RequestBody)
& description .~ transDesc (reflectDescription (Proxy :: Proxy mods))
& required .~ (if reflectBool (Proxy :: Proxy (FoldRequired mods)) then Just True else Nothing)
& content .~ InsOrdHashMap.fromList [(t, mempty & schema ?~ ref) | t <- allContentType (Proxy :: Proxy cs)]

-- | This instance is an approximation.
Expand Down