<
**Version** v1
[**Terms of Service**](http://www.github.com/kongchen/swagger-maven-plugin)
[**Apache 2.0**](http://www.apache.org/licenses/LICENSE-2.0.html)
# Security Definitions
### api_key
<table>
<tr>
<th>type</th>
<th colspan="2">apiKey</th>
</tr>
<tr>
<th>name</th>
<th colspan="2">api_key</th>
</tr>
<tr>
<th>in</th>
<th colspan="2">HEADER</th>
</tr>
</table>
### basicAuth
<table>
<tr>
<th>type</th>
<th colspan="2">basic</th>
</tr>
</table>
### petstore_auth
<table>
<tr>
<th>type</th>
<th colspan="2">oauth2</th>
</tr>
<tr>
<th>authorizationUrl</th>
<th colspan="2">http://swagger.io/api/oauth/dialog</th>
</tr>
<tr>
<th>flow</th>
<th colspan="2">implicit</th>
</tr>
<tr>
<td rowspan="3">scopes</td>
<td>write:pets</td>
<td>modify pets in your account</td>
</tr>
<tr>
<td>read:pets</td>
<td>read your pets</td>
</tr>
<tr>
</tr>
</table>
# APIs
## /
### GET
<a id="testingRootPathResource">testingRootPathResource</a>
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/cookieValueExpectCookieName
### GET
<a id="cookieValueExpectCookieName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>cookieValueName</th>
<td>cookie</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/cookieValueExpectCookieValue
### GET
<a id="cookieValueExpectCookieValue"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>cookieValueValue</th>
<td>cookie</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/cookieValueExpectParameterName
### GET
<a id="cookieValueExpectParameterName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>parameterName</th>
<td>cookie</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/pathVariableExpectParameterName/{parameterName}
### GET
<a id="pathVariableExpectParameterName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>parameterName</th>
<td>path</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/pathVariableExpectVariableName/{parameterName}
### GET
<a id="pathVariableExpectVariableName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>pathVariableName</th>
<td>path</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/pathVariableExpectVariableValue/{parameterName}
### GET
<a id="pathVariableExpectVariableValue"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>pathVariableValue</th>
<td>path</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestHeaderExpectHeaderName
### GET
<a id="requestHeaderExpectHeaderName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>requestHeaderName</th>
<td>header</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestHeaderExpectHeaderValue
### GET
<a id="requestHeaderExpectHeaderValue"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>requestHeaderValue</th>
<td>header</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestHeaderExpectParameterName
### GET
<a id="requestHeaderExpectParameterName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>parameterName</th>
<td>header</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestParamExpectParamName
### GET
<a id="requestParamExpectParamName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>requestParamName</th>
<td>query</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestParamExpectParamValue
### GET
<a id="requestParamExpectParamValue"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>requestParamValue</th>
<td>query</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestParamExpectParameterName
### GET
<a id="requestParamExpectParameterName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>parameterName</th>
<td>query</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestPartExpectParameterName
### GET
<a id="requestPartExpectParameterName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>parameterName</th>
<td>formData</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestPartExpectPartName
### GET
<a id="requestPartExpectPartName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>requestPartName</th>
<td>formData</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /echo/requestPartExpectPartValue
### GET
<a id="requestPartExpectPartValue"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>requestPartValue</th>
<td>formData</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /getWithParam
### GET
<a id="getWithParam"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>optionalParam</th>
<td>query</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>boolean </td>
</tr>
</table>
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /myResourceImpl/list
### GET
<a id="getListOfItems">Get a list of items</a>
This is a contrived example
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[<a href="#/definitions/ListItem">ListItem</a>]|
## /pet
### GET
<a id="get">Returns pet</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/Pet">Pet</a>|
### PUT
<a id="updatePet">Update an existing pet</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
**Content-Type: ** application/json, application/xml
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>Pet object that needs to be added to the store</td>
<td> - </td>
<td>
<a href="#/definitions/Pet">Pet</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/Pet">Pet</a>|
| 400 | Invalid ID supplied | - |
| 404 | Pet not found | - |
| 405 | Validation exception | - |
### POST
<a id="addPet">Add a new pet to the store</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
**Content-Type: ** application/json, application/xml
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>Pet object that needs to be added to the store</td>
<td> - </td>
<td>
<a href="#/definitions/Pet">Pet</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/Pet">Pet</a>|
| 405 | Invalid input | - |
## /pet/findByStatus
### GET
<a id="findPetsByStatus">Finds Pets by status</a>
Multiple status values can be provided with comma seperated strings
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>status</th>
<td>query</td>
<td>yes</td>
<td>Status values that need to be considered for filter</td>
<td> - </td>
<td>Array[string] (multi)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[<a href="#/definitions/Pet">Pet</a>]|
| 400 | Invalid status value | - |
## /pet/findByStatuses
### GET
<a id="findPetsByStatuses">Finds Pets by status</a>
Multiple status values can be provided with multiple query parameters. Example: ?status=sold&status=pending
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>status</th>
<td>query</td>
<td>yes</td>
<td>Status values that need to be considered for filter</td>
<td> - </td>
<td>Array[string] (multi)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Operation successful, and items were found matching the query. Data in response body. | Array[<a href="#/definitions/Pet">Pet</a>]|
| 400 | Invalid status value | - |
## /pet/findByTags
### GET
-deprecated-
<a id="findPetsByTags">Finds Pets by tags</a>
Muliple tags can be provided with comma seperated strings. Use tags=tag1,tag2,tag3 for testing.
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>tags</th>
<td>query</td>
<td>yes</td>
<td>Tags to filter by</td>
<td> - </td>
<td>Array[string] (multi)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[<a href="#/definitions/Pet">Pet</a>]|
| 400 | Invalid tag value | - |
## /pet/petPing
### GET
<a id="petPing">ping the service</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /pet/pets
### GET
<a id="getAllPetsPaginated">Retrieve all pets. Pagination supported</a>
If you wish to paginate the results of this API, supply offset and limit query parameters.
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>limit</th>
<td>query</td>
<td>yes</td>
<td>The pagination limit</td>
<td> - </td>
<td>integer (int32)</td>
</tr>
<tr>
<th>offset</th>
<td>query</td>
<td>yes</td>
<td>The pagination offset</td>
<td> - </td>
<td>integer (int32)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[<a href="#/definitions/Pet">Pet</a>]|
### POST
<a id="addMultiplePets">Add multiple pets to the store</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
**Content-Type: ** application/json, application/xml
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>A list of pet objects that need to be added to the store</td>
<td> - </td>
<td>
Array[<a href="#/definitions/Pet">Pet</a>]
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[<a href="#/definitions/Pet">Pet</a>]|
| 405 | Invalid input | - |
## /pet/test/extensions
### GET
<a id="testingExtensions">testExtensions</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/Pet">Pet</a>|
## /pet/testing
### GET
<a id="testing">testing</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>items</th>
<td>query</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>Array[string] (multi)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | object|
## /pet/testingApiImplicitParams/{path-test-name}
### GET
<a id="testingApiImplicitParams">testingApiImplicitParams</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>header-test-name</th>
<td>header</td>
<td>yes</td>
<td>header-test-value</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>path-test-name</th>
<td>path</td>
<td>yes</td>
<td>path-test-value</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body-test-name</th>
<td>body</td>
<td>yes</td>
<td>body-test-value</td>
<td> - </td>
<td>
<a href="#/definitions/Pet">Pet</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /pet/testingBasicAuth
### GET
<a id="testingBasicAuth">testingBasicAuth</a>
#### Security
* basicAuth
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /pet/testingFormApiImplicitParam
### GET
<a id="testingFormApiImplicitParam">testingFormApiImplicitParam</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>form-test-name</th>
<td>formData</td>
<td>yes</td>
<td>form-test-value</td>
<td> - </td>
<td>Array[string] (multi)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /pet/testingMergedAnnotations
### GET
<a id="testingMergedAnnotations">testingMergedAnnotations</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /pet/testingVendorExtensions
### GET
<a id="testingVendorExtensions">testingVendorExtensions</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
| 401 | Some vendor error description | - |
| 501 | Some vendor error description added using swaggerExtension | - |
## /pet/{petId}
### GET
<a id="getPetById">Find pet by ID</a>
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
#### Security
* api_key
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>petId</th>
<td>path</td>
<td>yes</td>
<td>ID of pet that needs to be fetched</td>
<td> - </td>
<td>integer (int64)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | Pet data found | <a href="#/definitions/Pet">Pet</a>|
| 400 | Invalid ID supplied | - |
| 404 | Pet not found | - |
### POST
<a id="updatePetWithForm">Updates a pet in the store with form data</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
**Content-Type: ** application/x-www-form-urlencoded
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>name</th>
<td>query</td>
<td>yes</td>
<td>Updated name of the pet</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>petId</th>
<td>path</td>
<td>yes</td>
<td>ID of pet that needs to be updated</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>status</th>
<td>query</td>
<td>yes</td>
<td>Updated status of the pet</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/ApiResponse">ApiResponse</a>|
| 405 | Invalid input | - |
### DELETE
<a id="removePet">Deletes a pet</a>
#### Security
* petstore_auth
* write:pets
* read:pets
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>api_key</th>
<td>header</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>petId</th>
<td>path</td>
<td>yes</td>
<td>Pet id to delete</td>
<td> - </td>
<td>integer (int64)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 400 | Invalid pet value | - |
## /store/order
### POST
<a id="placeOrder">Place an order for a pet</a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>order placed for purchasing the pet</td>
<td> - </td>
<td>
<a href="#/definitions/Order">Order</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/Order">Order</a>|
| 400 | Invalid Order | - |
## /store/order/{orderId}
### GET
<a id="getOrderById">Find purchase order by ID</a>
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>orderId</th>
<td>path</td>
<td>yes</td>
<td>ID of pet that needs to be fetched</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/Order">Order</a>|
| 400 | Invalid ID supplied | - |
| 404 | Order not found | - |
### DELETE
<a id="deleteOrder">Delete purchase order by ID</a>
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>orderId</th>
<td>path</td>
<td>yes</td>
<td>ID of the order that needs to be deleted</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 400 | Invalid ID supplied | - |
| 404 | Order not found | - |
## /store/orders/{orderIds}
### GET
<a id="getOrdersById">Find multiple purchase orders by IDs</a>
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>orderIds</th>
<td>path</td>
<td>yes</td>
<td>IDs of pets that needs to be fetched</td>
<td> - </td>
<td>Array[string] (csv)</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | Array[<a href="#/definitions/Order">Order</a>]|
| 400 | Invalid ID supplied | - |
| 404 | Order not found | - |
## /store/ping
### GET
<a id="storePing">ping</a>
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /swaggerless/{petId}
### GET
<a id="getPetByName"></a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>name</th>
<td>path</td>
<td>yes</td>
<td></td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/Pet">Pet</a>|
## /testingEmptyRootPathResource
### GET
<a id="testingEmptyRootPathResource">testingEmptyRootPathResource</a>
#### Request
##### Parameters
#### Response
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
## /user
### POST
<a id="createUser">Create user</a>
This can only be done by the logged in user.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>Created user object</td>
<td> - </td>
<td>
<a href="#/definitions/User">User</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /user/createWithArray
### POST
<a id="createUsersWithArrayInput">Creates list of users with given input array</a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>List of user object</td>
<td> - </td>
<td>
Array[<a href="#/definitions/User">User</a>]
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /user/createWithList
### POST
<a id="createUsersWithListInput">Creates list of users with given input array</a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>List of user object</td>
<td> - </td>
<td>
Array[<a href="#/definitions/User">User</a>]
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /user/login
### GET
<a id="loginUser">Logs user into the system</a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>username</th>
<td>query</td>
<td>yes</td>
<td>The user name for login</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>password</th>
<td>query</td>
<td>yes</td>
<td>The password for login in clear text</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | string|
| 400 | Invalid username/password supplied | - |
## /user/logout
### GET
<a id="logoutUser">Logs out current logged in user session</a>
#### Request
##### Parameters
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| default | successful operation | - |
## /user/{username}
### GET
<a id="getUserByName">Get user by user name</a>
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>username</th>
<td>path</td>
<td>yes</td>
<td>The name that needs to be fetched. Use user1 for testing. </td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 200 | successful operation | <a href="#/definitions/User">User</a>|
| 400 | Invalid username supplied | - |
| 404 | User not found | - |
### PUT
<a id="updateUser">Updated user</a>
This can only be done by the logged in user.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>username</th>
<td>path</td>
<td>yes</td>
<td>name that need to be deleted</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>Updated user object</td>
<td> - </td>
<td>
<a href="#/definitions/User">User</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 400 | Invalid user supplied | - |
| 404 | User not found | - |
### DELETE
<a id="deleteUser">Delete user</a>
This can only be done by the logged in user.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>username</th>
<td>path</td>
<td>yes</td>
<td>The name that needs to be deleted</td>
<td> - </td>
<td>string </td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 400 | Invalid username supplied | - |
| 404 | User not found | - |
### PATCH
<a id="updateUser">Updated user</a>
This can only be done by the logged in user.
#### Request
##### Parameters
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>username</th>
<td>path</td>
<td>yes</td>
<td>name that need to be deleted</td>
<td> - </td>
<td>string </td>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>Updated user object</td>
<td> - </td>
<td>
<a href="#/definitions/User">User</a>
</td>
</tr>
</table>
#### Response
**Content-Type: ** application/json, application/xml
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 400 | Invalid user supplied | - |
| 404 | User not found | - |
# Definitions
## <a name="/definitions/ApiResponse">ApiResponse</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>code</td>
<td>
integer (int32)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>type</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>message</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
</table>
## <a name="/definitions/Category">Category</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>id</td>
<td>
integer (int64)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>name</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
</table>
## <a name="/definitions/ListItem">ListItem</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>id</td>
<td>
integer (int64)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
</table>
## <a name="/definitions/Order">Order</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>id</td>
<td>
integer (int64)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>petId</td>
<td>
integer (int64)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>quantity</td>
<td>
integer (int32)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>shipDate</td>
<td>
string (date-time)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>status</td>
<td>
string
</td>
<td>optional</td>
<td>Order Status</td>
<td></td>
</tr>
<tr>
<td>complete</td>
<td>
boolean
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>optionalStatus</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
</table>
## <a name="/definitions/Pet">Pet</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>id</td>
<td>
integer
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>category</td>
<td>
<a href="#/definitions/Category">Category</a>
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>name</td>
<td>
string
</td>
<td>required</td>
<td>-</td>
<td>doggie</td>
</tr>
<tr>
<td>photoUrls</td>
<td>
array[string]
</td>
<td>required</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>tags</td>
<td>
array[<a href="#/definitions/Tag">Tag</a>]
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>status</td>
<td>
string
</td>
<td>optional</td>
<td>pet status in the store</td>
<td></td>
</tr>
</table>
## <a name="/definitions/Tag">Tag</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>id</td>
<td>
integer (int64)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>name</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
</table>
## <a name="/definitions/User">User</a>
<table border="1">
<tr>
<th>name</th>
<th>type</th>
<th>required</th>
<th>description</th>
<th>example</th>
</tr>
<tr>
<td>id</td>
<td>
integer (int64)
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>username</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>firstName</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>lastName</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>email</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>password</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>phone</td>
<td>
string
</td>
<td>optional</td>
<td>-</td>
<td></td>
</tr>
<tr>
<td>userStatus</td>
<td>
integer (int32)
</td>
<td>optional</td>
<td>User Status</td>
<td>2</td>
</tr>
</table>
]]>