# Petstore API

:badge[Version 1.0.27]

This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about
Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the 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)

## Servers

::: fields
- `https://petstore3.swagger.io/api/v3`

  Swagger’s public Petstore
:::

## Authentication

No authentication needed.

::: fields
- `petstore_auth`

  OAuth 2.0

  - `implicit`

    authorization at <https://petstore3.swagger.io/oauth/authorize>

    - `write:pets`

      modify pets in your account
    - `read:pets`

      read your pets
- `api_key`

  API key in the header `api_key`
:::
:::
## Operations

### [pet](https://clay-doc.github.io/clay-example-repo/api/petstore/pet.md)

Everything about your Pets

::: endpoints
- `PUT /pet` [Update an existing pet.](https://clay-doc.github.io/clay-example-repo/api/petstore/pet/update-pet.md)
- `POST /pet` [Add a new pet to the store.](https://clay-doc.github.io/clay-example-repo/api/petstore/pet/add-pet.md)
- `GET /pet/findByStatus` [Finds Pets by status.](https://clay-doc.github.io/clay-example-repo/api/petstore/pet/find-pets-by-status.md)
- `GET /pet/findByTags` [Finds Pets by tags.](https://clay-doc.github.io/clay-example-repo/api/petstore/pet/find-pets-by-tags.md)
- `GET /pet/{petId}` [Find pet by ID.](https://clay-doc.github.io/clay-example-repo/api/petstore/pet/get-pet-by-id.md)
- `POST /pet/{petId}` [Updates a pet in the store with form data.](https://clay-doc.github.io/clay-example-repo/api/petstore/pet/update-pet-with-form.md)
- `DELETE /pet/{petId}` [Deletes a pet.](https://clay-doc.github.io/clay-example-repo/api/petstore/pet/delete-pet.md)
- `POST /pet/{petId}/uploadImage` [Uploads an image.](https://clay-doc.github.io/clay-example-repo/api/petstore/pet/upload-file.md)
:::

### [store](https://clay-doc.github.io/clay-example-repo/api/petstore/store.md)

Access to Petstore orders

::: endpoints
- `GET /store/inventory` [Returns pet inventories by status.](https://clay-doc.github.io/clay-example-repo/api/petstore/store/get-inventory.md)
- `POST /store/order` [Place an order for a pet.](https://clay-doc.github.io/clay-example-repo/api/petstore/store/place-order.md)
- `GET /store/order/{orderId}` [Find purchase order by ID.](https://clay-doc.github.io/clay-example-repo/api/petstore/store/get-order-by-id.md)
- `DELETE /store/order/{orderId}` [Delete purchase order by identifier.](https://clay-doc.github.io/clay-example-repo/api/petstore/store/delete-order.md)
:::

### [user](https://clay-doc.github.io/clay-example-repo/api/petstore/user.md)

Operations about user

::: endpoints
- `POST /user` [Create user.](https://clay-doc.github.io/clay-example-repo/api/petstore/user/create-user.md)
- `POST /user/createWithList` [Creates list of users with given input array.](https://clay-doc.github.io/clay-example-repo/api/petstore/user/create-users-with-list-input.md)
- `GET /user/login` [Logs user into the system.](https://clay-doc.github.io/clay-example-repo/api/petstore/user/login-user.md)
- `GET /user/logout` [Logs out current logged in user session.](https://clay-doc.github.io/clay-example-repo/api/petstore/user/logout-user.md)
- `GET /user/{username}` [Get user by user name.](https://clay-doc.github.io/clay-example-repo/api/petstore/user/get-user-by-name.md)
- `PUT /user/{username}` [Update user resource.](https://clay-doc.github.io/clay-example-repo/api/petstore/user/update-user.md)
- `DELETE /user/{username}` [Delete user resource.](https://clay-doc.github.io/clay-example-repo/api/petstore/user/delete-user.md)
:::

## [Schemas](https://clay-doc.github.io/clay-example-repo/api/petstore/schemas.md)

::: cards
- [Order](https://clay-doc.github.io/clay-example-repo/api/petstore/schemas/order.md){fa-solid fa-cube}
- [Category](https://clay-doc.github.io/clay-example-repo/api/petstore/schemas/category.md){fa-solid fa-cube}
- [User](https://clay-doc.github.io/clay-example-repo/api/petstore/schemas/user.md){fa-solid fa-cube}
- [Tag](https://clay-doc.github.io/clay-example-repo/api/petstore/schemas/tag.md){fa-solid fa-cube}
- [Pet](https://clay-doc.github.io/clay-example-repo/api/petstore/schemas/pet.md){fa-solid fa-cube}
- [ApiResponse](https://clay-doc.github.io/clay-example-repo/api/petstore/schemas/api-response.md){fa-solid fa-cube}
:::

---

- Contact: <apiteam@swagger.io>
- License: [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)
- [Terms of service](https://swagger.io/terms/)
- [Find out more about Swagger](https://swagger.io)
- [The OpenAPI document](https://clay-doc.github.io/clay-example-repo/_clay/openapi/petstore.json)

---

All pages of these docs, as Markdown for language models: https://clay-doc.github.io/clay-example-repo/llms.txt