-
Notifications
You must be signed in to change notification settings - Fork 1
/
store_resource.openapi.yaml
370 lines (365 loc) · 10.1 KB
/
store_resource.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
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
# File generated by protoc-gen-pocket-openapi. DO NOT EDIT.
openapi: 3.0.0
info:
title: store-resource
version: "0.1.0"
paths:
/store-resource/v1/orders:
post:
summary: Cria um novo pedido.
description: Cria um novo pedido.
operationId: CreateOrder
requestBody:
required: true
description:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderRequest"
responses:
'200':
description: Sucesso.
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderResponse"
'400':
description: Argumentos da requisição inválidos.
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationError"
'401':
description: Sem autorização para acesso ao recurso.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
'500':
description: Erro interno do servidor.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
/store-resource/v1/orders/{id}:
get:
summary: Obtém informações de um determinado pedido.
description: Obtém detalhes e informações de um determinado pedido.
operationId: GetOrder
parameters:
- in: path
name: "id"
required: true
schema:
type: string
responses:
'200':
description: Sucesso.
content:
application/json:
schema:
$ref: "#/components/schemas/GetOrderResponse"
'400':
description: Argumentos da requisição inválidos.
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationError"
'401':
description: Sem autorização para acesso ao recurso.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
'500':
description: Erro interno do servidor.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
/store-resource/v1/pets:
post:
summary: Cria um novo Pet.
description: Cria um novo Pet.
operationId: CreatePet
requestBody:
required: true
description:
content:
application/json:
schema:
$ref: "#/components/schemas/CreatePetRequest"
responses:
'200':
description: Sucesso.
content:
application/json:
schema:
$ref: "#/components/schemas/CreatePetResponse"
'400':
description: Argumentos da requisição inválidos.
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationError"
'401':
description: Sem autorização para acesso ao recurso.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
'500':
description: Erro interno do servidor.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
/store-resource/v1/pets-list:
get:
summary: Obtém informações de todos Pets cadastrados.
description: Obtém detalhes e informações de todos Pet cadastrados.
operationId: GetPets
responses:
'200':
description: Sucesso.
content:
application/json:
schema:
$ref: "#/components/schemas/GetPetsResponse"
'400':
description: Argumentos da requisição inválidos.
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationError"
'401':
description: Sem autorização para acesso ao recurso.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
'500':
description: Erro interno do servidor.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
/store-resource/v1/pets/{id}:
delete:
summary: Apaga um Pet.
description: Apaga um Pet.
operationId: DeletePet
parameters:
- in: path
name: "id"
required: true
schema:
type: string
responses:
'200':
description: Sucesso.
content:
application/json:
schema:
$ref: "#/components/schemas/DeletePetResponse"
'400':
description: Argumentos da requisição inválidos.
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationError"
'401':
description: Sem autorização para acesso ao recurso.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
'500':
description: Erro interno do servidor.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
get:
summary: Obtém informações de um determinado Pet.
description: Obtém detalhes e informações de um determinado Pet.
operationId: GetPetByID
responses:
'200':
description: Sucesso.
content:
application/json:
schema:
$ref: "#/components/schemas/GetPetByIDResponse"
'400':
description: Argumentos da requisição inválidos.
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationError"
'401':
description: Sem autorização para acesso ao recurso.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
'500':
description: Erro interno do servidor.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
patch:
summary: Atualiza um Pet.
description: Atualiza um Pet.
operationId: UpdatePet
parameters:
- in: path
name: "id"
required: true
schema:
type: string
responses:
'200':
description: Sucesso.
content:
application/json:
schema:
$ref: "#/components/schemas/UpdatePetResponse"
'400':
description: Argumentos da requisição inválidos.
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationError"
'401':
description: Sem autorização para acesso ao recurso.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
'500':
description: Erro interno do servidor.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultError"
components:
schemas:
CreateOrderRequest:
type: object
properties:
pets_ids:
type: array
items:
type: string
CreateOrderResponse:
type: object
properties:
order:
$ref: '#/components/schemas/OrderProto'
CreatePetRequest:
type: object
properties:
name:
type: string
CreatePetResponse:
type: object
properties:
pet:
$ref: '#/components/schemas/PetProto'
DefaultError:
type: object
properties:
errors:
type: array
items:
type: string
message:
type: string
DeletePetResponse:
type: object
properties:
pet:
$ref: '#/components/schemas/PetProto'
FieldValidationError:
type: object
properties:
field:
type: string
location:
type: string
message:
type: string
GetOrderResponse:
type: object
properties:
order:
$ref: '#/components/schemas/OrderProto'
GetPetByIDResponse:
type: object
properties:
pet:
$ref: '#/components/schemas/PetProto'
GetPetsResponse:
type: object
properties:
pagination:
$ref: '#/components/schemas/PaginationResponseProto'
pets:
type: array
items:
$ref: '#/components/schemas/PetProto'
OrderProto:
type: object
properties:
created_at:
type: string
format: date-time
id:
type: string
pets_ids:
type: array
items:
type: string
PaginationResponseProto:
type: object
properties:
page:
type: integer
page_size:
type: integer
PetProto:
type: object
properties:
created_at:
type: string
format: date-time
deleted_at:
type: string
format: date-time
id:
type: string
name:
type: string
updated_at:
type: string
format: date-time
UpdatePetResponse:
type: object
properties:
pet:
$ref: '#/components/schemas/PetProto'
ValidationError:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/FieldValidationError'
message:
type: string
securitySchemes:
authorization:
type: http
scheme: unspecified