Moduleservant-openapi3-2.1.0.0Haskell2010

Servant.OpenApi.Internal.TypeLevel.API

2 types

Packageservant-openapi3-2.1.0.0
Exports15
LanguageHaskell2010
LicenceBSD-3-Clause
SourceAPI.hs

familytype family EndpointsList api :: [Type] where

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 (NamedRoutes api) = EndpointsList (ToServantApi api)
EndpointsList a = '[a]

familytype family IsSubAPI sub api :: Constraint where

Check whether sub is a sub API of api.

Equations

IsSubAPI sub api = AllIsElem (EndpointsList sub) api

familytype family AllIsElem (xs :: [Type]) api :: Constraint where

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

Equations

AllIsElem '[] api = ()
AllIsElem (x ': xs) api = (IsIn x api, AllIsElem xs api)

familytype family MapSub (e :: k) (xs :: [Type]) :: [Type] where

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

Equations

MapSub e '[] = '[]
MapSub e (x ': xs) = (e :> x) ': MapSub e xs

familytype family AppendList (xs :: [a]) (ys :: [a]) :: [a] where

Append two type-level lists.

Equations

AppendList '[] ys = ys
AppendList (x ': xs) ys = x ': AppendList xs ys

familytype family Or (a :: Constraint) (b :: Constraint) :: Constraint where

Equations

Or () b = ()
Or a () = ()

familytype family IsIn sub api :: Constraint where

Equations

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

familytype family Elem (x :: a) (xs :: [a]) :: Bool where

Check whether a type is a member of a list of types. This is a type-level analogue of elem.

Equations

Elem x '[] = 'False
Elem x (x ': xs) = 'True
Elem x (y ': xs) = Elem x xs

familytype family Nub (xs :: [a]) :: [a] where

Remove duplicates from a type-level list.

Equations

Nub '[] = '[]
Nub (x ': xs) = x ': Nub (Remove x xs)

familytype family Remove (x :: a) (xs :: [a]) :: [a] where

Remove element from a type-level list.

Equations

Remove x '[] = '[]
Remove x (x ': ys) = Remove x ys
Remove x (y ': ys) = y ': Remove x ys

typetype BodyTypes c api = Nub (BodyTypes' c api)

Extract a list of unique "body" types for a specific content-type from a servant API.

typetype AddBodyType (c :: a1) (cs :: [a1]) (a2 :: a) (as :: [a]) = If (Elem c cs) (a2 ': as) as

AddBodyType c cs a as adds type a to the list as only if c is in cs.

familytype family BodyTypes' c api :: [Type] where

Extract a list of "body" types for a specific content-type from a servant API. To extract unique types see BodyTypes.

NoContent is removed from the list and not tested. (This allows for leaving the body completely empty on responses to requests that only accept 'application/json', while setting the content-type in the response accordingly.)

Equations

BodyTypes' c (Verb verb b cs (Headers hdrs a)) = AddBodyType c cs a '[]
BodyTypes' c (Verb verb b cs NoContent) = '[]
BodyTypes' c (Verb verb b cs a) = AddBodyType c cs a '[]
BodyTypes' c (MultiVerb verb cs as _1) = AddBodyType c cs () (MultiVerbResponseBodies as)
BodyTypes' c (ReqBody' mods cs a :> api) = AddBodyType c cs a (BodyTypes' c api)
BodyTypes' c (e :> api) = BodyTypes' c api
BodyTypes' c (a :<|> b) = AppendList (BodyTypes' c a) (BodyTypes' c b)
BodyTypes' c (NamedRoutes api) = BodyTypes' c (ToServantApi api)
BodyTypes' c api = '[]

familytype family MultiVerbResponseBody a

The ResponseTypes class allows to extract all types involved in a response, whether or not this type is in the body of the response, or, for example, in a header.

This is problematic because, if the response contains a header (e.g. `Header "Set-Cookie" SetCookie`), then the header type also needs instances for `To/FromJSON` and Arbitrary for testing purposes, even though this isn't needed in practice.

We want to extract only the body, for which there is no built-in functionality at this time.

See Servant.API.MultiVerb.ResponseTypes for an example of how this mechanism can be implemented

Instances5MultiVerbResponseBody

type MultiVerbResponseBody (GenericAsConstructor r) = MultiVerbResponseBody rDefined in servant-openapi3-2.1.0.0 · Servant.OpenApi.Internal.TypeLevel.API
type MultiVerbResponseBody (Respond s description a) = aDefined in servant-openapi3-2.1.0.0 · Servant.OpenApi.Internal.TypeLevel.API
type MultiVerbResponseBody (RespondAs contentType s description a) = aDefined in servant-openapi3-2.1.0.0 · Servant.OpenApi.Internal.TypeLevel.API
type MultiVerbResponseBody (RespondStreaming s description framing contentType) = SourceIO ByteStringDefined in servant-openapi3-2.1.0.0 · Servant.OpenApi.Internal.TypeLevel.API
type MultiVerbResponseBody (WithHeaders headers returnType response) = MultiVerbResponseBody responseDefined in servant-openapi3-2.1.0.0 · Servant.OpenApi.Internal.TypeLevel.API

familytype family MultiVerbResponseBodies (as :: [Type]) :: [Type] where

Equations

MultiVerbResponseBodies '[] = '[]
MultiVerbResponseBodies (a ': as) = MultiVerbResponseBody a ': MultiVerbResponseBodies as