forked from loafle/openapi-generator-original
116 lines
2.6 KiB
Markdown
116 lines
2.6 KiB
Markdown
# StoreApi
|
|
|
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**deleteOrder**](StoreApi.md#deleteOrder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
|
[**getInventory**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status
|
|
[**getOrderById**](StoreApi.md#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID
|
|
[**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
|
|
|
|
|
|
<a name="deleteOrder"></a>
|
|
# **deleteOrder**
|
|
> deleteOrder(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
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**orderId** | **String**| ID of the order that needs to be deleted | [default to null]
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: Not defined
|
|
|
|
<a name="getInventory"></a>
|
|
# **getInventory**
|
|
> Map getInventory()
|
|
|
|
Returns pet inventories by status
|
|
|
|
Returns a map of status codes to quantities
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**Map**](/Models/integer.md)
|
|
|
|
### Authorization
|
|
|
|
[api_key](../README.md#api_key)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getOrderById"></a>
|
|
# **getOrderById**
|
|
> Order getOrderById(orderId)
|
|
|
|
Find purchase order by ID
|
|
|
|
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**orderId** | **Long**| ID of pet that needs to be fetched | [default to null]
|
|
|
|
### Return type
|
|
|
|
[**Order**](/Models/Order.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/xml, application/json
|
|
|
|
<a name="placeOrder"></a>
|
|
# **placeOrder**
|
|
> Order placeOrder(body)
|
|
|
|
Place an order for a pet
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**Order**](/Models/Order.md)| order placed for purchasing the pet |
|
|
|
|
### Return type
|
|
|
|
[**Order**](/Models/Order.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/xml, application/json
|
|
|