Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Servant.API.Verbs
Synopsis
- type Delete = Verb 'DELETE 200
- type DeleteAccepted = Verb 'DELETE 202
- type DeleteNoContent = NoContentVerb 'DELETE
- type DeleteNonAuthoritative = Verb 'DELETE 203
- type Get = Verb 'GET 200
- type GetAccepted = Verb 'GET 202
- type GetNoContent = NoContentVerb 'GET
- type GetNonAuthoritative = Verb 'GET 203
- type GetPartialContent = Verb 'GET 206
- type GetResetContent = Verb 'GET 205
- data NoContentVerb (method :: k1)
- type Patch = Verb 'PATCH 200
- type PatchAccepted = Verb 'PATCH 202
- type PatchNoContent = NoContentVerb 'PATCH
- type PatchNonAuthoritative = Verb 'PATCH 203
- type Post = Verb 'POST 200
- type PostAccepted = Verb 'POST 202
- type PostCreated = Verb 'POST 201
- type PostNoContent = NoContentVerb 'POST
- type PostNonAuthoritative = Verb 'POST 203
- type PostResetContent = Verb 'POST 205
- type Put = Verb 'PUT 200
- type PutAccepted = Verb 'PUT 202
- type PutCreated = Verb 'PUT 201
- type PutNoContent = NoContentVerb 'PUT
- type PutNonAuthoritative = Verb 'PUT 203
- class ReflectMethod a where
- reflectMethod :: Proxy a -> Method
- data Verb (method :: k1) (statusCode :: Nat) (contentTypes :: [*]) (a :: *)
- type HeadNoContent = NoContentVerb 'HEAD
- type DeleteResetContent = Verb 'DELETE 205
- type PatchResetContent = Verb 'PATCH 205
- type PutResetContent = Verb 'PUT 205
- data StdMethod
Documentation
type DeleteAccepted = Verb 'DELETE 202 #
DELETE
with 202 status code.
type DeleteNoContent = NoContentVerb 'DELETE #
DELETE
with 204 status code.
type DeleteNonAuthoritative = Verb 'DELETE 203 #
DELETE
with 203 status code.
type GetAccepted = Verb 'GET 202 #
GET
with 202 status code.
type GetNoContent = NoContentVerb 'GET #
GET
with 204 status code.
type GetNonAuthoritative = Verb 'GET 203 #
GET
with 203 status code.
type GetPartialContent = Verb 'GET 206 #
GET
with 206 status code.
type GetResetContent = Verb 'GET 205 #
GET
with 205 status code.
data NoContentVerb (method :: k1) #
NoContentVerb
is a specific type to represent NoContent
responses.
It does not require either a list of content types (because there's
no content) or a status code (because it should always be 204).
Instances
HasLink (NoContentVerb m :: Type) # | |
Defined in Servant.Links Associated Types type MkLink (NoContentVerb m) a # Methods toLink :: (Link -> a) -> Proxy (NoContentVerb m) -> Link -> MkLink (NoContentVerb m) a # | |
Generic (NoContentVerb method) # | |
Defined in Servant.API.Verbs Associated Types type Rep (NoContentVerb method) :: Type -> Type # Methods from :: NoContentVerb method -> Rep (NoContentVerb method) x to :: Rep (NoContentVerb method) x -> NoContentVerb method | |
type MkLink (NoContentVerb m :: Type) r # | |
Defined in Servant.Links | |
type Rep (NoContentVerb method) # | |
Defined in Servant.API.Verbs type Rep (NoContentVerb method) = D1 ('MetaData "NoContentVerb" "Servant.API.Verbs" "servant-0.20.1-2y7DLWEzubY4ToLPQej775" 'False) (V1 :: Type -> Type) |
type PatchAccepted = Verb 'PATCH 202 #
PATCH
with 202 status code.
type PatchNoContent = NoContentVerb 'PATCH #
PATCH
with 204 status code.
type PatchNonAuthoritative = Verb 'PATCH 203 #
PATCH
with 203 status code.
type PostAccepted = Verb 'POST 202 #
POST
with 202 status code.
type PostCreated = Verb 'POST 201 #
POST
with 201 status code.
type PostNoContent = NoContentVerb 'POST #
POST
with 204 status code.
type PostNonAuthoritative = Verb 'POST 203 #
POST
with 203 status code.
type PostResetContent = Verb 'POST 205 #
POST
with 205 status code.
type PutAccepted = Verb 'PUT 202 #
PUT
with 202 status code.
type PutCreated = Verb 'PUT 201 #
PUT
with 201 status code.
type PutNoContent = NoContentVerb 'PUT #
PUT
with 204 status code.
type PutNonAuthoritative = Verb 'PUT 203 #
PUT
with 203 status code.
class ReflectMethod a where #
Methods
reflectMethod :: Proxy a -> Method #
Instances
ReflectMethod 'CONNECT # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'CONNECT -> Method # | |
ReflectMethod 'DELETE # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'DELETE -> Method # | |
ReflectMethod 'GET # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'GET -> Method # | |
ReflectMethod 'HEAD # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'HEAD -> Method # | |
ReflectMethod 'OPTIONS # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'OPTIONS -> Method # | |
ReflectMethod 'PATCH # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'PATCH -> Method # | |
ReflectMethod 'POST # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'POST -> Method # | |
ReflectMethod 'PUT # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'PUT -> Method # | |
ReflectMethod 'TRACE # | |
Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'TRACE -> Method # |
data Verb (method :: k1) (statusCode :: Nat) (contentTypes :: [*]) (a :: *) #
Verb
is a general type for representing HTTP verbs (a.k.a. methods). For
convenience, type synonyms for each verb with a 200 response code are
provided, but you are free to define your own:
>>>
type Post204 contentTypes a = Verb 'POST 204 contentTypes a
Instances
HasLink (Verb m s ct a :: Type) # | |
Generic (Verb method statusCode contentTypes a) # | |
Defined in Servant.API.Verbs | |
AtLeastOneFragment (Verb m s ct typ) # | If fragment appeared in API endpoint twice, compile-time error would be raised.
|
Defined in Servant.API.TypeLevel | |
type MkLink (Verb m s ct a :: Type) r # | |
Defined in Servant.Links | |
type Rep (Verb method statusCode contentTypes a) # | |
Defined in Servant.API.Verbs |
type HeadNoContent = NoContentVerb 'HEAD #
HEAD
with 204 status code.
type DeleteResetContent = Verb 'DELETE 205 #
DELETE
with 205 status code.
type PatchResetContent = Verb 'PATCH 205 #
PATCH
with 205 status code.
type PutResetContent = Verb 'PUT 205 #
PUT
with 205 status code.
HTTP standard method (as defined by RFC 2616, and PATCH which is defined by RFC 5789).