-
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) · 11 KB
/
schema.yml
File metadata and controls
436 lines (436 loc) · 11 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: ReferralAPI
version: 0.0.0
description: RESTful API сервис для реферальной системы
paths:
/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: ''
/referral/all/:
get:
operationId: referral_all_list
description: Concrete view for listing a queryset.
tags:
- referral
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Referral'
description: ''
/referral/create/:
post:
operationId: referral_create_create
description: Concrete view for creating a model instance.
tags:
- referral
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Referral'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Referral'
multipart/form-data:
schema:
$ref: '#/components/schemas/Referral'
required: true
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Referral'
description: ''
/referral/delete/:
delete:
operationId: referral_delete_destroy
description: Concrete view for deleting a model instance.
summary: delete users actual referral code
tags:
- referral
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
responses:
'204':
description: No response body
/user/all/:
get:
operationId: user_all_list
description: |-
A viewset that provides default asynchronous `create()`, `retrieve()`, `update()`,
`partial_update()`, `destroy()` and `list()` actions.
summary: List of users
tags:
- user
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/aUserView'
description: ''
/user/all/{id}/:
get:
operationId: user_all_retrieve
description: |-
A viewset that provides default asynchronous `create()`, `retrieve()`, `update()`,
`partial_update()`, `destroy()` and `list()` actions.
summary: User detail
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this user.
required: true
tags:
- user
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/aUserView'
description: ''
/user/referral/get/:
get:
operationId: user_referral_get_retrieve
summary: Actual users referral to email
tags:
- user
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
responses:
'200':
description: No response body
/user/referrals/{id}/:
get:
operationId: user_referrals_retrieve
summary: List of invited users
parameters:
- in: path
name: id
schema:
type: integer
required: true
tags:
- user
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/aUserView'
description: ''
/user/register/:
post:
operationId: user_register_create
summary: New user
tags:
- user
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/aUserCreate'
examples:
PostExample:
value:
username: testuser_xxx
email: [email protected]
password: string
summary: Post example
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/aUserCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/aUserCreate'
required: true
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/aUserCreate'
description: ''
/user/register/{ref_code}/:
post:
operationId: user_register_create_with_referral_code
summary: New user
parameters:
- in: path
name: ref_code
schema:
type: string
required: true
tags:
- user
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/aUserCreate'
examples:
PostExample:
value:
username: testuser_xxx
email: [email protected]
password: string
summary: Post example
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/aUserCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/aUserCreate'
required: true
security:
- basicAuth: []
- cookieAuth: []
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/aUserCreate'
description: ''
components:
schemas:
Referral:
type: object
description: Base serializer class.
properties:
id:
type: integer
readOnly: true
create_date:
type: string
format: date
readOnly: true
title: Дата создания
code:
type: string
title: Реферальный код
maxLength: 100
valid_period:
type: integer
title: Срок действия
end_date:
type: string
format: date
title: Дата окончания
owner:
type: integer
title: Владелец
required:
- code
- create_date
- end_date
- id
- owner
- valid_period
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
writeOnly: true
required:
- access
- refresh
aRefCode:
type: object
description: Base serializer class.
properties:
code:
type: string
title: Реферальный код
maxLength: 100
required:
- code
aUserCreate:
type: object
description: Base serializer class.
properties:
username:
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
pattern: ^[\w.@+-]+$
maxLength: 150
email:
type: string
format: email
title: Email address
maxLength: 254
password:
type: string
maxLength: 128
referrer:
type: integer
nullable: true
title: Реферер
required:
- password
- username
aUserView:
type: object
description: Base serializer class.
properties:
id:
type: integer
readOnly: true
username:
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
pattern: ^[\w.@+-]+$
maxLength: 150
email:
type: string
format: email
title: Email address
maxLength: 254
groups:
type: array
items:
type: integer
description: The groups this user belongs to. A user will get all permissions
granted to each of their groups.
referrer:
type: integer
nullable: true
title: Реферер
referral_code:
$ref: '#/components/schemas/aRefCode'
required:
- id
- referral_code
- username
securitySchemes:
basicAuth:
type: http
scheme: basic
cookieAuth:
type: apiKey
in: cookie
name: sessionid
jwtAuth:
type: http
scheme: bearer
bearerFormat: JWT