io.zenwave360.sdk.resources.openapi.oas-controllers-with-no-zdl.yml Maven / Gradle / Ivy
---
openapi: 3.0.2
tags:
- name: pet
description: Everything about your Pets
externalDocs:
description: Find out more
url: http://swagger.io
paths:
"/pet":
get:
tags:
- pet
summary: Get all pets
operationId: getAllPets
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/PetPaginated"
security:
- petstore_auth:
- write:pets
- read:pets
put:
tags:
- pet
summary: Update an existing pet
description: Update an existing pet by Id
operationId: updatePet
requestBody:
description: Update an existent pet in the store
content:
application/json:
schema:
"$ref": "#/components/schemas/Pet"
required: true
responses:
200:
description: Successful operation
content:
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
post:
tags:
- pet
summary: Add a new pet to the store
description: Add a new pet to the store
operationId: addPet
requestBody:
description: Create a new pet in the store
content:
application/json:
schema:
"$ref": "#/components/schemas/Pet"
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/Pet"
'400':
description: Invalid input
security:
- petstore_auth:
- write:pets
- read:pets
"/pet/{petId}":
parameters:
- name: petId
in: path
description: ID of pet to return
required: true
schema:
type: integer
format: int64
get:
tags:
- pet
summary: Find pet by ID
description: Returns a single pet
operationId: getPetById
responses:
'200':
description: successful operation
content:
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
description: ''
operationId: updatePetWithForm
requestBody:
description: Updates a pet
content:
application/json:
schema:
"$ref": "#/components/schemas/Pet"
required: true
responses:
'405':
description: Invalid input
security:
- petstore_auth:
- write:pets
- read:pets
components:
schemas:
Pet:
required:
- name
- photoUrls
type: object
x-business-entity: Pet
properties:
id:
type: integer
format: int64
example: 10
name:
type: string
example: doggie
status:
type: string
description: pet status in the store
enum:
- available
- pending
- sold
PetPaginated:
allOf:
- $ref: "#/components/schemas/Page"
- x-business-entity-paginated: "Pet"
- properties:
content:
items:
$ref: "#/components/schemas/Pet"
type: "array"
Page:
type: object
required:
- "content"
- "totalElements"
- "totalPages"
- "size"
- "number"
properties:
number:
type: integer
minimum: 0
numberOfElements:
type: integer
minimum: 0
size:
type: integer
minimum: 0
maximum: 200
multipleOf: 25
totalElements:
type: integer
totalPages:
type: integer
requestBodies:
Pet:
description: Pet object that needs to be added to the store
content:
application/json:
schema:
"$ref": "#/components/schemas/Pet"
application/xml:
schema:
"$ref": "#/components/schemas/Pet"
securitySchemes:
petstore_auth:
type: oauth2
flows:
implicit:
authorizationUrl: https://petstore3.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