-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
174 lines (171 loc) · 3.82 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: https://g6pny6dke9.execute-api.us-west-2.amazonaws.com/v1/api
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 (default 100)
required: false
schema:
type: integer
format: int32
responses:
'200':
description: An array of pets
content:
application/json:
schema:
$ref: "#/components/schemas/PetList"
post:
summary: Create a Pet
operationId: createPet
tags:
- pets
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePetRequest'
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
'400':
description: "Bad Request"
'500':
description: "Internal Server Error"
/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"
'404':
description: "Not found"
delete:
summary: Delete a Pet
operationId: deletePetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to delete
schema:
type: string
responses:
'200':
description: ok
'404':
description: "Not found"
patch:
summary: Update a pet
operationId: patchPetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to update
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePetRequest'
responses:
'200':
description: "Ok"
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
'400':
description: "Bad Request"
'404':
description: "Not found"
'500':
description: "Internal Server Error"
components:
schemas:
Pet:
required:
- id
- name
- species
- age
properties:
id:
type: string
name:
type: string
species:
type: string
age:
type: integer
PetList:
required:
- items
properties:
items:
type: array
items:
$ref: "#/components/schemas/Pet"
CreatePetRequest:
required:
- name
- species
- age
properties:
name:
type: string
species:
type: string
age:
type: integer
UpdatePetRequest:
required:
- name
- species
- age
properties:
name:
type: string
species:
type: string
age:
type: integer