Servant.Zeppelin.Swagger

Documentation

The purpose of this package is provide the instance for 'servant-zepplin' combinators needed for 'servant-swagger' documentation generation.

data SideLoad fs :: [*] -> *

Combinator to indicate the availablity of side loaded data.

"albums" :> Get '[JSON] Album :> SideLoad '[Person, [Photo]]

Orphan instances

(ToSchema a, ToDependencySchema deps, AllAccept [*] cs, KnownNat status, SwaggerMethod k1 method) => HasSwagger * ((:>) * * (Verb * k1 method status cs a) (SideLoad deps))

Methods

toSwagger :: Proxy ((* :> *) (Verb * k1 method status cs a) (SideLoad deps)) api -> Swagger

(ToSchema a, ToDependencySchema deps) => ToSchema (SideLoaded a deps)

Methods

declareNamedSchema :: proxy (SideLoaded a deps) -> Declare (Definitions Schema) NamedSchema