-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathschema.yml
More file actions
436 lines (436 loc) · 10.2 KB
/
schema.yml
File metadata and controls
436 lines (436 loc) · 10.2 KB
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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
openapi: 3.0.3
info:
title: E-Comerce API
version: 1.0.0
description: A simple Product & Order API that helps us learn Django REST Framework
paths:
/api/orders/:
get:
operationId: api_orders_list
tags:
- api
security:
- jwtAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Order'
description: ''
/api/products/:
get:
operationId: api_products_list
tags:
- api
security:
- jwtAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Product'
description: ''
post:
operationId: api_products_create
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Product'
multipart/form-data:
schema:
$ref: '#/components/schemas/Product'
required: true
security:
- jwtAuth: []
- cookieAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
description: ''
/api/products/{id}/:
get:
operationId: api_products_retrieve
parameters:
- in: path
name: id
schema:
type: integer
required: true
tags:
- api
security:
- jwtAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
description: ''
put:
operationId: api_products_update
parameters:
- in: path
name: id
schema:
type: integer
required: true
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Product'
multipart/form-data:
schema:
$ref: '#/components/schemas/Product'
required: true
security:
- jwtAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
description: ''
patch:
operationId: api_products_partial_update
parameters:
- in: path
name: id
schema:
type: integer
required: true
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedProduct'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedProduct'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedProduct'
security:
- jwtAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Product'
description: ''
delete:
operationId: api_products_destroy
parameters:
- in: path
name: id
schema:
type: integer
required: true
tags:
- api
security:
- jwtAuth: []
- cookieAuth: []
responses:
'204':
description: No response body
/api/products/info/:
get:
operationId: api_products_info_retrieve
tags:
- api
security:
- jwtAuth: []
- cookieAuth: []
- {}
responses:
'200':
description: No response body
/api/token/:
post:
operationId: api_token_create
description: |-
Takes a set of user credentials and returns an access and refresh JSON web
token pair to prove the authentication of those credentials.
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenObtainPair'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenObtainPair'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenObtainPair'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenObtainPair'
description: ''
/api/token/refresh/:
post:
operationId: api_token_refresh_create
description: |-
Takes a refresh type JSON web token and returns an access type JSON web
token if the refresh token is valid.
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefresh'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenRefresh'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenRefresh'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefresh'
description: ''
/api/token/verify/:
post:
operationId: api_token_verify_create
description: |-
Takes a token and indicates if it is valid. This view provides no
information about a token's fitness for a particular use.
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenVerify'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenVerify'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenVerify'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenVerify'
description: ''
/api/user-orders/:
get:
operationId: api_user_orders_list
tags:
- api
security:
- jwtAuth: []
- cookieAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Order'
description: ''
components:
schemas:
Order:
type: object
properties:
order_id:
type: string
format: uuid
user:
type: integer
created_at:
type: string
format: date-time
readOnly: true
nullable: true
status:
$ref: '#/components/schemas/StatusEnum'
items:
type: array
items:
$ref: '#/components/schemas/OrderItem'
readOnly: true
total_price:
type: string
readOnly: true
required:
- created_at
- items
- total_price
- user
OrderItem:
type: object
properties:
product_name:
type: string
product_price:
type: string
format: decimal
pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
quantity:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
item_subtotal:
type: string
readOnly: true
required:
- item_subtotal
- product_name
- product_price
- quantity
PatchedProduct:
type: object
properties:
name:
type: string
maxLength: 200
description:
type: string
price:
type: string
format: decimal
pattern: ^-?\d{0,6}(?:\.\d{0,2})?$
stock:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
image:
type: string
format: uri
nullable: true
Product:
type: object
properties:
name:
type: string
maxLength: 200
description:
type: string
price:
type: string
format: decimal
pattern: ^-?\d{0,6}(?:\.\d{0,2})?$
stock:
type: integer
maximum: 9223372036854775807
minimum: 0
format: int64
image:
type: string
format: uri
nullable: true
required:
- description
- name
- price
- stock
StatusEnum:
enum:
- Pending
- Confirmed
- Cancelled
type: string
description: |-
* `Pending` - Pending
* `Confirmed` - Confirmed
* `Cancelled` - Cancelled
TokenObtainPair:
type: object
properties:
username:
type: string
writeOnly: true
password:
type: string
writeOnly: true
access:
type: string
readOnly: true
refresh:
type: string
readOnly: true
required:
- access
- password
- refresh
- username
TokenRefresh:
type: object
properties:
access:
type: string
readOnly: true
refresh:
type: string
required:
- access
- refresh
TokenVerify:
type: object
properties:
token:
type: string
writeOnly: true
required:
- token
securitySchemes:
cookieAuth:
type: apiKey
in: cookie
name: sessionid
jwtAuth:
type: http
scheme: bearer
bearerFormat: JWT