-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpetstore.yml
220 lines (220 loc) · 5.3 KB
/
petstore.yml
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http://petstore.swagger.io/v1
paths:
/pets:
get:
summary: List all pets
operationId: listPets
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
# - name: offset
# in: query
# required: false
# schema:
# type: integer
# format: int32
responses:
'200':
description: A paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
type: object
required:
- pets
properties:
pets:
type: array
items:
$ref: "#/components/schemas/Pet"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
summary: Create a pet
operationId: createPets
requestBody:
content:
application/json:
schema:
type: object
required:
- name
- sex
properties:
name:
type: string
category:
type: integer
format: int32
enum:
- 1
- 2
- 3
sex:
type: string
enum:
- male
- female
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
required:
- pet
properties:
pet:
$ref: "#/components/schemas/Pet"
'422':
description: Invalid parameters
content:
application/json:
schema:
type: object
required:
- reason
properties:
reason:
type: string
example: 'Invalid name given.'
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
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:
type: object
required:
- pet
properties:
pet:
$ref: "#/components/schemas/Pet"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
put:
operationId: UpdatePet
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
category:
type: integer
format: int32
enum:
- 1
- 2
- 3
sex:
type: string
enum:
- male
- female
responses:
'200':
content:
application/json:
schema:
type: object
required:
- pet
properties:
pet:
$ref: "#/components/schemas/Pet"
components:
schemas:
Pet:
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
category:
type: integer
format: int32
enum:
- 1
- 2
- 3
tag:
type: string
sex:
type: string
enum:
- male
- female
registeredAt:
type: string
format: date-time
Pets:
type: array
items:
$ref: "#/components/schemas/Pet"
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string