Petstore
In this example swagger description is directly embedded in the page. See source file
/pets
POST Add a new pet to the store
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| body | body | Pet object that needs to be added to the store | String |
Responses
405 Invalid input
PUT Update an existing pet
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| body | body | Pet object that needs to be added to the store | String |
Responses
405 Validation exception
404 Pet not found
400 Invalid ID supplied
/pets/findByStatus
GET Finds Pets by status
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| status | query | Status values that need to be considered for filter | Array of String |
Responses
200 successful operation
400 Invalid status value
/pets/findByTags
GET Finds Pets by tags
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| tags | query | Tags to filter by | Array of String |
Responses
200 successful operation
400 Invalid tag value
/pets/{petId}
GET Find pet by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| petId | path | ID of pet that needs to be fetched | Integer |
Responses
404 Pet not found
200 successful operation
400 Invalid ID supplied
POST Updates a pet in the store with form data
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| petId | path | ID of pet that needs to be updated | String |
| name | formData | Updated name of the pet | String |
| status | formData | Updated status of the pet | String |
Responses
405 Invalid input
DELETE Deletes a pet
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| api_key | header | String | |
| petId | path | Pet id to delete | Integer |
Responses
400 Invalid pet value
/stores/order
POST Place an order for a pet
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| body | body | order placed for purchasing the pet | String |
Responses
200 successful operation
400 Invalid Order
/stores/order/{orderId}
GET Find purchase order by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| orderId | path | ID of pet that needs to be fetched | String |
Responses
404 Order not found
200 successful operation
400 Invalid ID supplied
DELETE Delete purchase order by ID
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| orderId | path | ID of the order that needs to be deleted | String |
Responses
404 Order not found
400 Invalid ID supplied
/users
POST Create user
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| body | body | Created user object | String |
Responses
default successful operation
/users/createWithArray
POST Creates list of users with given input array
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| body | body | List of user object | String |
Responses
default successful operation
/users/createWithList
POST Creates list of users with given input array
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| body | body | List of user object | String |
Responses
default successful operation
/users/login
GET Logs user into the system
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| username | query | The user name for login | String |
| password | query | The password for login in clear text | String |
Responses
200 successful operation
400 Invalid username/password supplied
/users/logout
GET Logs out current logged in user session
Responses
default successful operation
/users/{username}
GET Get user by user name
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| username | path | The name that needs to be fetched. Use user1 for testing. | String |
Responses
404 User not found
200 successful operation
400 Invalid username supplied
PUT Updated user
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| username | path | name that need to be deleted | String |
| body | body | Updated user object | String |
Responses
404 User not found
400 Invalid user supplied
DELETE Delete user
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| username | path | The name that needs to be deleted | String |