generated from userver-framework/service_template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
united_api.yaml
502 lines (502 loc) · 14.1 KB
/
united_api.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
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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
components:
schemas:
TypesAdminAccount:
properties:
admin_id:
$ref: '#/components/schemas/TypesId'
login:
type: string
user_id:
$ref: '#/components/schemas/TypesId'
TypesAdminFilter:
properties:
admin_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
logins:
items:
type: string
type: array
user_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
TypesAuthTokenV1:
allOf:
- $ref: '#/components/schemas/TypesId'
description: Используется для аунтефикации пользователя. Передаем строго через
хедер
TypesDay:
enum:
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
type: string
TypesEducationType:
enum:
- undergraduate
- magistracy
- postgraduate
- specialty
type: string
TypesErrorV1:
properties:
description:
example: Password must have at least 10 symbols
type: string
machine_id:
example: SMALL_PASSWORD
type: string
TypesId:
description: UUID v4
example: 6173575e-e86c-4c55-b43d-aa3ca6242181
type: string
TypesLessonV1:
properties:
begin:
$ref: '#/components/schemas/TypesTimestamp'
day:
$ref: '#/components/schemas/TypesDay'
department_id:
$ref: '#/components/schemas/TypesId'
department_name:
description: Название факультета
example: ПММ
type: string
end:
$ref: '#/components/schemas/TypesTimestamp'
faculty_id:
$ref: '#/components/schemas/TypesId'
faculty_name:
description: Название факультета
example: ПММ
type: string
group_course:
maximum: 6
minimum: 1
type: integer
group_id:
$ref: '#/components/schemas/TypesId'
group_name:
description: Название группы
example: ФИИТ
type: string
group_type:
$ref: '#/components/schemas/TypesEducationType'
id:
$ref: '#/components/schemas/TypesId'
number:
$ref: '#/components/schemas/TypesNumberLesson'
room_id:
$ref: '#/components/schemas/TypesId'
room_name:
description: Номер аудитории
example: 405П
type: string
subgroup:
$ref: '#/components/schemas/TypesSubgroup'
subject_id:
$ref: '#/components/schemas/TypesId'
subject_name:
example: Дифференциальные уравнения
type: string
teacher_bio:
example: Нереально работаю в ВГУ
type: string
teacher_fio:
example: Иванов Иван Иванович
type: string
teacher_id:
example: some_id
type: string
type:
$ref: '#/components/schemas/TypesTypeOfLesson'
week_type:
$ref: '#/components/schemas/TypesTypeOfWeek'
TypesNumberLesson:
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
type: integer
TypesSubgroup:
description: 'Тип подгруппы: All - для обеих'
enum:
- all
- first
- second
type: string
TypesTeacherInfo:
properties:
bio:
description: биография
type: string
department_id:
$ref: '#/components/schemas/TypesId'
fio:
description: ФИО
type: string
TypesTimestamp:
example: 2023-04-01T05:30:00+0000
type: string
TypesTypeOfLesson:
description: Тип пары
enum:
- labaratory
- lection
- practice
type: string
TypesTypeOfWeek:
description: 'Тип недели: All - всегда, Even - только по числителю, Odd - только
по знаменателю'
enum:
- all
- even
- odd
type: string
TypesUserCredentialV1:
properties:
login:
example: some_nickname
type: string
password:
example: some_password
type: string
required:
- login
- password
TypesUserTypeV1:
enum:
- user
- teacher
- admin
- root
type: string
TypesUserV1:
properties:
id:
$ref: '#/components/schemas/TypesId'
type:
$ref: '#/components/schemas/TypesUserTypeV1'
required:
- id
- type
type: object
ViewsAdminCreateRequest:
properties:
credentials:
$ref: '#/components/schemas/TypesUserCredentialV1'
ViewsAdminListRequest:
properties:
filter:
$ref: '#/components/schemas/TypesAdminFilter'
ViewsLoginResponseV1:
properties:
token:
$ref: '#/components/schemas/TypesAuthTokenV1'
user:
$ref: '#/components/schemas/TypesUserV1'
ViewsRegisterRequestV1:
properties:
description:
description: Дополнительная информация для администраторов при регистрации
(в рамках запроса привиллегий преподавателя или администратора)
type: string
desired_type:
$ref: '#/components/schemas/TypesUserTypeV1'
user_credential:
$ref: '#/components/schemas/TypesUserCredentialV1'
required:
- user_credential
ViewsTeacherCreateRequest:
properties:
credentials:
$ref: '#/components/schemas/TypesTeacherInfo'
ViewsTimetableGetRequest:
properties:
begin:
$ref: '#/components/schemas/TypesTimestamp'
days:
items:
$ref: '#/components/schemas/TypesDay'
type: array
department_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
department_names:
items:
type: string
type: array
end:
$ref: '#/components/schemas/TypesTimestamp'
faculty_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
faculty_names:
items:
type: string
type: array
group_courses:
items:
type: integer
type: array
group_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
group_names:
items:
type: string
type: array
group_types:
items:
$ref: '#/components/schemas/TypesEducationType'
type: array
lesson_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
lesson_type:
$ref: '#/components/schemas/TypesTypeOfLesson'
numbers:
items:
type: integer
type: array
room_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
room_names:
items:
type: string
type: array
subgroup:
$ref: '#/components/schemas/TypesSubgroup'
subject_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
subject_names:
items:
type: string
type: array
teacher_bios:
items:
type: string
type: array
teacher_fios:
items:
type: string
type: array
teacher_ids:
items:
$ref: '#/components/schemas/TypesId'
type: array
week:
$ref: '#/components/schemas/TypesTypeOfWeek'
info:
description: This is a simple timetable API
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
title: Simple Timetable API
version: 1.0.0
openapi: 3.0.0
paths:
/admin/create:
post:
description: Получить список администраторов
parameters:
- in: header
name: authToken
required: true
schema:
$ref: '#/components/schemas/TypesAuthTokenV1'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ViewsAdminCreateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesAdminAccount'
description: Аккаунт успешно создан
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesErrorV1'
description: Отсутствует или истекший токен
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesErrorV1'
description: Нет прав на подобные изменения
tags:
- root
/admin/list:
post:
description: Получить список администраторов
parameters:
- in: header
name: authToken
required: true
schema:
$ref: '#/components/schemas/TypesAuthTokenV1'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ViewsAdminListRequest'
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TypesAdminAccount'
type: array
description: Найденные аккаунты
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesErrorV1'
description: Отсутствует или истекший токен
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesErrorV1'
description: Нет прав на подобные изменения
tags:
- root
/login:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TypesUserCredentialV1'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ViewsLoginResponseV1'
description: Авторизация прозошла успешно
'400':
description: Не переданы необходимые параметры
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesErrorV1'
description: Имя пользователя или пароль не верны
tags:
- users
/register:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ViewsRegisterRequestV1'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesAuthTokenV1'
description: Создан новый пользователь
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesErrorV1'
description: Логин уже занят или пароль не удолетворяет требованиям
tags:
- users
/teacher/create:
post:
description: Создать нового преподавателя
parameters:
- in: header
name: authToken
required: true
schema:
$ref: '#/components/schemas/TypesAuthTokenV1'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ViewsTeacherCreateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesAdminAccount'
description: Преподаватель успешно создан
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesErrorV1'
description: Отсутствует или истекший токен
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/TypesErrorV1'
description: Нет прав на подобные изменения
tags:
- admins
/timetable/get:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ViewsTimetableGetRequest'
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TypesLessonV1'
type: array
description: Найденные пары
tags:
- users
tags:
- description: Доступно суперпользователю
name: root
- description: Доступно администраторам сервиса
name: admins
- description: Доступны для преподавателей, которые ведут соответствующую группу и
соответствующий предмет
name: teachers
- description: Доступно всем
name: users