# Swagger Petstore - OpenAPI 3.0 This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [http://swagger.io](http://swagger.io). In the third iteration of a pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3. Some useful links: - [The Pet Store repository](https://github.com/swagger-api/swagger-petstore) - [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml) Version: 1.0.20-SNAPSHOT License: Apache 2.0 ## Servers ``` /v3 ``` ## Security ### petstore_auth Type: oauth2 Authorization URL: https://petstore.swagger.io/oauth/authorize Scopes: - `write:pet`: modify pet in your account - `read:pet`: read your pet ### api_key Type: apiKey In: header Name: api_key ## Download OpenAPI description [Swagger Petstore - OpenAPI 3.0](https://innovario.apishowdown.com/_spec/catalog/api-showdown/api-hub/Pet%20Store/openapi.yaml) ## pet Everything about your Pet ### Add a new pet to the store - [POST /pet](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/pet/addpet.md): Add a new pet to the store ### Update an existing pet - [PUT /pet](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/pet/updatepet.md): Update an existing pet by Id ### Finds Pet by status - [GET /pet/findByStatus](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/pet/findpetsbystatus.md): Multiple status values can be provided with comma separated strings ### Finds Pet by tags - [GET /pet/findByTags](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/pet/findpetsbytags.md): Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Find pet by ID - [GET /pet/{petId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/pet/getpetbyid.md): Returns a single pet ### Updates a pet in the store with form data - [POST /pet/{petId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/pet/updatepetwithform.md) ### Deletes a pet - [DELETE /pet/{petId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/pet/deletepet.md) ### uploads an image - [POST /pet/{petId}/uploadImage](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/pet/uploadfile.md) ## store Access to Petstore orders ### Returns pet inventories by status - [GET /store/inventory](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/store/getinventory.md): Returns a map of status codes to quantities ### Place an order for a pet - [POST /store/order](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/store/placeorder.md): Place a new order in the store ### Find purchase order by ID - [GET /store/order/{orderId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/store/getorderbyid.md): For valid response try integer IDs with value 10. Other values will generate exceptions. ### Delete purchase order by ID - [DELETE /store/order/{orderId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/store/deleteorder.md): For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ## user Operations about user ### Create user - [POST /user](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/user/createuser.md): This can only be done by the logged in user. ### Creates list of users with given input array - [POST /user/createWithList](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/user/createuserswithlistinput.md): Creates list of users with given input array ### Logs user into the system - [GET /user/login](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/user/loginuser.md) ### Logs out current logged in user session - [GET /user/logout](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/user/logoutuser.md) ### Get user by user name - [GET /user/{username}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/user/getuserbyname.md) ### Update user - [PUT /user/{username}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/user/updateuser.md): This can only be done by the logged in user. ### Delete user - [DELETE /user/{username}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/pet-store/openapi/user/deleteuser.md): This can only be done by the logged in user.