123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419 |
- openapi: 3.0.2
- servers:
- - url: /v3
- info:
- description: |-
- 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 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)
- version: 1.0.5-SNAPSHOT
- title: Swagger Petstore - OpenAPI 3.0
- termsOfService: 'http://swagger.io/terms/'
- contact:
- email: apiteam@swagger.io
- license:
- name: Apache 2.0
- url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
- tags:
- - name: pet
- description: Everything about your Pets
- externalDocs:
- description: Find out more
- url: 'http://swagger.io'
- paths:
- /pet:
- post:
- tags:
- - pet
- summary: Add a new pet to the store
- description: Add a new pet to the store
- operationId: addPet
- responses:
- '200':
- description: Successful operation
- content:
- application/xml:
- schema:
- $ref: '#/components/schemas/Pet'
- application/json:
- schema:
- $ref: '#/components/schemas/Pet'
- '405':
- description: Invalid input
- security:
- - petstore_auth:
- - 'write:pets'
- - 'read:pets'
- requestBody:
- description: Create a new pet in the store
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Pet'
- application/xml:
- schema:
- $ref: '#/components/schemas/Pet'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Pet'
- put:
- tags:
- - pet
- summary: Update an existing pet
- description: Update an existing pet by Id
- operationId: updatePet
- responses:
- '200':
- description: Successful operation
- content:
- application/xml:
- schema:
- $ref: '#/components/schemas/Pet'
- application/json:
- schema:
- $ref: '#/components/schemas/Pet'
- '400':
- description: Invalid ID supplied
- '404':
- description: Pet not found
- '405':
- description: Validation exception
- security:
- - petstore_auth:
- - 'write:pets'
- - 'read:pets'
- requestBody:
- description: Update an existent pet in the store
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Pet'
- application/xml:
- schema:
- $ref: '#/components/schemas/Pet'
- application/x-www-form-urlencoded:
- schema:
- $ref: '#/components/schemas/Pet'
- /pet/findByStatus:
- get:
- tags:
- - pet
- summary: Finds Pets by status
- description: Multiple status values can be provided with comma separated strings
- operationId: findPetsByStatus
- parameters:
- - name: status
- in: query
- description: Status values that need to be considered for filter
- required: false
- explode: true
- schema:
- type: string
- enum:
- - available
- - pending
- - sold
- default: available
- responses:
- '200':
- description: successful operation
- content:
- application/xml:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Pet'
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Pet'
- '400':
- description: Invalid status value
- security:
- - petstore_auth:
- - 'write:pets'
- - 'read:pets'
- /pet/findByTags:
- get:
- tags:
- - pet
- summary: Finds Pets by tags
- description: >-
- Multiple tags can be provided with comma separated strings. Use tag1,
- tag2, tag3 for testing.
- operationId: findPetsByTags
- parameters:
- - name: tags
- in: query
- description: Tags to filter by
- required: false
- explode: true
- schema:
- type: array
- items:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/xml:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Pet'
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Pet'
- '400':
- description: Invalid tag value
- security:
- - petstore_auth:
- - 'write:pets'
- - 'read:pets'
- '/pet/{petId}':
- get:
- tags:
- - pet
- summary: Find pet by ID
- description: Returns a single pet
- operationId: getPetById
- parameters:
- - name: petId
- in: path
- description: ID of pet to return
- required: true
- schema:
- type: integer
- format: int64
- responses:
- '200':
- description: successful operation
- content:
- application/xml:
- schema:
- $ref: '#/components/schemas/Pet'
- application/json:
- schema:
- $ref: '#/components/schemas/Pet'
- '400':
- description: Invalid ID supplied
- '404':
- description: Pet not found
- security:
- - api_key: []
- - petstore_auth:
- - 'write:pets'
- - 'read:pets'
- post:
- tags:
- - pet
- summary: Updates a pet in the store with form data
- description: ''
- operationId: updatePetWithForm
- parameters:
- - name: petId
- in: path
- description: ID of pet that needs to be updated
- required: true
- schema:
- type: integer
- format: int64
- - name: name
- in: query
- description: Name of pet that needs to be updated
- required: true
- schema:
- type: string
- - name: status
- in: query
- description: Status of pet that needs to be updated
- schema:
- type: string
- responses:
- '405':
- description: Invalid input
- security:
- - petstore_auth:
- - 'write:pets'
- - 'read:pets'
- delete:
- tags:
- - pet
- summary: Deletes a pet
- description: ''
- operationId: deletePet
- parameters:
- - name: api_key
- in: header
- description: ''
- required: false
- schema:
- type: string
- - name: petId
- in: path
- description: Pet id to delete
- required: true
- schema:
- type: integer
- format: int64
- responses:
- '400':
- description: Invalid pet value
- security:
- - petstore_auth:
- - 'write:pets'
- - 'read:pets'
- '/pet/{petId}/uploadImage':
- post:
- tags:
- - pet
- summary: uploads an image
- description: ''
- operationId: uploadFile
- parameters:
- - name: petId
- in: path
- description: ID of pet to update
- required: true
- schema:
- type: integer
- format: int64
- - name: additionalMetadata
- in: query
- description: Additional Metadata
- required: false
- schema:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiResponse'
- security:
- - petstore_auth:
- - 'write:pets'
- - 'read:pets'
- requestBody:
- content:
- application/octet-stream:
- schema:
- type: string
- format: binary
- externalDocs:
- description: Find out more about Swagger
- url: 'http://swagger.io'
- components:
- schemas:
- Category:
- x-swagger-router-model: io.swagger.petstore.model.Category
- properties:
- id:
- type: integer
- format: int64
- example: 1
- name:
- type: string
- example: Dogs
- xml:
- name: category
- type: object
- Tag:
- x-swagger-router-model: io.swagger.petstore.model.Tag
- properties:
- id:
- type: integer
- format: int64
- name:
- type: string
- xml:
- name: tag
- type: object
- Pet:
- x-swagger-router-model: io.swagger.petstore.model.Pet
- required:
- - name
- - photoUrls
- properties:
- id:
- type: integer
- format: int64
- example: 10
- name:
- type: string
- example: doggie
- category:
- $ref: '#/components/schemas/Category'
- photoUrls:
- type: array
- xml:
- wrapped: true
- items:
- type: string
- xml:
- name: photoUrl
- tags:
- type: array
- xml:
- wrapped: true
- items:
- $ref: '#/components/schemas/Tag'
- xml:
- name: tag
- status:
- type: string
- description: pet status in the store
- enum:
- - available
- - pending
- - sold
- xml:
- name: pet
- type: object
- ApiResponse:
- properties:
- code:
- type: integer
- format: int32
- type:
- type: string
- message:
- type: string
- xml:
- name: '##default'
- type: object
- requestBodies:
- Pet:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Pet'
- application/xml:
- schema:
- $ref: '#/components/schemas/Pet'
- description: Pet object that needs to be added to the store
- securitySchemes:
- petstore_auth:
- type: oauth2
- flows:
- implicit:
- authorizationUrl: 'https://petstore.swagger.io/oauth/authorize'
- scopes:
- 'write:pets': modify pets in your account
- 'read:pets': read your pets
- api_key:
- type: apiKey
- name: api_key
- in: header
|