Skip to content

Latest commit

 

History

History
122 lines (72 loc) · 3.53 KB

StoreApi.md

File metadata and controls

122 lines (72 loc) · 3.53 KB
Raw

StoreApi

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

Method HTTP request Description
delete_order DELETE /store/order/{orderId} Delete purchase order by ID
get_inventory GET /store/inventory Returns pet inventories by status
get_order_by_id GET /store/order/{orderId} Find purchase order by ID
place_order POST /store/order Place an order for a pet

delete_order

delete_order(req::HTTP.Request, order_id::Int64;) -> Nothing

Delete purchase order by ID

For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
order_id Int64 ID of the order that needs to be deleted [default to nothing]

Return type

Nothing

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_inventory

get_inventory(req::HTTP.Request;) -> Dict{String, Int64}

Returns pet inventories by status

Returns a map of status codes to quantities

Required Parameters

This endpoint does not need any parameter.

Return type

Dict{String, Int64}

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_order_by_id

get_order_by_id(req::HTTP.Request, order_id::Int64;) -> Order

Find purchase order by ID

For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
order_id Int64 ID of pet that needs to be fetched [default to nothing]

Return type

Order

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

place_order

place_order(req::HTTP.Request, body::Order;) -> Order

Place an order for a pet

Required Parameters

Name Type Description Notes
req HTTP.Request The HTTP Request object
body Order order placed for purchasing the pet

Return type

Order

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]