-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
402 lines (402 loc) · 13.3 KB
/
openapi.yaml
File metadata and controls
402 lines (402 loc) · 13.3 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
openapi: 3.1.0
info:
title: Timetable Manager API specification
description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
version: 0.1.9
servers:
- url: http://localhost:3000
description: Optional server description, e.g. Main (production) server
paths:
/users:
get:
summary: Returns a list of users.
description: Optional extended description in CommonMark or HTML.
responses:
200: # status code
description: A JSON array of user names
content:
application/json:
schema:
type: array
items:
type: string
/academicYears:
get:
summary: Get all academic years by userId.
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
academicYears:
$ref: "#/components/schemas/AcademicYears"
400:
$ref: "#/components/BadRequestError"
/subjects:
get:
summary: Get all subjects by department and all multi-disciplinary subjects.
parameters:
- name: departmentId
in: query
required: true
description: ID of the department.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
subjects:
$ref: "#/components/schemas/Subjects"
400:
$ref: "#/components/BadRequestError"
/classrooms:
get:
summary: Get all classrooms by academicYearId.
parameters:
- name: academicYearId
in: query
required: true
description: ID of the academic year.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
classrooms:
$ref: "#/components/schemas/Classrooms"
400:
$ref: "#/components/BadRequestError"
/teachers:
get:
summary: Get all teachers by academicYearId.
parameters:
- name: academicYearId
in: query
required: true
description: ID of the academic year.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
teachers:
$ref: "#/components/schemas/Teachers"
400:
$ref: "#/components/BadRequestError"
/subjectTeachers:
get:
summary: Get all teachers by subjectId.
parameters:
- name: subjectId
in: query
required: true
description: ID of the subject.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
teachers:
$ref: "#/components/schemas/Teachers"
400:
$ref: "#/components/BadRequestError"
/batches:
get:
summary: Get all batches by academicYearId.
parameters:
- name: academicYearId
in: query
required: true
description: ID of the academic year.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
batches:
$ref: "#/components/schemas/Batches"
400:
$ref: "#/components/BadRequestError"
/divisions:
get:
summary: Get all divisions by departmentId.
parameters:
- name: departmentId
in: query
required: true
description: ID of the department.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
divisions:
$ref: "#/components/schemas/Divisions"
400:
$ref: "#/components/BadRequestError"
/departments:
get:
summary: Get all departments by batchId.
parameters:
- name: batchId
in: query
required: true
description: ID of the batch.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
departments:
$ref: "#/components/schemas/Departments"
400:
$ref: "#/components/BadRequestError"
/subdivisionTimetable:
get:
summary: Get timetable information by subdivisionId.
/divisionTimetable:
get:
summary: Get timetable information by divisionId.
/teacherTimetable:
get:
summary: Get timetable information by teacherId.
/classroomTimetable:
get:
summary: Get timetable information by classroomId.
/availableTeachers:
get:
summary: Get all available teachers by slot ID and subject ID.
parameters:
- name: subjectId
in: query
required: true
description: ID of the subject.
schema:
type: number
- name: slotId
in: query
required: true
description: ID of the slot.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
teachers:
$ref: "#/components/schemas/Teachers"
400:
$ref: "#/components/BadRequestError"
/availableClassrooms:
get:
summary: Get all available classrooms by slot ID and subject ID.
parameters:
- name: subjectId
in: query
required: true
description: ID of the subject.
schema:
type: number
- name: slotId
in: query
required: true
description: ID of the slot.
schema:
type: number
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
classrooms:
$ref: "#/components/schemas/Classrooms"
400:
$ref: "#/components/BadRequestError"
# TODO: Add API information for add, update, delelte slotData.
components:
BadRequestError:
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
message:
type: string
schemas:
AcademicYears:
type: array
items:
type: object
properties:
id:
type: number
year:
type: number
name:
type: string
Batches:
type: array
items:
type: object
properties:
id:
type: number
batchName:
type: string
AcademicYearId:
type: number
Classrooms:
type: array
items:
type: object
properties:
id:
type: number
classroomName:
type: string
AcademicYearId:
type: string
Departments:
type: array
items:
type: object
properties:
id:
type: number
departmentName:
type: string
BatchId:
type: number
Divisions:
type: array
items:
type: object
properties:
id:
type: number
divisionName:
type: string
DepartmentId:
type: number
Groups:
type: array
items:
type: object
properties:
id:
type: number
groupName:
type: string
AcademicYearId:
type: number
Slots:
type: array
items:
type: object
properties:
id:
type: number
day:
type: number
number:
type: number
AcademicYearId:
type: number
Subdivisions:
type: array
items:
type: object
properties:
id:
type: number
subdivisionName:
type: string
DivisionId:
type: number
Subjects:
type: array
items:
type: object
properties:
id:
type: number
subjectName:
type: string
isLab:
type: number
departmentId:
type: number
Teachers:
type: array
items:
type: object
properties:
id:
type: number
teacherName:
type: string
teacherEmail:
type: string
Timetable:
type: object
properties:
SlotData:
type: object
properties:
id:
type: number
slotId:
type: number
subjectId:
type: number
teacherId:
type: number