Servant.Util.Combinators.ErrorResponses

Documentation

data ErrorDesc

Type-level information about an error response.

Constructors

ErrorDesc

Fields

• erCode :: Nat
• erException :: Type
• erDesc :: Symbol

data ErrorPartialDesc

Like ErrorDesc, but without exception type yet.

Constructors

ErrorPartialDesc

Fields

• epdCode :: Nat
• epdDesc :: Symbol

data ErrorResponses (errs :: [ErrorDesc])

This combinator adds description of error response to swagger specification.

You have two ways to define this combinator:

• General:

ErrorResponses
   '[ 404 #! MyBackendException $
        "Not found"
    , 403 #! Int $
        "Operation is not permitted"
    ]

• When only one exception type is used:

ExceptionalResponses MyBackendException
   '[ 404 #: "Not found"
    , 403 #: "Operation is not permitted"
    ]

Note that if an error code was already defined further in endpoint definition, it will be overwriten. For instance, Captures define 400 error code (invalid format); but in endpoint like ErrorResponses (400 ...) :> Capture ... :> ... description for 400-error case provided by Capture will be overwritten.

This combinator is transparent for server implementation.

Instances

HasClient m subApi => HasClient m (ErrorResponses errors :> subApi)

Defined in Servant.Util.Combinators.ErrorResponses

Associated Types

type Client m (ErrorResponses errors :> subApi)

Methods

clientWithRoute :: Proxy m -> Proxy (ErrorResponses errors :> subApi) -> Request -> Client m (ErrorResponses errors :> subApi)

hoistClientMonad :: Proxy m -> Proxy (ErrorResponses errors :> subApi) -> (forall x. mon x -> mon' x) -> Client mon (ErrorResponses errors :> subApi) -> Client mon' (ErrorResponses errors :> subApi)

HasLoggingServer config subApi ctx => HasLoggingServer (config :: Type) (ErrorResponses errors :> subApi :: Type) ctx

Defined in Servant.Util.Combinators.ErrorResponses

Methods

routeWithLog :: Proxy (LoggingApiRec config (ErrorResponses errors :> subApi)) -> Context ctx -> Delayed env (Server (LoggingApiRec config (ErrorResponses errors :> subApi))) -> Router env

(HasSwagger subApi, KnownErrorCodes errors) => HasSwagger (ErrorResponses errors :> subApi :: Type)

Defined in Servant.Util.Combinators.ErrorResponses

Methods

toSwagger :: Proxy (ErrorResponses errors :> subApi) -> Swagger

HasServer subApi ctx => HasServer (ErrorResponses errors :> subApi :: Type) ctx

Defined in Servant.Util.Combinators.ErrorResponses

Associated Types

type ServerT (ErrorResponses errors :> subApi) m

Methods

route :: Proxy (ErrorResponses errors :> subApi) -> Context ctx -> Delayed env (Server (ErrorResponses errors :> subApi)) -> Router env

hoistServerWithContext :: Proxy (ErrorResponses errors :> subApi) -> Proxy ctx -> (forall x. m x -> n x) -> ServerT (ErrorResponses errors :> subApi) m -> ServerT (ErrorResponses errors :> subApi) n

type Client m (ErrorResponses errors :> subApi)

Defined in Servant.Util.Combinators.ErrorResponses

type Client m (ErrorResponses errors :> subApi) = Client m subApi

type ServerT (ErrorResponses errors :> subApi :: Type) m

Defined in Servant.Util.Combinators.ErrorResponses

type ServerT (ErrorResponses errors :> subApi :: Type) m = ServerT subApi m

type (#:) = 'ErrorPartialDesc

A convenient alias for use with ExceptionalResponse.

type ($) (f :: k1 -> k) (a :: k1) = f a infixr 2

Infix application.

f :: Either String $ Maybe Int
=
f :: Either String (Maybe Int)

type ExceptionalResponses err codes = ErrorResponses $ ExceptionDesc err codes

An alias for ErrorResponse which allows to mention an exception type just once across all errors specification.