req package:servant-foreign

data Req ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Full description of an endpoint in your API, generated by listFromAPI. It should give you all the information needed to generate foreign language bindings. Every field containing ftype will use the foreign type mapping specified via HasForeignType (see its docstring on how to set that up). See https://docs.servant.dev/en/stable/tutorial/ApiType.html for accessible documentation of the possible content of an endpoint.
Req :: Url ftype -> Method -> [HeaderArg ftype] -> Maybe ftype -> Maybe ftype -> FunctionName -> ReqBodyContentType -> Req ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
reqBody :: forall ftype_af8H . Lens' (Req ftype_af8H) (Maybe ftype_af8H)
servant-foreign Servant.Foreign Servant.Foreign.Internal
reqBodyContentType :: forall ftype_af8H . Lens' (Req ftype_af8H) ReqBodyContentType
servant-foreign Servant.Foreign Servant.Foreign.Internal
reqFuncName :: forall ftype_af8H . Lens' (Req ftype_af8H) FunctionName
servant-foreign Servant.Foreign Servant.Foreign.Internal
reqHeaders :: forall ftype_af8H . Lens' (Req ftype_af8H) [HeaderArg ftype_af8H]
servant-foreign Servant.Foreign Servant.Foreign.Internal
reqMethod :: forall ftype_af8H . Lens' (Req ftype_af8H) Method
servant-foreign Servant.Foreign Servant.Foreign.Internal
reqReturnType :: forall ftype_af8H . Lens' (Req ftype_af8H) (Maybe ftype_af8H)
servant-foreign Servant.Foreign Servant.Foreign.Internal
reqUrl :: forall ftype_af8H . Lens' (Req ftype_af8H) (Url ftype_af8H)
servant-foreign Servant.Foreign Servant.Foreign.Internal
data ReqBodyContentType
servant-foreign Servant.Foreign Servant.Foreign.Internal
See documentation of _reqBodyContentType
ReqBodyJSON :: ReqBodyContentType
servant-foreign Servant.Foreign Servant.Foreign.Internal
ReqBodyMultipart :: ReqBodyContentType
servant-foreign Servant.Foreign Servant.Foreign.Internal
_reqBody :: Req ftype -> Maybe ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Foreign type of the expected request body (ReqBody), if any
_reqBodyContentType :: Req ftype -> ReqBodyContentType
servant-foreign Servant.Foreign Servant.Foreign.Internal
The content type the request body is transferred as. This is a severe limitation of servant-foreign currently, as we only allow the content type to be JSON no user-defined content types. (ReqBodyMultipart is not actually implemented.) Thus, any routes looking like this will work: 
"foo" :> Get '[JSON] Foo
while routes like 
"foo" :> Get '[MyFancyContentType] Foo
will fail with an error like 
• JSON expected in list '[MyFancyContentType]
_reqFuncName :: Req ftype -> FunctionName
servant-foreign Servant.Foreign Servant.Foreign.Internal
The URL segments rendered in a way that they can be easily concatenated into a canonical function name
_reqHeaders :: Req ftype -> [HeaderArg ftype]
servant-foreign Servant.Foreign Servant.Foreign.Internal
Headers required by this endpoint, with their type
_reqMethod :: Req ftype -> Method
servant-foreign Servant.Foreign Servant.Foreign.Internal
"GET"/"POST"/"PUT"/…
_reqReturnType :: Req ftype -> Maybe ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
The foreign type of the response, if any
_reqUrl :: Req ftype -> Url ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Full list of URL segments, including captures
defReq :: Req ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal