Solga.Swagger

Documentation

genSwagger :: RouterSwagger r => Proxy r -> Either (Text, Context) Swagger

Generate a Swagger specification for a given type.

class RouterSwagger r where

A type for which we can generate a Swagger specification.

Methods

genPaths :: Proxy r -> Context -> GenPathsM Paths

genPaths :: RouterSwagger (Rep r ()) => Proxy r -> Context -> GenPathsM Paths

Instances

RouterSwagger Raw

Methods

genPaths :: Proxy * Raw -> Context -> GenPathsM Paths

RouterSwagger RawResponse

Methods

genPaths :: Proxy * RawResponse -> Context -> GenPathsM Paths

RouterSwagger next => RouterSwagger (End next)

Methods

genPaths :: Proxy * (End next) -> Context -> GenPathsM Paths

ToSchema a => RouterSwagger (JSON a)

Methods

genPaths :: Proxy * (JSON a) -> Context -> GenPathsM Paths

RouterSwagger next => RouterSwagger (ExtraHeaders next)

Methods

genPaths :: Proxy * (ExtraHeaders next) -> Context -> GenPathsM Paths

RouterSwagger next => RouterSwagger (NoCache next)

Methods

genPaths :: Proxy * (NoCache next) -> Context -> GenPathsM Paths

RouterSwagger next => RouterSwagger (WithIO next)

Methods

genPaths :: Proxy * (WithIO next) -> Context -> GenPathsM Paths

(KnownSymbol seg, RouterSwagger next) => RouterSwagger (Seg seg next)

Methods

genPaths :: Proxy * (Seg seg next) -> Context -> GenPathsM Paths

(RouterSwagger left, RouterSwagger right) => RouterSwagger ((:<|>) left right)

Methods

genPaths :: Proxy * (left :<|> right) -> Context -> GenPathsM Paths

(KnownSymbol seg, RouterSwagger next, RouterSwagger (OneOfSegs segs next)) => RouterSwagger (OneOfSegs ((:) Symbol seg segs) next)

Methods

genPaths :: Proxy * (OneOfSegs ((Symbol ': seg) segs) next) -> Context -> GenPathsM Paths

RouterSwagger (OneOfSegs ([] Symbol) next)

Methods

genPaths :: Proxy * (OneOfSegs [Symbol] next) -> Context -> GenPathsM Paths

(Typeable * a, ToParamSchema a, RouterSwagger next) => RouterSwagger (Capture a next)

Methods

genPaths :: Proxy * (Capture a next) -> Context -> GenPathsM Paths

(KnownSymbol m, RouterSwagger next) => RouterSwagger (Method m next)

Methods

genPaths :: Proxy * (Method m next) -> Context -> GenPathsM Paths

(ToSchema a, RouterSwagger next) => RouterSwagger (ReqBodyJSON a next)

Methods

genPaths :: Proxy * (ReqBodyJSON a next) -> Context -> GenPathsM Paths

RouterSwagger (ReqBodyMultipart a next)

Methods

genPaths :: Proxy * (ReqBodyMultipart a next) -> Context -> GenPathsM Paths

RouterSwagger r => RouterSwagger (K1 i r p)

Methods

genPaths :: Proxy * (K1 i r p) -> Context -> GenPathsM Paths

(RouterSwagger (left p), RouterSwagger (right p)) => RouterSwagger ((:*:) left right p)

Methods

genPaths :: Proxy * ((left :*: right) p) -> Context -> GenPathsM Paths

RouterSwagger (f p) => RouterSwagger (M1 i c f p)

Methods

genPaths :: Proxy * (M1 i c f p) -> Context -> GenPathsM Paths

Implementation

type GenPathsM = ExceptT (Text, Context) (Declare (Definitions Schema))

type Paths = InsOrdHashMap Text PathItem

data Context

Constructors

Context

Fields

• contextMethod :: Maybe Method

  Any method currently set.

• pathSegments :: DList Text

  The current path.

• operationContext :: Operation

  The current template operation.

• paramScope :: HashMap Text Int

  The parameter names in use.

Instances

Show Context

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

passPaths :: (r ~ f next, RouterSwagger next) => Proxy r -> Context -> GenPathsM Paths

For a Router f next, produce the same paths as next without modification.

noPaths :: Proxy r -> Context -> GenPathsM Paths

Produce no paths.