Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.SwaggerServant

Description

Servant combinators related to Swagger docs

Synopsis

data OmitDocs

Documentation

data OmitDocs Source #

A type-level tag that lets us omit any branch from Swagger docs.

FUTUREWORK(fisx): this is currently only used for the spar internal api and spar scim, and we should probably eliminate those uses and this combinator. it's only justification is laziness.

Instances

Instances details

RoutesToPaths api => RoutesToPaths (OmitDocs :> api :: Type) Source #
Instance details Defined in Wire.API.SwaggerServant Methods getRoutes :: Forest PathSegment Source #
HasOpenApi (OmitDocs :> a :: Type) Source #
Instance details Defined in Wire.API.SwaggerServant Methods toOpenApi :: Proxy (OmitDocs :> a) -> OpenApi Source #
HasServer api ctx => HasServer (OmitDocs :> api :: Type) ctx Source #
Instance details Defined in Wire.API.SwaggerServant Associated Types type ServerT (OmitDocs :> api) m Source # Methods route :: Proxy (OmitDocs :> api) -> Context ctx -> Delayed env (Server (OmitDocs :> api)) -> Router env Source # hoistServerWithContext :: Proxy (OmitDocs :> api) -> Proxy ctx -> (forall x. m x -> n x) -> ServerT (OmitDocs :> api) m -> ServerT (OmitDocs :> api) n Source #
type ServerT (OmitDocs :> api :: Type) m Source #
Instance details Defined in Wire.API.SwaggerServant type ServerT (OmitDocs :> api :: Type) m = ServerT api m