SwaggerPetstore.API

Operations

Pet

addPet

addPet

Arguments

:: (Consumes AddPet contentType, MimeRender contentType Pet)

=> contentType

request content-type (MimeType)

-> Pet

"body" - Pet object that needs to be added to the store

-> SwaggerPetstoreRequest AddPet contentType res

POST /pet

Add a new pet to the store

AuthMethod: petstore_auth

Note: Has Produces instances, but no response schema

data AddPet

Instances

Produces AddPet MimeXML

application/xml

Produces AddPet MimeJSON

application/json

Consumes AddPet MimeXML

application/xml

Consumes AddPet MimeJSON

application/json

HasBodyParam AddPet Pet

Body Param "body" - Pet object that needs to be added to the store

Methods

setBodyParam :: (Consumes AddPet contentType, MimeRender contentType Pet) => SwaggerPetstoreRequest AddPet contentType res -> Pet -> SwaggerPetstoreRequest AddPet contentType res

deletePet

deletePet

Arguments

:: Integer

"petId" - Pet id to delete

-> SwaggerPetstoreRequest DeletePet MimeNoContent res

DELETE /pet/{petId}

Deletes a pet

AuthMethod: petstore_auth

Note: Has Produces instances, but no response schema

data DeletePet

Instances

Produces DeletePet MimeXML

application/xml

Produces DeletePet MimeJSON

application/json

HasOptionalParam DeletePet ApiUnderscorekey

Methods

applyOptionalParam :: SwaggerPetstoreRequest DeletePet contentType res -> ApiUnderscorekey -> SwaggerPetstoreRequest DeletePet contentType res

(-&-) :: SwaggerPetstoreRequest DeletePet contentType res -> ApiUnderscorekey -> SwaggerPetstoreRequest DeletePet contentType res

findPetsByStatus

findPetsByStatus

Arguments

:: [Text]

"status" - Status values that need to be considered for filter

-> SwaggerPetstoreRequest FindPetsByStatus MimeNoContent [Pet]

GET /pet/findByStatus

Finds Pets by status

Multiple status values can be provided with comma separated strings

AuthMethod: petstore_auth

data FindPetsByStatus

Instances

Produces FindPetsByStatus MimeXML

application/xml

Produces FindPetsByStatus MimeJSON

application/json

findPetsByTags

findPetsByTags

Arguments

:: [Text]

"tags" - Tags to filter by

-> SwaggerPetstoreRequest FindPetsByTags MimeNoContent [Pet]

Deprecated:

GET /pet/findByTags

Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

AuthMethod: petstore_auth

data FindPetsByTags

Instances

Produces FindPetsByTags MimeXML

application/xml

Produces FindPetsByTags MimeJSON

application/json

getPetById

getPetById

Arguments

:: Integer

"petId" - ID of pet to return

-> SwaggerPetstoreRequest GetPetById MimeNoContent Pet

GET /pet/{petId}

Find pet by ID

Returns a single pet

AuthMethod: api_key

data GetPetById

Instances

Produces GetPetById MimeXML

application/xml

Produces GetPetById MimeJSON

application/json

updatePet

updatePet

Arguments

:: (Consumes UpdatePet contentType, MimeRender contentType Pet)

=> contentType

request content-type (MimeType)

-> Pet

"body" - Pet object that needs to be added to the store

-> SwaggerPetstoreRequest UpdatePet contentType res

PUT /pet

Update an existing pet

AuthMethod: petstore_auth

Note: Has Produces instances, but no response schema

data UpdatePet

Instances

Produces UpdatePet MimeXML

application/xml

Produces UpdatePet MimeJSON

application/json

Consumes UpdatePet MimeXML

application/xml

Consumes UpdatePet MimeJSON

application/json

HasBodyParam UpdatePet Pet

Body Param "body" - Pet object that needs to be added to the store

Methods

setBodyParam :: (Consumes UpdatePet contentType, MimeRender contentType Pet) => SwaggerPetstoreRequest UpdatePet contentType res -> Pet -> SwaggerPetstoreRequest UpdatePet contentType res

updatePetWithForm

updatePetWithForm

Arguments

:: Consumes UpdatePetWithForm contentType

=> contentType

request content-type (MimeType)

-> Integer

"petId" - ID of pet that needs to be updated

-> SwaggerPetstoreRequest UpdatePetWithForm contentType res

POST /pet/{petId}

Updates a pet in the store with form data

AuthMethod: petstore_auth

Note: Has Produces instances, but no response schema

data UpdatePetWithForm

Instances

Produces UpdatePetWithForm MimeXML

application/xml

Produces UpdatePetWithForm MimeJSON

application/json

Consumes UpdatePetWithForm MimeFormUrlEncoded

application/x-www-form-urlencoded

HasOptionalParam UpdatePetWithForm Status

Optional Param "status" - Updated status of the pet

Methods

applyOptionalParam :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Status -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

(-&-) :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Status -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

HasOptionalParam UpdatePetWithForm Name

Optional Param "name" - Updated name of the pet

Methods

applyOptionalParam :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Name -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

(-&-) :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Name -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

uploadFile

uploadFile

Arguments

:: Consumes UploadFile contentType

=> contentType

request content-type (MimeType)

-> Integer

"petId" - ID of pet to update

-> SwaggerPetstoreRequest UploadFile contentType ApiResponse

POST /pet/{petId}/uploadImage

uploads an image

AuthMethod: petstore_auth

data UploadFile

Instances

Produces UploadFile MimeJSON

application/json

Consumes UploadFile MimeMultipartFormData

multipart/form-data

HasOptionalParam UploadFile File

Optional Param "file" - file to upload

Methods

applyOptionalParam :: SwaggerPetstoreRequest UploadFile contentType res -> File -> SwaggerPetstoreRequest UploadFile contentType res

(-&-) :: SwaggerPetstoreRequest UploadFile contentType res -> File -> SwaggerPetstoreRequest UploadFile contentType res

HasOptionalParam UploadFile AdditionalMetadata

Optional Param "additionalMetadata" - Additional data to pass to server

Methods

applyOptionalParam :: SwaggerPetstoreRequest UploadFile contentType res -> AdditionalMetadata -> SwaggerPetstoreRequest UploadFile contentType res

(-&-) :: SwaggerPetstoreRequest UploadFile contentType res -> AdditionalMetadata -> SwaggerPetstoreRequest UploadFile contentType res

Store

deleteOrder

deleteOrder

Arguments

:: Text

"orderId" - ID of the order that needs to be deleted

-> SwaggerPetstoreRequest DeleteOrder MimeNoContent res

DELETE /store/order/{orderId}

Delete purchase order by ID

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

Note: Has Produces instances, but no response schema

data DeleteOrder

Instances

Produces DeleteOrder MimeXML

application/xml

Produces DeleteOrder MimeJSON

application/json

getInventory

getInventory :: SwaggerPetstoreRequest GetInventory MimeNoContent (Map String Int)

GET /store/inventory

Returns pet inventories by status

Returns a map of status codes to quantities

AuthMethod: api_key

data GetInventory

Instances

Produces GetInventory MimeJSON

application/json

getOrderById

getOrderById

Arguments

:: Integer

"orderId" - ID of pet that needs to be fetched

-> SwaggerPetstoreRequest GetOrderById MimeNoContent Order

GET /store/order/{orderId}

Find purchase order by ID

For valid response try integer IDs with value 5 or 10. Other values will generated exceptions

data GetOrderById

Instances

Produces GetOrderById MimeXML

application/xml

Produces GetOrderById MimeJSON

application/json

placeOrder

placeOrder

Arguments

:: (Consumes PlaceOrder contentType, MimeRender contentType Order)

=> contentType

request content-type (MimeType)

-> Order

"body" - order placed for purchasing the pet

-> SwaggerPetstoreRequest PlaceOrder contentType Order

POST /store/order

Place an order for a pet

data PlaceOrder

Instances

Produces PlaceOrder MimeXML

application/xml

Produces PlaceOrder MimeJSON

application/json

HasBodyParam PlaceOrder Order

Body Param "body" - order placed for purchasing the pet

Methods

setBodyParam :: (Consumes PlaceOrder contentType, MimeRender contentType Order) => SwaggerPetstoreRequest PlaceOrder contentType res -> Order -> SwaggerPetstoreRequest PlaceOrder contentType res

User

createUser

createUser

Arguments

:: (Consumes CreateUser contentType, MimeRender contentType User)

=> contentType

request content-type (MimeType)

-> User

"body" - Created user object

-> SwaggerPetstoreRequest CreateUser contentType res

POST /user

Create user

This can only be done by the logged in user.

Note: Has Produces instances, but no response schema

data CreateUser

Instances

Produces CreateUser MimeXML

application/xml

Produces CreateUser MimeJSON

application/json

HasBodyParam CreateUser User

Body Param "body" - Created user object

Methods

setBodyParam :: (Consumes CreateUser contentType, MimeRender contentType User) => SwaggerPetstoreRequest CreateUser contentType res -> User -> SwaggerPetstoreRequest CreateUser contentType res

createUsersWithArrayInput

createUsersWithArrayInput

Arguments

:: (Consumes CreateUsersWithArrayInput contentType, MimeRender contentType [User])

=> contentType

request content-type (MimeType)

-> [User]

"body" - List of user object

-> SwaggerPetstoreRequest CreateUsersWithArrayInput contentType res

POST /user/createWithArray

Creates list of users with given input array

Note: Has Produces instances, but no response schema

data CreateUsersWithArrayInput

Instances

Produces CreateUsersWithArrayInput MimeXML

application/xml

Produces CreateUsersWithArrayInput MimeJSON

application/json

HasBodyParam CreateUsersWithArrayInput [User]

Body Param "body" - List of user object

Methods

setBodyParam :: (Consumes CreateUsersWithArrayInput contentType, MimeRender contentType [User]) => SwaggerPetstoreRequest CreateUsersWithArrayInput contentType res -> [User] -> SwaggerPetstoreRequest CreateUsersWithArrayInput contentType res

createUsersWithListInput

createUsersWithListInput

Arguments

:: (Consumes CreateUsersWithListInput contentType, MimeRender contentType [User])

=> contentType

request content-type (MimeType)

-> [User]

"body" - List of user object

-> SwaggerPetstoreRequest CreateUsersWithListInput contentType res

POST /user/createWithList

Creates list of users with given input array

Note: Has Produces instances, but no response schema

data CreateUsersWithListInput

Instances

Produces CreateUsersWithListInput MimeXML

application/xml

Produces CreateUsersWithListInput MimeJSON

application/json

HasBodyParam CreateUsersWithListInput [User]

Body Param "body" - List of user object

Methods

setBodyParam :: (Consumes CreateUsersWithListInput contentType, MimeRender contentType [User]) => SwaggerPetstoreRequest CreateUsersWithListInput contentType res -> [User] -> SwaggerPetstoreRequest CreateUsersWithListInput contentType res

deleteUser

deleteUser

Arguments

:: Text

"username" - The name that needs to be deleted

-> SwaggerPetstoreRequest DeleteUser MimeNoContent res

DELETE /user/{username}

Delete user

This can only be done by the logged in user.

Note: Has Produces instances, but no response schema

data DeleteUser

Instances

Produces DeleteUser MimeXML

application/xml

Produces DeleteUser MimeJSON

application/json

getUserByName

getUserByName

Arguments

:: Text

"username" - The name that needs to be fetched. Use user1 for testing.

-> SwaggerPetstoreRequest GetUserByName MimeNoContent User

GET /user/{username}

Get user by user name

data GetUserByName

Instances

Produces GetUserByName MimeXML

application/xml

Produces GetUserByName MimeJSON

application/json

loginUser

loginUser

Arguments

:: Text

"username" - The user name for login

-> Text

"password" - The password for login in clear text

-> SwaggerPetstoreRequest LoginUser MimeNoContent Text

GET /user/login

Logs user into the system

data LoginUser

Instances

Produces LoginUser MimeXML

application/xml

Produces LoginUser MimeJSON

application/json

logoutUser

logoutUser :: SwaggerPetstoreRequest LogoutUser MimeNoContent res

GET /user/logout

Logs out current logged in user session

Note: Has Produces instances, but no response schema

data LogoutUser

Instances

Produces LogoutUser MimeXML

application/xml

Produces LogoutUser MimeJSON

application/json

updateUser

updateUser

Arguments

:: (Consumes UpdateUser contentType, MimeRender contentType User)

=> contentType

request content-type (MimeType)

-> Text

"username" - name that need to be deleted

-> User

"body" - Updated user object

-> SwaggerPetstoreRequest UpdateUser contentType res

PUT /user/{username}

Updated user

This can only be done by the logged in user.

Note: Has Produces instances, but no response schema

data UpdateUser

Instances

Produces UpdateUser MimeXML

application/xml

Produces UpdateUser MimeJSON

application/json

HasBodyParam UpdateUser User

Body Param "body" - Updated user object

Methods

setBodyParam :: (Consumes UpdateUser contentType, MimeRender contentType User) => SwaggerPetstoreRequest UpdateUser contentType res -> User -> SwaggerPetstoreRequest UpdateUser contentType res

HasBodyParam

class HasBodyParam req param where

Designates the body parameter of a request

Methods

setBodyParam :: forall contentType res. (Consumes req contentType, MimeRender contentType param) => SwaggerPetstoreRequest req contentType res -> param -> SwaggerPetstoreRequest req contentType res

Instances

HasBodyParam UpdateUser User

Body Param "body" - Updated user object

Methods

setBodyParam :: (Consumes UpdateUser contentType, MimeRender contentType User) => SwaggerPetstoreRequest UpdateUser contentType res -> User -> SwaggerPetstoreRequest UpdateUser contentType res

HasBodyParam CreateUser User

Body Param "body" - Created user object

Methods

setBodyParam :: (Consumes CreateUser contentType, MimeRender contentType User) => SwaggerPetstoreRequest CreateUser contentType res -> User -> SwaggerPetstoreRequest CreateUser contentType res

HasBodyParam PlaceOrder Order

Body Param "body" - order placed for purchasing the pet

Methods

setBodyParam :: (Consumes PlaceOrder contentType, MimeRender contentType Order) => SwaggerPetstoreRequest PlaceOrder contentType res -> Order -> SwaggerPetstoreRequest PlaceOrder contentType res

HasBodyParam UpdatePet Pet

Body Param "body" - Pet object that needs to be added to the store

Methods

setBodyParam :: (Consumes UpdatePet contentType, MimeRender contentType Pet) => SwaggerPetstoreRequest UpdatePet contentType res -> Pet -> SwaggerPetstoreRequest UpdatePet contentType res

HasBodyParam AddPet Pet

Body Param "body" - Pet object that needs to be added to the store

Methods

setBodyParam :: (Consumes AddPet contentType, MimeRender contentType Pet) => SwaggerPetstoreRequest AddPet contentType res -> Pet -> SwaggerPetstoreRequest AddPet contentType res

HasBodyParam CreateUsersWithListInput [User]

Body Param "body" - List of user object

Methods

setBodyParam :: (Consumes CreateUsersWithListInput contentType, MimeRender contentType [User]) => SwaggerPetstoreRequest CreateUsersWithListInput contentType res -> [User] -> SwaggerPetstoreRequest CreateUsersWithListInput contentType res

HasBodyParam CreateUsersWithArrayInput [User]

Body Param "body" - List of user object

Methods

setBodyParam :: (Consumes CreateUsersWithArrayInput contentType, MimeRender contentType [User]) => SwaggerPetstoreRequest CreateUsersWithArrayInput contentType res -> [User] -> SwaggerPetstoreRequest CreateUsersWithArrayInput contentType res

HasOptionalParam

class HasOptionalParam req param where

Designates the optional parameters of a request

Minimal complete definition

applyOptionalParam | (-&-)

Methods

applyOptionalParam :: SwaggerPetstoreRequest req contentType res -> param -> SwaggerPetstoreRequest req contentType res

Apply an optional parameter to a request

(-&-) :: SwaggerPetstoreRequest req contentType res -> param -> SwaggerPetstoreRequest req contentType res infixl 2

infix operator / alias for addOptionalParam

Instances

HasOptionalParam UploadFile File

Optional Param "file" - file to upload

Methods

applyOptionalParam :: SwaggerPetstoreRequest UploadFile contentType res -> File -> SwaggerPetstoreRequest UploadFile contentType res

(-&-) :: SwaggerPetstoreRequest UploadFile contentType res -> File -> SwaggerPetstoreRequest UploadFile contentType res

HasOptionalParam UploadFile AdditionalMetadata

Optional Param "additionalMetadata" - Additional data to pass to server

Methods

applyOptionalParam :: SwaggerPetstoreRequest UploadFile contentType res -> AdditionalMetadata -> SwaggerPetstoreRequest UploadFile contentType res

(-&-) :: SwaggerPetstoreRequest UploadFile contentType res -> AdditionalMetadata -> SwaggerPetstoreRequest UploadFile contentType res

HasOptionalParam UpdatePetWithForm Status

Optional Param "status" - Updated status of the pet

Methods

applyOptionalParam :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Status -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

(-&-) :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Status -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

HasOptionalParam UpdatePetWithForm Name

Optional Param "name" - Updated name of the pet

Methods

applyOptionalParam :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Name -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

(-&-) :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Name -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

HasOptionalParam DeletePet ApiUnderscorekey

Methods

applyOptionalParam :: SwaggerPetstoreRequest DeletePet contentType res -> ApiUnderscorekey -> SwaggerPetstoreRequest DeletePet contentType res

(-&-) :: SwaggerPetstoreRequest DeletePet contentType res -> ApiUnderscorekey -> SwaggerPetstoreRequest DeletePet contentType res

Optional Request Parameter Types

newtype ApiUnderscorekey

Constructors

ApiUnderscorekey

Fields

• unApiUnderscorekey :: Text

Instances

Eq ApiUnderscorekey

Methods

(==) :: ApiUnderscorekey -> ApiUnderscorekey -> Bool

(/=) :: ApiUnderscorekey -> ApiUnderscorekey -> Bool

Show ApiUnderscorekey

Methods

showsPrec :: Int -> ApiUnderscorekey -> ShowS

show :: ApiUnderscorekey -> String

showList :: [ApiUnderscorekey] -> ShowS

HasOptionalParam DeletePet ApiUnderscorekey

Methods

applyOptionalParam :: SwaggerPetstoreRequest DeletePet contentType res -> ApiUnderscorekey -> SwaggerPetstoreRequest DeletePet contentType res

(-&-) :: SwaggerPetstoreRequest DeletePet contentType res -> ApiUnderscorekey -> SwaggerPetstoreRequest DeletePet contentType res

newtype Name

Constructors

Name

Fields

• unName :: Text

Instances

Eq Name

Methods

(==) :: Name -> Name -> Bool

(/=) :: Name -> Name -> Bool

Show Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

HasOptionalParam UpdatePetWithForm Name

Optional Param "name" - Updated name of the pet

Methods

applyOptionalParam :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Name -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

(-&-) :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Name -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

newtype Status

Constructors

Status

Fields

• unStatus :: Text

Instances

Eq Status

Methods

(==) :: Status -> Status -> Bool

(/=) :: Status -> Status -> Bool

Show Status

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

HasOptionalParam UpdatePetWithForm Status

Optional Param "status" - Updated status of the pet

Methods

applyOptionalParam :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Status -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

(-&-) :: SwaggerPetstoreRequest UpdatePetWithForm contentType res -> Status -> SwaggerPetstoreRequest UpdatePetWithForm contentType res

newtype AdditionalMetadata

Constructors

AdditionalMetadata

Fields

• unAdditionalMetadata :: Text

Instances

Eq AdditionalMetadata

Methods

(==) :: AdditionalMetadata -> AdditionalMetadata -> Bool

(/=) :: AdditionalMetadata -> AdditionalMetadata -> Bool

Show AdditionalMetadata

Methods

showsPrec :: Int -> AdditionalMetadata -> ShowS

show :: AdditionalMetadata -> String

showList :: [AdditionalMetadata] -> ShowS

HasOptionalParam UploadFile AdditionalMetadata

Optional Param "additionalMetadata" - Additional data to pass to server

Methods

applyOptionalParam :: SwaggerPetstoreRequest UploadFile contentType res -> AdditionalMetadata -> SwaggerPetstoreRequest UploadFile contentType res

(-&-) :: SwaggerPetstoreRequest UploadFile contentType res -> AdditionalMetadata -> SwaggerPetstoreRequest UploadFile contentType res

newtype File

Constructors

File

Fields

• unFile :: FilePath

Instances

Eq File

Methods

(==) :: File -> File -> Bool

(/=) :: File -> File -> Bool

Show File

Methods

showsPrec :: Int -> File -> ShowS

show :: File -> String

showList :: [File] -> ShowS

HasOptionalParam UploadFile File

Optional Param "file" - file to upload

Methods

applyOptionalParam :: SwaggerPetstoreRequest UploadFile contentType res -> File -> SwaggerPetstoreRequest UploadFile contentType res

(-&-) :: SwaggerPetstoreRequest UploadFile contentType res -> File -> SwaggerPetstoreRequest UploadFile contentType res

SwaggerPetstoreRequest

data SwaggerPetstoreRequest req contentType res

Represents a request. The "req" type variable is the request type. The "res" type variable is the response type.

Constructors

SwaggerPetstoreRequest

Fields

• rMethod :: Method

  Method of SwaggerPetstoreRequest

• urlPath :: [ByteString]

  Endpoint of SwaggerPetstoreRequest

• params :: Params

  params of SwaggerPetstoreRequest

Instances

Show (SwaggerPetstoreRequest req contentType res)

Methods

showsPrec :: Int -> SwaggerPetstoreRequest req contentType res -> ShowS

show :: SwaggerPetstoreRequest req contentType res -> String

showList :: [SwaggerPetstoreRequest req contentType res] -> ShowS

data Params

Request Params

Constructors

Params

Fields

• paramsQuery :: Query
• paramsHeaders :: RequestHeaders
• paramsBody :: ParamBody

Instances

Show Params

Methods

showsPrec :: Int -> Params -> ShowS

show :: Params -> String

showList :: [Params] -> ShowS

data ParamBody

Request Body

Constructors

ParamBodyNone

ParamBodyB ByteString

ParamBodyBL ByteString

ParamBodyFormUrlEncoded Form

ParamBodyMultipartFormData [Part]

Instances

Show ParamBody

Methods

showsPrec :: Int -> ParamBody -> ShowS

show :: ParamBody -> String

showList :: [ParamBody] -> ShowS

SwaggerPetstoreRequest Utils

_mkRequest

Arguments

:: Method

Method

-> [ByteString]

Endpoint

-> SwaggerPetstoreRequest req contentType res

req: Request Type, res: Response Type

_mkParams :: Params

setHeader :: SwaggerPetstoreRequest req contentType res -> [Header] -> SwaggerPetstoreRequest req contentType res

removeHeader :: SwaggerPetstoreRequest req contentType res -> [HeaderName] -> SwaggerPetstoreRequest req contentType res

_setContentTypeHeader :: forall req contentType res. MimeType contentType => SwaggerPetstoreRequest req contentType res -> SwaggerPetstoreRequest req contentType res

_setAcceptHeader :: forall req contentType res accept. MimeType accept => SwaggerPetstoreRequest req contentType res -> accept -> SwaggerPetstoreRequest req contentType res

_setQuery :: SwaggerPetstoreRequest req contentType res -> [QueryItem] -> SwaggerPetstoreRequest req contentType res

_addForm :: SwaggerPetstoreRequest req contentType res -> Form -> SwaggerPetstoreRequest req contentType res

_addMultiFormPart :: SwaggerPetstoreRequest req contentType res -> Part -> SwaggerPetstoreRequest req contentType res

_setBodyBS :: SwaggerPetstoreRequest req contentType res -> ByteString -> SwaggerPetstoreRequest req contentType res

_setBodyLBS :: SwaggerPetstoreRequest req contentType res -> ByteString -> SwaggerPetstoreRequest req contentType res

Params Utils

toPath :: ToHttpApiData a => a -> ByteString

toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header]

toForm :: ToHttpApiData v => (ByteString, v) -> Form

toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem]

Swagger CollectionFormat Utils

data CollectionFormat

Determines the format of the array if type array is used.

Constructors

CommaSeparated

CSV format for multiple parameters.

SpaceSeparated

Also called SSV

TabSeparated

Also called TSV

PipeSeparated

`value1|value2|value2`

MultiParamArray

Using multiple GET parameters, e.g. `foo=bar&foo=baz`. This is valid only for parameters in "query" (Query) or "formData" (Form)

toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header]

toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form

toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query

_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)]

_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)]

_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)]