jordan-servant-openapi-0.1.0.0: OpenAPI schemas for Jordan-Powered Servant APIs
Safe HaskellNone
LanguageHaskell2010

Jordan.Servant.OpenApi

Description

Provides orphan instances for Jordan servant combinators that allow the generation of documentation.

Documentation

errorResponse :: Declare (Definitions Schema) Response Source #

Orphan instances

(ToJSON a, Typeable a) => ToSchema (ViaJordan a) Source # 
Instance details

Methods

declareNamedSchema :: Proxy (ViaJordan a) -> Declare (Definitions Schema) NamedSchema #

(HasOpenApi sub, FromJSON a) => HasOpenApi (ReportingRequestBody a :> sub :: Type) Source # 
Instance details

Methods

toOpenApi :: Proxy (ReportingRequestBody a :> sub) -> OpenApi #

(HasOpenApi sub, FromJSON a, KnownSymbol baseKey, SBoolI (FoldRequired mods)) => HasOpenApi (JordanQuery' baseKey mods a :> sub :: Type) Source # 
Instance details

Methods

toOpenApi :: Proxy (JordanQuery' baseKey mods a :> sub) -> OpenApi #