servant-0.20.2: A family of combinators for defining webservices APIs

Safe Haskell | Safe-Inferred
Language | Haskell2010

Servant.API.Verbs

Synopsis

- type Get = Verb 'GET 200
- type Put = Verb 'PUT 200
- type Delete = Verb 'DELETE 200
- type DeleteAccepted = Verb 'DELETE 202
- type DeleteNoContent = NoContentVerb 'DELETE
- type DeleteNonAuthoritative = Verb 'DELETE 203
- 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 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 :: [Type]) (a :: Type)
- type HeadNoContent = NoContentVerb 'HEAD
- type DeleteResetContent = Verb 'DELETE 205
- type PatchResetContent = Verb 'PATCH 205
- type PutResetContent = Verb 'PUT 205
- data StdMethod
  - = GET
  - | POST
  - | HEAD
  - | PUT
  - | DELETE
  - | TRACE
  - | CONNECT
  - | OPTIONS
  - | PATCH

# Documentation

type Get = Verb 'GET 200 Source #

`GET` with 200 status code.

type Put = Verb 'PUT 200 Source #

`PUT` with 200 status code.

type Delete = Verb 'DELETE 200 Source #

`DELETE` with 200 status code.

type DeleteAccepted = Verb 'DELETE 202 Source #

`DELETE` with 202 status code.

type DeleteNoContent = NoContentVerb 'DELETE Source #

`DELETE` with 204 status code.

type DeleteNonAuthoritative = Verb 'DELETE 203 Source #

`DELETE` with 203 status code.

type GetAccepted = Verb 'GET 202 Source #

`GET` with 202 status code.

type GetNoContent = NoContentVerb 'GET Source #

`GET` with 204 status code.

type GetNonAuthoritative = Verb 'GET 203 Source #

`GET` with 203 status code.

type GetPartialContent = Verb 'GET 206 Source #

`GET` with 206 status code.

type GetResetContent = Verb 'GET 205 Source #

`GET` with 205 status code.

data NoContentVerb (method :: k1) Source #

`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

Instances details

HasLink (NoContentVerb m :: Type) Source # |
Instance details Defined in Servant.Links Associated Types type MkLink (NoContentVerb m) a Source # Methods toLink :: (Link -> a) -> Proxy (NoContentVerb m) -> Link -> MkLink (NoContentVerb m) a Source #
Generic (NoContentVerb method) Source # |
Instance details Defined in Servant.API.Verbs Associated Types type Rep (NoContentVerb method) :: Type -> Type Source # Methods from :: NoContentVerb method -> Rep (NoContentVerb method) x Source # to :: Rep (NoContentVerb method) x -> NoContentVerb method Source #
type MkLink (NoContentVerb m :: Type) r Source # |
Instance details Defined in Servant.Links type MkLink (NoContentVerb m :: Type) r = r
type Rep (NoContentVerb method) Source # |
Instance details Defined in Servant.API.Verbs type Rep (NoContentVerb method) = D1 ('MetaData "NoContentVerb" "Servant.API.Verbs" "servant-0.20.2-9qMeCokkESCIo3VIgNYzee" 'False) (V1 :: Type -> Type)

type Patch = Verb 'PATCH 200 Source #

`PATCH` with 200 status code.

type PatchAccepted = Verb 'PATCH 202 Source #

`PATCH` with 202 status code.

type PatchNoContent = NoContentVerb 'PATCH Source #

`PATCH` with 204 status code.

type PatchNonAuthoritative = Verb 'PATCH 203 Source #

`PATCH` with 203 status code.

type Post = Verb 'POST 200 Source #

`POST` with 200 status code.

type PostAccepted = Verb 'POST 202 Source #

`POST` with 202 status code.

type PostCreated = Verb 'POST 201 Source #

`POST` with 201 status code.

type PostNoContent = NoContentVerb 'POST Source #

`POST` with 204 status code.

type PostNonAuthoritative = Verb 'POST 203 Source #

`POST` with 203 status code.

type PostResetContent = Verb 'POST 205 Source #

`POST` with 205 status code.

type PutAccepted = Verb 'PUT 202 Source #

`PUT` with 202 status code.

type PutCreated = Verb 'PUT 201 Source #

`PUT` with 201 status code.

type PutNoContent = NoContentVerb 'PUT Source #

`PUT` with 204 status code.

type PutNonAuthoritative = Verb 'PUT 203 Source #

`PUT` with 203 status code.

class ReflectMethod a where Source #

Methods

reflectMethod :: Proxy a -> Method Source #

#### Instances

Instances details

ReflectMethod 'CONNECT Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'CONNECT -> Method Source #
ReflectMethod 'DELETE Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'DELETE -> Method Source #
ReflectMethod 'GET Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'GET -> Method Source #
ReflectMethod 'HEAD Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'HEAD -> Method Source #
ReflectMethod 'OPTIONS Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'OPTIONS -> Method Source #
ReflectMethod 'PATCH Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'PATCH -> Method Source #
ReflectMethod 'POST Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'POST -> Method Source #
ReflectMethod 'PUT Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'PUT -> Method Source #
ReflectMethod 'TRACE Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'TRACE -> Method Source #

data Verb (method :: k1) (statusCode :: Nat) (contentTypes :: [Type]) (a :: Type) Source #

`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

Instances details

HasLink (Verb m s ct a :: Type) Source # |
Instance details Defined in Servant.Links Associated Types type MkLink (Verb m s ct a) a Source # Methods toLink :: (Link -> a0) -> Proxy (Verb m s ct a) -> Link -> MkLink (Verb m s ct a) a0 Source #
Generic (Verb method statusCode contentTypes a) Source # |
Instance details Defined in Servant.API.Verbs Associated Types type Rep (Verb method statusCode contentTypes a) :: Type -> Type Source # Methods from :: Verb method statusCode contentTypes a -> Rep (Verb method statusCode contentTypes a) x Source # to :: Rep (Verb method statusCode contentTypes a) x -> Verb method statusCode contentTypes a Source #
AtMostOneFragment (Verb m s ct typ) Source # |
Instance details Defined in Servant.API.TypeLevel
type MkLink (Verb m s ct a :: Type) r Source # |
Instance details Defined in Servant.Links type MkLink (Verb m s ct a :: Type) r = r
type Rep (Verb method statusCode contentTypes a) Source # |
Instance details Defined in Servant.API.Verbs type Rep (Verb method statusCode contentTypes a) = D1 ('MetaData "Verb" "Servant.API.Verbs" "servant-0.20.2-9qMeCokkESCIo3VIgNYzee" 'False) (V1 :: Type -> Type)

type HeadNoContent = NoContentVerb 'HEAD Source #

`HEAD` with 204 status code.

type DeleteResetContent = Verb 'DELETE 205 Source #

`DELETE` with 205 status code.

type PatchResetContent = Verb 'PATCH 205 Source #

`PATCH` with 205 status code.

type PutResetContent = Verb 'PUT 205 Source #

`PUT` with 205 status code.

data StdMethod Source #

HTTP standard method (as defined by RFC 2616, and PATCH which is defined by RFC 5789).

Since: http-types-0.2.0

Constructors

GET |
POST |
HEAD |
PUT |
DELETE |
TRACE |
CONNECT |
OPTIONS |
PATCH | Since: http-types-0.8.0

#### Instances

Instances details

Data StdMethod | Since: http-types-0.12.4

Instance details

Defined in Network.HTTP.Types.Method

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StdMethod -> c StdMethod Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StdMethod Source #

toConstr :: StdMethod -> Constr Source #

dataTypeOf :: StdMethod -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StdMethod) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StdMethod) Source #

gmapT :: (forall b. Data b => b -> b) -> StdMethod -> StdMethod Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StdMethod -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StdMethod -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> StdMethod -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StdMethod -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StdMethod -> m StdMethod Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StdMethod -> m StdMethod Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StdMethod -> m StdMethod Source #

Bounded StdMethod |
Instance details Defined in Network.HTTP.Types.Method Methods minBound :: StdMethod Source # maxBound :: StdMethod Source #
Enum StdMethod |

Instance details

Defined in Network.HTTP.Types.Method

Methods

succ :: StdMethod -> StdMethod Source #

pred :: StdMethod -> StdMethod Source #

toEnum :: Int -> StdMethod Source #

fromEnum :: StdMethod -> Int Source #

enumFrom :: StdMethod -> [StdMethod] Source #

enumFromThen :: StdMethod -> StdMethod -> [StdMethod] Source #

enumFromTo :: StdMethod -> StdMethod -> [StdMethod] Source #

enumFromThenTo :: StdMethod -> StdMethod -> StdMethod -> [StdMethod] Source #

Generic StdMethod |
Instance details Defined in Network.HTTP.Types.Method Associated Types type Rep StdMethod :: Type -> Type Source # Methods from :: StdMethod -> Rep StdMethod x Source # to :: Rep StdMethod x -> StdMethod Source #
Ix StdMethod |

Instance details

Defined in Network.HTTP.Types.Method

Methods

range :: (StdMethod, StdMethod) -> [StdMethod] Source #

index :: (StdMethod, StdMethod) -> StdMethod -> Int Source #

unsafeIndex :: (StdMethod, StdMethod) -> StdMethod -> Int Source #

inRange :: (StdMethod, StdMethod) -> StdMethod -> Bool Source #

rangeSize :: (StdMethod, StdMethod) -> Int Source #

unsafeRangeSize :: (StdMethod, StdMethod) -> Int Source #

Read StdMethod |
Instance details Defined in Network.HTTP.Types.Method Methods readsPrec :: Int -> ReadS StdMethod Source # readList :: ReadS [StdMethod] Source # readPrec :: ReadPrec StdMethod Source # readListPrec :: ReadPrec [StdMethod] Source #
Show StdMethod |
Instance details Defined in Network.HTTP.Types.Method Methods showsPrec :: Int -> StdMethod -> ShowS Source # show :: StdMethod -> String Source # showList :: [StdMethod] -> ShowS Source #
Eq StdMethod |
Instance details Defined in Network.HTTP.Types.Method Methods (==) :: StdMethod -> StdMethod -> Bool Source # (/=) :: StdMethod -> StdMethod -> Bool Source #
Ord StdMethod |

Instance details

Defined in Network.HTTP.Types.Method

Methods

compare :: StdMethod -> StdMethod -> Ordering Source #

(<) :: StdMethod -> StdMethod -> Bool Source #

(<=) :: StdMethod -> StdMethod -> Bool Source #

(>) :: StdMethod -> StdMethod -> Bool Source #

(>=) :: StdMethod -> StdMethod -> Bool Source #

max :: StdMethod -> StdMethod -> StdMethod Source #

min :: StdMethod -> StdMethod -> StdMethod Source #

ReflectMethod 'CONNECT Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'CONNECT -> Method Source #
ReflectMethod 'DELETE Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'DELETE -> Method Source #
ReflectMethod 'GET Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'GET -> Method Source #
ReflectMethod 'HEAD Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'HEAD -> Method Source #
ReflectMethod 'OPTIONS Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'OPTIONS -> Method Source #
ReflectMethod 'PATCH Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'PATCH -> Method Source #
ReflectMethod 'POST Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'POST -> Method Source #
ReflectMethod 'PUT Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'PUT -> Method Source #
ReflectMethod 'TRACE Source # |
Instance details Defined in Servant.API.Verbs Methods reflectMethod :: Proxy 'TRACE -> Method Source #
type Rep StdMethod | Since: http-types-0.12.4

Instance details

Defined in Network.HTTP.Types.Method

type Rep StdMethod = D1 ('MetaData "StdMethod" "Network.HTTP.Types.Method" "http-types-0.12.4-IXFrYWN3tuGA537S2GUyUO" 'False) (((C1 ('MetaCons "GET" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "POST" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HEAD" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PUT" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "DELETE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TRACE" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CONNECT" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OPTIONS" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PATCH" 'PrefixI 'False) (U1 :: Type -> Type)))))