openapi-generator/samples/documentation/markdown/Apis/StoreApi.md

StoreApi

All URIs are relative to http://petstore.swagger.io/v2

Method	HTTP request	Description
deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
getInventory	GET /store/inventory	Returns pet inventories by status
getOrderById	GET /store/order/{orderId}	Find purchase order by ID
placeOrder	POST /store/order	Place an order for a pet

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

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

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

placeOrder

Order placeOrder(Order)

Place an order for a pet

Parameters

Name	Type	Description	Notes
Order	Order	order placed for purchasing the pet

Return type

Order

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/xml, application/json