openapi-petstore-0.1.0.0: Auto-generated openapi-petstore API Client
Safe HaskellSafe-Inferred
LanguageHaskell2010

OpenAPIPetstore.API.Pet

Description

 
Synopsis

Operations

Pet

addPet

addPet Source #

Arguments

:: (Consumes AddPet contentType, MimeRender contentType Pet) 
=> ContentType contentType

request content-type (MimeType)

-> Pet

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

-> OpenAPIPetstoreRequest AddPet contentType NoContent MimeNoContent 
POST /pet

Add a new pet to the store

AuthMethod: AuthOAuthPetstoreAuth

data AddPet Source #

Instances

Instances details
HasBodyParam AddPet Pet Source #

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

Instance details

Defined in OpenAPIPetstore.API.Pet

Methods

setBodyParam :: (Consumes AddPet contentType, MimeRender contentType Pet) => OpenAPIPetstoreRequest AddPet contentType res accept -> Pet -> OpenAPIPetstoreRequest AddPet contentType res accept Source #

Consumes AddPet MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.Pet

Consumes AddPet MimeXML Source #
application/xml
Instance details

Defined in OpenAPIPetstore.API.Pet

Produces AddPet MimeNoContent Source # 
Instance details

Defined in OpenAPIPetstore.API.Pet

deletePet

deletePet Source #

Arguments

:: PetId

"petId" - Pet id to delete

-> OpenAPIPetstoreRequest DeletePet MimeNoContent NoContent MimeNoContent 
DELETE /pet/{petId}

Deletes a pet

AuthMethod: AuthOAuthPetstoreAuth

data DeletePet Source #

Instances

Instances details
HasOptionalParam DeletePet ApiKey Source # 
Instance details

Defined in OpenAPIPetstore.API.Pet

Methods

applyOptionalParam :: OpenAPIPetstoreRequest DeletePet contentType res accept -> ApiKey -> OpenAPIPetstoreRequest DeletePet contentType res accept Source #

(-&-) :: OpenAPIPetstoreRequest DeletePet contentType res accept -> ApiKey -> OpenAPIPetstoreRequest DeletePet contentType res accept Source #

Produces DeletePet MimeNoContent Source # 
Instance details

Defined in OpenAPIPetstore.API.Pet

findPetsByStatus

findPetsByStatus Source #

Arguments

:: Accept accept

request accept (MimeType)

-> Status

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

-> OpenAPIPetstoreRequest FindPetsByStatus MimeNoContent [Pet] accept 
GET /pet/findByStatus

Finds Pets by status

Multiple status values can be provided with comma separated strings

AuthMethod: AuthOAuthPetstoreAuth

data FindPetsByStatus Source #

Instances

Instances details
Produces FindPetsByStatus MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.Pet

Produces FindPetsByStatus MimeXML Source #
application/xml
Instance details

Defined in OpenAPIPetstore.API.Pet

findPetsByTags

findPetsByTags Source #

Arguments

:: Accept accept

request accept (MimeType)

-> Tags

"tags" - Tags to filter by

-> OpenAPIPetstoreRequest FindPetsByTags MimeNoContent [Pet] accept 

Deprecated: 

GET /pet/findByTags

Finds Pets by tags

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

AuthMethod: AuthOAuthPetstoreAuth

data FindPetsByTags Source #

Instances

Instances details
Produces FindPetsByTags MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.Pet

Produces FindPetsByTags MimeXML Source #
application/xml
Instance details

Defined in OpenAPIPetstore.API.Pet

getPetById

getPetById Source #

Arguments

:: Accept accept

request accept (MimeType)

-> PetId

"petId" - ID of pet to return

-> OpenAPIPetstoreRequest GetPetById MimeNoContent Pet accept 
GET /pet/{petId}

Find pet by ID

Returns a single pet

AuthMethod: AuthApiKeyApiKey

data GetPetById Source #

Instances

Instances details
Produces GetPetById MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.Pet

Produces GetPetById MimeXML Source #
application/xml
Instance details

Defined in OpenAPIPetstore.API.Pet

updatePet

updatePet Source #

Arguments

:: (Consumes UpdatePet contentType, MimeRender contentType Pet) 
=> ContentType contentType

request content-type (MimeType)

-> Pet

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

-> OpenAPIPetstoreRequest UpdatePet contentType NoContent MimeNoContent 
PUT /pet

Update an existing pet

AuthMethod: AuthOAuthPetstoreAuth

data UpdatePet Source #

Instances

Instances details
HasBodyParam UpdatePet Pet Source #

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

Instance details

Defined in OpenAPIPetstore.API.Pet

Methods

setBodyParam :: (Consumes UpdatePet contentType, MimeRender contentType Pet) => OpenAPIPetstoreRequest UpdatePet contentType res accept -> Pet -> OpenAPIPetstoreRequest UpdatePet contentType res accept Source #

Consumes UpdatePet MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.Pet

Consumes UpdatePet MimeXML Source #
application/xml
Instance details

Defined in OpenAPIPetstore.API.Pet

Produces UpdatePet MimeNoContent Source # 
Instance details

Defined in OpenAPIPetstore.API.Pet

updatePetWithForm

updatePetWithForm Source #

Arguments

:: Consumes UpdatePetWithForm MimeFormUrlEncoded 
=> PetId

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

-> OpenAPIPetstoreRequest UpdatePetWithForm MimeFormUrlEncoded NoContent MimeNoContent 
POST /pet/{petId}

Updates a pet in the store with form data

AuthMethod: AuthOAuthPetstoreAuth

data UpdatePetWithForm Source #

Instances

Instances details
HasOptionalParam UpdatePetWithForm Name2 Source #

Optional Param "name" - Updated name of the pet

Instance details

Defined in OpenAPIPetstore.API.Pet

Methods

applyOptionalParam :: OpenAPIPetstoreRequest UpdatePetWithForm contentType res accept -> Name2 -> OpenAPIPetstoreRequest UpdatePetWithForm contentType res accept Source #

(-&-) :: OpenAPIPetstoreRequest UpdatePetWithForm contentType res accept -> Name2 -> OpenAPIPetstoreRequest UpdatePetWithForm contentType res accept Source #

HasOptionalParam UpdatePetWithForm StatusText Source #

Optional Param "status" - Updated status of the pet

Instance details

Defined in OpenAPIPetstore.API.Pet

Methods

applyOptionalParam :: OpenAPIPetstoreRequest UpdatePetWithForm contentType res accept -> StatusText -> OpenAPIPetstoreRequest UpdatePetWithForm contentType res accept Source #

(-&-) :: OpenAPIPetstoreRequest UpdatePetWithForm contentType res accept -> StatusText -> OpenAPIPetstoreRequest UpdatePetWithForm contentType res accept Source #

Consumes UpdatePetWithForm MimeFormUrlEncoded Source #
application/x-www-form-urlencoded
Instance details

Defined in OpenAPIPetstore.API.Pet

Produces UpdatePetWithForm MimeNoContent Source # 
Instance details

Defined in OpenAPIPetstore.API.Pet

uploadFile

uploadFile Source #

Arguments

:: Consumes UploadFile MimeMultipartFormData 
=> PetId

"petId" - ID of pet to update

-> OpenAPIPetstoreRequest UploadFile MimeMultipartFormData ApiResponse MimeJSON 
POST /pet/{petId}/uploadImage

uploads an image

AuthMethod: AuthOAuthPetstoreAuth

data UploadFile Source #

Instances

Instances details
HasOptionalParam UploadFile AdditionalMetadata Source #

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

Instance details

Defined in OpenAPIPetstore.API.Pet

Methods

applyOptionalParam :: OpenAPIPetstoreRequest UploadFile contentType res accept -> AdditionalMetadata -> OpenAPIPetstoreRequest UploadFile contentType res accept Source #

(-&-) :: OpenAPIPetstoreRequest UploadFile contentType res accept -> AdditionalMetadata -> OpenAPIPetstoreRequest UploadFile contentType res accept Source #

HasOptionalParam UploadFile File2 Source #

Optional Param "file" - file to upload

Instance details

Defined in OpenAPIPetstore.API.Pet

Methods

applyOptionalParam :: OpenAPIPetstoreRequest UploadFile contentType res accept -> File2 -> OpenAPIPetstoreRequest UploadFile contentType res accept Source #

(-&-) :: OpenAPIPetstoreRequest UploadFile contentType res accept -> File2 -> OpenAPIPetstoreRequest UploadFile contentType res accept Source #

Consumes UploadFile MimeMultipartFormData Source #
multipart/form-data
Instance details

Defined in OpenAPIPetstore.API.Pet

Produces UploadFile MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.Pet

uploadFileWithRequiredFile

uploadFileWithRequiredFile Source #

Arguments

:: Consumes UploadFileWithRequiredFile MimeMultipartFormData 
=> RequiredFile

"requiredFile" - file to upload

-> PetId

"petId" - ID of pet to update

-> OpenAPIPetstoreRequest UploadFileWithRequiredFile MimeMultipartFormData ApiResponse MimeJSON 
POST /fake/{petId}/uploadImageWithRequiredFile

uploads an image (required)

AuthMethod: AuthOAuthPetstoreAuth

data UploadFileWithRequiredFile Source #

Instances

Instances details
HasOptionalParam UploadFileWithRequiredFile AdditionalMetadata Source #

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

Instance details

Defined in OpenAPIPetstore.API.Pet

Methods

applyOptionalParam :: OpenAPIPetstoreRequest UploadFileWithRequiredFile contentType res accept -> AdditionalMetadata -> OpenAPIPetstoreRequest UploadFileWithRequiredFile contentType res accept Source #

(-&-) :: OpenAPIPetstoreRequest UploadFileWithRequiredFile contentType res accept -> AdditionalMetadata -> OpenAPIPetstoreRequest UploadFileWithRequiredFile contentType res accept Source #

Consumes UploadFileWithRequiredFile MimeMultipartFormData Source #
multipart/form-data
Instance details

Defined in OpenAPIPetstore.API.Pet

Produces UploadFileWithRequiredFile MimeJSON Source #
application/json
Instance details

Defined in OpenAPIPetstore.API.Pet