Servant.Swagger.Internal

Documentation

class HasSwagger api where

Methods

toSwagger :: Proxy api -> Swagger

Instances

HasSwagger * Raw

(HasSwagger * a, HasSwagger * b) => HasSwagger * ((:<|>) a b)

AllAccept [*] cs => HasSwagger * (Get cs ())

(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Get cs (Headers hs a))

(ToSchema a, AllAccept [*] cs) => HasSwagger * (Get cs a)

AllAccept [*] cs => HasSwagger * (Post cs ())

(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Post cs (Headers hs a))

(ToSchema a, AllAccept [*] cs) => HasSwagger * (Post cs a)

AllAccept [*] cs => HasSwagger * (Delete cs ())

(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Delete cs (Headers hs a))

(ToSchema a, AllAccept [*] cs) => HasSwagger * (Delete cs a)

AllAccept [*] cs => HasSwagger * (Put cs ())

(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Put cs (Headers hs a))

(ToSchema a, AllAccept [*] cs) => HasSwagger * (Put cs a)

AllAccept [*] cs => HasSwagger * (Patch cs ())

(ToSchema a, AllAccept [*] cs, AllToResponseHeader [*] hs) => HasSwagger * (Patch cs (Headers hs a))

(ToSchema a, AllAccept [*] cs) => HasSwagger * (Patch cs a)

(ToSchema a, AllAccept [*] cs, HasSwagger k sub) => HasSwagger * ((:>) * k (ReqBody * cs a) sub)

(KnownSymbol sym, ToParamSchema a, HasSwagger k sub) => HasSwagger * ((:>) * k (Header sym a) sub)

(KnownSymbol sym, HasSwagger k sub) => HasSwagger * ((:>) * k (QueryFlag sym) sub)

(KnownSymbol sym, ToParamSchema a, HasSwagger k sub) => HasSwagger * ((:>) * k (QueryParams * sym a) sub)

(KnownSymbol sym, ToParamSchema a, HasSwagger k sub) => HasSwagger * ((:>) * k (QueryParam * sym a) sub)

(KnownSymbol sym, ToParamSchema a, HasSwagger k sub) => HasSwagger * ((:>) * k (Capture * sym a) sub)

(KnownSymbol sym, HasSwagger k sub) => HasSwagger * ((:>) Symbol k sym sub)

subOperations :: forall sub api. (IsSubAPI sub api, HasSwagger sub) => Proxy sub -> Proxy api -> Traversal' Swagger Operation

All operations of sub API.

addTag :: TagName -> Operation -> Operation

Tag an operation.

setResponse :: HttpStatusCode -> Response -> Operation -> Operation

Set a response for an operation.

(</>) :: FilePath -> FilePath -> FilePath

mkEndpoint :: forall a cs hs proxy _verb. (ToSchema a, AllAccept cs, AllToResponseHeader hs) => FilePath -> Lens' PathItem (Maybe Operation) -> HttpStatusCode -> proxy (_verb cs (Headers hs a)) -> Swagger

noContentEndpoint :: forall cs proxy verb. AllAccept cs => FilePath -> Lens' PathItem (Maybe Operation) -> proxy (verb cs ()) -> Swagger

mkEndpointWithSchemaRef :: forall cs hs proxy verb a. (AllAccept cs, AllToResponseHeader hs) => Maybe (Referenced Schema) -> FilePath -> Lens' PathItem (Maybe Operation) -> HttpStatusCode -> proxy (verb cs (Headers hs a)) -> Swagger

prependPath :: FilePath -> Swagger -> Swagger

Prepend path to all API endpoints.

addParam :: Param -> Swagger -> Swagger

Add parameter to every operation in the spec.

addConsumes :: [MediaType] -> Swagger -> Swagger

Add accepted content types to every operation in the spec.

addResponseWith :: (Response -> Response -> Response) -> HttpStatusCode -> Response -> Swagger -> Swagger

Add/modify response for every operation in the spec.

addResponse :: HttpStatusCode -> Response -> Swagger -> Swagger

Add/overwrite response for every operation in the spec.

addDefaultResponse404 :: ParamName -> Swagger -> Swagger

addDefaultResponse400 :: ParamName -> Swagger -> Swagger

class AllAccept cs where

Methods

allContentType :: Proxy cs -> [MediaType]

Instances

AllAccept [k] ([] k)

(Accept k c, AllAccept [k] cs) => AllAccept [k] ((:) k c cs)

class ToResponseHeader h where

Methods

toResponseHeader :: Proxy h -> (HeaderName, Header)

Instances

(KnownSymbol sym, ToParamSchema a) => ToResponseHeader * (Header sym a)

class AllToResponseHeader hs where

Methods

toAllResponseHeaders :: Proxy hs -> HashMap HeaderName Header

Instances

AllToResponseHeader [*] hs => AllToResponseHeader * (HList hs)

AllToResponseHeader [k] ([] k)

(ToResponseHeader k h, AllToResponseHeader [k] hs) => AllToResponseHeader [k] ((:) k h hs)

type family AllIsElem xs api :: Constraint

Check that every element of xs is an endpoint of api.

Equations

AllIsElem `[]` api = ()

AllIsElem (x : xs) api = (IsIn x api, AllIsElem xs api)

type family MapSub e xs

Apply (e :>) to every API in xs.

Equations

MapSub e `[]` = `[]`

MapSub e (x : xs) = (e :> x) : MapSub e xs

type family AppendList xs ys

Append two type-level lists.

Equations

AppendList `[]` ys = ys

AppendList (x : xs) ys = x : AppendList xs ys

type family EndpointsList api

Build a list of endpoints from an API.

Equations

EndpointsList (a :<|> b) = AppendList (EndpointsList a) (EndpointsList b)

EndpointsList (e :> a) = MapSub e (EndpointsList a)

EndpointsList a = `[a]`

type family IsSubAPI sub api :: Constraint

Check whether sub is a sub API of api.

Equations

IsSubAPI sub api = AllIsElem (EndpointsList sub) api

type family Or a b :: Constraint

Equations

Or () b = ()

Or a () = ()

type family IsIn sub api :: Constraint

Equations

IsIn e (a :<|> b) = Or (IsIn e a) (IsIn e b)

IsIn (e :> a) (e :> b) = IsIn a b

IsIn e e = ()