UNPKG

@readme/oas-examples

Version:

A collection of example OpenAPI 3.x and Swagger 2.0 documents.

183 lines (182 loc) 4.01 kB
swagger: '2.0' info: version: 1.0.0 title: Swagger Petstore description: This is a slimmed down single path version of the Petstore definition. host: petstore.swagger.io basePath: '/v2' tags: - name: pet description: Everything about your Pets externalDocs: description: Find out more url: http://swagger.io schemes: - http consumes: - application/json produces: - application/json paths: '/pet/{petId}': get: tags: - pet summary: Find pet by ID description: Returns a single pet operationId: getPetById produces: - application/xml - application/json parameters: - name: petId in: path description: ID of pet to return required: true type: integer format: int64 responses: '200': description: successful operation schema: '$ref': '#/definitions/Pet' '400': description: Invalid ID supplied '404': description: Pet not found security: - api_key: [] post: tags: - pet summary: Updates a pet in the store with form data description: '' operationId: updatePetWithForm consumes: - application/x-www-form-urlencoded produces: - application/xml - application/json parameters: - name: petId in: path description: ID of pet that needs to be updated required: true type: integer format: int64 - name: name in: formData description: Updated name of the pet required: false type: string - name: status in: formData description: Updated status of the pet required: false type: string responses: '405': description: Invalid input security: - petstore_auth: - write:pets - read:pets delete: tags: - pet summary: Deletes a pet description: '' operationId: deletePet produces: - application/xml - application/json parameters: - name: api_key in: header required: false type: string - name: petId in: path description: Pet id to delete required: true type: integer format: int64 responses: '400': description: Invalid ID supplied '404': description: Pet not found security: - petstore_auth: - write:pets - read:pets securityDefinitions: petstore_auth: type: oauth2 authorizationUrl: http://petstore.swagger.io/oauth/dialog flow: implicit scopes: write:pets: modify pets in your account read:pets: read your pets api_key: type: apiKey name: api_key in: header definitions: Category: type: object properties: id: type: integer format: int64 name: type: string xml: name: Category Tag: type: object properties: id: type: integer format: int64 name: type: string xml: name: Tag Pet: type: object required: - name - photoUrls properties: id: type: integer format: int64 category: '$ref': '#/definitions/Category' name: type: string example: doggie photoUrls: type: array xml: name: photoUrl wrapped: true items: type: string tags: type: array xml: name: tag wrapped: true items: '$ref': '#/definitions/Tag' status: type: string description: pet status in the store enum: - available - pending - sold xml: name: Pet