Copyright	(c) Frederick Pringle 2025
License	BSD-3-Clause
Maintainer	frederick.pringle@fpringle.com
Safe Haskell	None
Language	Haskell2010

Servant.API.Routes.Request

Description

Term-level representation of the request bodies that Servant endpoints expect.

Synopsis

data Request
unRequest :: Lens' Request (Some TypeRep)
noRequest :: Request
oneRequest :: Typeable a => Request
allOfRequests :: forall (as :: [Type]). AllTypeable as => Request
requests :: Traversal' Request TypeRep

Documentation

data Request Source #

A representation of the request body(s) that a Servant endpoint expects.

Under the hood, Request is a Some TypeRep. This allows for the possibility that an endpoint might expect the request body to parse as several different types (multiple ReqBody's).

Note that this type doesn't include any information about the headers that an endpoint expects, since those are independent of the request body.

Instances

Instances details

ToJSON Request Source #
Instance details Defined in Servant.API.Routes.Internal.Request Methods toJSON :: Request -> Value # toEncoding :: Request -> Encoding # toJSONList :: [Request] -> Value # toEncodingList :: [Request] -> Encoding # omitField :: Request -> Bool #
Monoid Request Source #
Instance details Defined in Servant.API.Routes.Internal.Request Methods mempty :: Request # mappend :: Request -> Request -> Request # mconcat :: [Request] -> Request #
Semigroup Request Source #
Instance details Defined in Servant.API.Routes.Internal.Request Methods (<>) :: Request -> Request -> Request # sconcat :: NonEmpty Request -> Request # stimes :: Integral b => b -> Request -> Request #
Show Request Source #
Instance details Defined in Servant.API.Routes.Internal.Request Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #
Eq Request Source #
Instance details Defined in Servant.API.Routes.Internal.Request Methods (==) :: Request -> Request -> Bool # (/=) :: Request -> Request -> Bool #

unRequest :: Lens' Request (Some TypeRep) Source #

noRequest :: Request Source #

The endpoint doesn't expect a request body.

oneRequest :: Typeable a => Request Source #

The request body can only be of one type. Equivalent to a single ReqBody _ a.

allOfRequests :: forall (as :: [Type]). AllTypeable as => Request Source #

The endpoint expects the request body to be parsed as multiple (>1) types. Equivalent to multiple ReqBodys chained with :>.

requests :: Traversal' Request TypeRep Source #

Convenience optic to traverse over all the TypeReps within a Request.