
== Paths
=== __PUT__ `/pets` Update an existing pet
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|400


<.<|Invalid ID supplied


<.<|No Links



<.<|404


<.<|Pet not found


<.<|No Links



<.<|405


<.<|Validation exception


<.<|No Links



|===
[%header,caption=,cols=".^3a,.^4a,.^13a"]
|===
<.<|Type


<.<|Name


<.<|Scopes



<.<|**oauth2**


<.<|petstore_auth


<.<|write_pets, read_pets



|===

=== __POST__ `/pets` Add a new pet to the store
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|405


<.<|Invalid input


<.<|No Links



|===
[%header,caption=,cols=".^3a,.^4a,.^13a"]
|===
<.<|Type


<.<|Name


<.<|Scopes



<.<|**oauth2**


<.<|petstore_auth


<.<|write_pets, read_pets



|===

=== __GET__ `/pets/findByStatus` Finds Pets by status
Multiple status values can be provided with comma seperated strings

.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**query**


<.<|**status** +
__optional__


<.<|Status values that need to be considered for filter


<.<|< string > array



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|200


<.<|successful operation

.Headers
[%header,caption=,cols=".^2a,.^14a,.^4a"]
!===
<.<!Name

<.<!Description

<.<!Schema

<.<!X-Rate-Limit-Limit

<.<!The number of allowed requests in the current period

<.<!integer

<.<!X-Rate-Limit-Remaining

<.<!The number of remaining requests in the current period

<.<!integer

<.<!X-Rate-Limit-Reset

<.<!The number of seconds left in the current period

<.<!integer

!===
.Content
application/json::
application/xml::


<.<|No Links



<.<|400


<.<|Invalid status value


<.<|No Links



|===
[%header,caption=,cols=".^3a,.^4a,.^13a"]
|===
<.<|Type


<.<|Name


<.<|Scopes



<.<|**oauth2**


<.<|petstore_auth


<.<|write_pets, read_pets



|===

=== __GET__ `/pets/findByTags` Finds Pets by tags
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.

.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**query**


<.<|**tags** +
__optional__


<.<|Tags to filter by


<.<|< string > array



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|200


<.<|successful operation

.Headers
[%header,caption=,cols=".^2a,.^14a,.^4a"]
!===
<.<!Name

<.<!Description

<.<!Schema

<.<!X-Rate-Limit-Limit

<.<!The number of allowed requests in the current period

<.<!integer

<.<!X-Rate-Limit-Remaining

<.<!The number of remaining requests in the current period

<.<!integer

<.<!X-Rate-Limit-Reset

<.<!The number of seconds left in the current period

<.<!integer

!===
.Content
application/json::
application/xml::


<.<|No Links



<.<|400


<.<|Invalid tag value


<.<|No Links



|===
[%header,caption=,cols=".^3a,.^4a,.^13a"]
|===
<.<|Type


<.<|Name


<.<|Scopes



<.<|**oauth2**


<.<|petstore_auth


<.<|write_pets, read_pets



|===

=== __GET__ `/pets/{petId}` Find pet by ID
Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions

.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**path**


<.<|**petId** +
__required__


<.<|ID of pet that needs to be fetched


<.<|integer (int64)



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|200


<.<|successful operation

.Headers
[%header,caption=,cols=".^2a,.^14a,.^4a"]
!===
<.<!Name

<.<!Description

<.<!Schema

<.<!X-Rate-Limit-Limit

<.<!The number of allowed requests in the current period

<.<!integer

<.<!X-Rate-Limit-Remaining

<.<!The number of remaining requests in the current period

<.<!integer

<.<!X-Rate-Limit-Reset

<.<!The number of seconds left in the current period

<.<!integer

!===
.Content
application/json::
application/xml::


<.<|No Links



<.<|400


<.<|Invalid ID supplied


<.<|No Links



<.<|404


<.<|Pet not found


<.<|No Links



|===
[%header,caption=,cols=".^3a,.^4a,.^13a"]
|===
<.<|Type


<.<|Name


<.<|Scopes



<.<|**apiKey**


<.<|api_key


<.<|

<.<|**oauth2**


<.<|petstore_auth


<.<|write_pets, read_pets



|===

=== __POST__ `/pets/{petId}` Updates a pet in the store with form data
.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**path**


<.<|**petId** +
__required__


<.<|ID of pet that needs to be updated


<.<|string



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|405


<.<|Invalid input


<.<|No Links



|===
[%header,caption=,cols=".^3a,.^4a,.^13a"]
|===
<.<|Type


<.<|Name


<.<|Scopes



<.<|**oauth2**


<.<|petstore_auth


<.<|write_pets, read_pets



|===

=== __DELETE__ `/pets/{petId}` Deletes a pet
.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**path**


<.<|**petId** +
__required__


<.<|Pet id to delete


<.<|integer (int64)



<.<|**header**


<.<|**api_key** +
__required__


<.<|
<.<|string



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|400


<.<|Invalid pet value


<.<|No Links



|===
[%header,caption=,cols=".^3a,.^4a,.^13a"]
|===
<.<|Type


<.<|Name


<.<|Scopes



<.<|**oauth2**


<.<|petstore_auth


<.<|write_pets, read_pets



|===

=== __POST__ `/stores/order` Place an order for a pet
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|200


<.<|successful operation

.Headers
[%header,caption=,cols=".^2a,.^14a,.^4a"]
!===
<.<!Name

<.<!Description

<.<!Schema

<.<!X-Rate-Limit-Limit

<.<!The number of allowed requests in the current period

<.<!integer

<.<!X-Rate-Limit-Remaining

<.<!The number of remaining requests in the current period

<.<!integer

<.<!X-Rate-Limit-Reset

<.<!The number of seconds left in the current period

<.<!integer

!===
.Content
application/json::
application/xml::


<.<|No Links



<.<|400


<.<|Invalid Order


<.<|No Links



|===

=== __GET__ `/stores/order/{orderId}` Find purchase order by ID
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions

.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**path**


<.<|**orderId** +
__required__


<.<|ID of pet that needs to be fetched


<.<|string



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|200


<.<|successful operation

.Headers
[%header,caption=,cols=".^2a,.^14a,.^4a"]
!===
<.<!Name

<.<!Description

<.<!Schema

<.<!X-Rate-Limit-Limit

<.<!The number of allowed requests in the current period

<.<!integer

<.<!X-Rate-Limit-Remaining

<.<!The number of remaining requests in the current period

<.<!integer

<.<!X-Rate-Limit-Reset

<.<!The number of seconds left in the current period

<.<!integer

!===
.Content
application/json::
application/xml::


<.<|No Links



<.<|400


<.<|Invalid ID supplied


<.<|No Links



<.<|404


<.<|Order not found


<.<|No Links



|===

=== __DELETE__ `/stores/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

.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**path**


<.<|**orderId** +
__required__


<.<|ID of the order that needs to be deleted


<.<|string



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|400


<.<|Invalid ID supplied


<.<|No Links



<.<|404


<.<|Order not found


<.<|No Links



|===

=== __POST__ `/users` Create user
This can only be done by the logged in user.

.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|default


<.<|successful operation


<.<|No Links



|===

=== __POST__ `/users/createWithArray` Creates list of users with given input array
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|default


<.<|successful operation


<.<|No Links



|===

=== __POST__ `/users/createWithList` Creates list of users with given input array
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|default


<.<|successful operation


<.<|No Links



|===

=== __GET__ `/users/login` Logs user into the system
.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**query**


<.<|**password** +
__optional__


<.<|The password for login in clear text


<.<|string



<.<|**query**


<.<|**username** +
__optional__


<.<|The user name for login


<.<|string



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|200


<.<|successful operation

.Headers
[%header,caption=,cols=".^2a,.^14a,.^4a"]
!===
<.<!Name

<.<!Description

<.<!Schema

<.<!X-Rate-Limit-Limit

<.<!The number of allowed requests in the current period

<.<!integer

<.<!X-Rate-Limit-Remaining

<.<!The number of remaining requests in the current period

<.<!integer

<.<!X-Rate-Limit-Reset

<.<!The number of seconds left in the current period

<.<!integer

!===
.Content
application/json::
application/xml::


<.<|No Links



<.<|400


<.<|Invalid username/password supplied


<.<|No Links



|===

=== __GET__ `/users/logout` Logs out current logged in user session
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|default


<.<|successful operation


<.<|No Links



|===

=== __GET__ `/users/{username}` Get user by user name
.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**path**


<.<|**username** +
__required__


<.<|The name that needs to be fetched. Use user1 for testing.


<.<|string



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|200


<.<|successful operation

.Headers
[%header,caption=,cols=".^2a,.^14a,.^4a"]
!===
<.<!Name

<.<!Description

<.<!Schema

<.<!X-Rate-Limit-Limit

<.<!The number of allowed requests in the current period

<.<!integer

<.<!X-Rate-Limit-Remaining

<.<!The number of remaining requests in the current period

<.<!integer

<.<!X-Rate-Limit-Reset

<.<!The number of seconds left in the current period

<.<!integer

!===
.Content
application/json::
application/xml::


<.<|No Links



<.<|400


<.<|Invalid username supplied


<.<|No Links



<.<|404


<.<|User not found


<.<|No Links



|===

=== __PUT__ `/users/{username}` Updated user
This can only be done by the logged in user.

.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**path**


<.<|**username** +
__required__


<.<|name that need to be deleted


<.<|string



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|400


<.<|Invalid user supplied


<.<|No Links



<.<|404


<.<|User not found


<.<|No Links



|===

=== __DELETE__ `/users/{username}` Delete user
This can only be done by the logged in user.

.Parameters
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|===
<.<|Type


<.<|Name


<.<|Description


<.<|Schema



<.<|**path**


<.<|**username** +
__required__


<.<|The name that needs to be deleted


<.<|string



|===
.Responses
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|===
<.<|Code


<.<|Description


<.<|Links



<.<|400


<.<|Invalid username supplied


<.<|No Links



<.<|404


<.<|User not found


<.<|No Links



|===

