openapi: 3.2.0 info: title: Pet Store API version: 1.0.0 description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.2 specification servers: - url: https://petstore.swagger.io/v2 description: Petstore server - url: https://mydomain.com/v1 description: My server paths: /pets: get: summary: List all pets operationId: listPets tags: - pets parameters: - name: limit in: query description: How many items to return at one time (max 100) required: false schema: type: integer maximum: 100 format: int32 responses: '200': description: A paged array of pets content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Pet' post: summary: Create a pet operationId: createPet tags: - pets requestBody: description: Pet to add to the store required: true content: application/json: schema: $ref: '#/components/schemas/Pet' responses: '201': description: Pet created content: application/json: schema: $ref: '#/components/schemas/Pet' '400': description: Invalid input /pets/{petId}: get: summary: Info for a specific pet operationId: showPetById tags: - pets parameters: - name: petId in: path required: true description: The id of the pet to retrieve schema: type: string responses: '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/Pet' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Pet: type: object required: - id - name properties: id: type: integer format: int64 name: type: string tag: type: string Error: type: object required: - code - message properties: code: type: integer format: int32 message: type: string