-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
306 lines (306 loc) · 11.9 KB
/
swagger.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
openapi: 3.0.0
info:
title: QuestionPaper Generator
version: 1.0.0
servers:
- url: http://localhost:4000/api/v1
description: Local server
paths:
/health:
get:
summary: Health check
operationId: healthCheck
responses:
"200":
description: API is healthy
content:
application/json:
schema:
type: object
properties:
message:
type: string
/seed/questions:
post:
summary: Seed questions to database
operationId: seedQuestions
responses:
"201":
description: Questions seeded successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
/questions/add:
post:
summary: Add new questions to the database
description: This endpoint accepts an array of question objects in the request body and adds them to the database. It returns the added questions in the response.
operationId: addQuestionsToDatabase
requestBody:
description: The questions to add
required: true
content:
application/json:
schema:
type: array
items:
type: object
properties:
question:
type: string
description: The text of the question.
subject:
type: string
description: The subject of the question.
topic:
type: string
description: The topic of the question.
difficulty:
type: string
description: The difficulty level of the question. Can be 'Easy', 'Medium', or 'Hard'.
marks:
type: integer
description: The number of marks the question is worth.
responses:
"201":
description: The questions were added successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
description: The HTTP status code.
message:
type: string
description: A message indicating the result of the operation.
data:
type: array
items:
type: object
properties:
question:
type: string
description: The text of the question.
subject:
type: string
description: The subject of the question.
topic:
type: string
description: The topic of the question.
difficulty:
type: string
description: The difficulty level of the question. Can be 'Easy', 'Medium', or 'Hard'.
marks:
type: integer
description: The number of marks the question is worth.
post:
summary: Add a new question to the database
description: This endpoint accepts a question object in the request body and adds it to the database. It returns the added question in the response.
operationId: addQuestionsToDatabase
requestBody:
description: The question to add
required: true
content:
application/json:
schema:
type: object
properties:
question:
type: string
description: The text of the question.
subject:
type: string
description: The subject of the question.
topic:
type: string
description: The topic of the question.
difficulty:
type: string
description: The difficulty level of the question. Can be 'Easy', 'Medium', or 'Hard'.
marks:
type: integer
description: The number of marks the question is worth.
responses:
"201":
description: The question was added successfully.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
description: The HTTP status code.
message:
type: string
description: A message indicating the result of the operation.
data:
type: object
description: The added question.
properties:
question:
type: string
description: The text of the question.
subject:
type: string
description: The subject of the question.
topic:
type: string
description: The topic of the question.
difficulty:
type: string
description: The difficulty level of the question. Can be 'Easy', 'Medium', or 'Hard'.
marks:
type: integer
description: The number of marks the question is worth.
post:
summary: Add questions to database
operationId: addQuestionsToDatabase
requestBody:
description: Questions to add
required: true
content:
application/json:
schema:
type: array
items:
type: object
properties:
question:
type: string
description: The question text
subject:
type: string
description: The subject of the question
topic:
type: string
description: The topic of the question
difficulty:
type: string
description: The difficulty level of the question
marks:
type: integer
description: The marks for the question
responses:
"201":
description: Questions added successfully
content:
application/json:
schema:
type: object
properties:
status:
type: integer
message:
type: string
data:
type: array
items:
type: object
properties:
question:
type: string
description: The question text
subject:
type: string
description: The subject of the question
topic:
type: string
description: The topic of the question
difficulty:
type: string
description: The difficulty level of the question
marks:
type: integer
description: The marks for the question
/questions/generate:
post:
summary: Generate question paper
description: This endpoint accepts total marks and a difficulty distribution in the request body and generates a question paper accordingly. It returns the generated question paper in the response.
operationId: generateQuestionPaper
requestBody:
description: Total marks and difficulty distribution
required: true
content:
application/json:
schema:
type: object
properties:
totalMarks:
type: integer
description: The total marks for the question paper.
difficultyDistribution:
type: object
description: The distribution of difficulty levels for the questions in the paper. It's an object with 'Easy', 'Medium', and 'Hard' keys and integer values.
properties:
Easy:
type: integer
description: The number of easy questions.
Medium:
type: integer
description: The number of medium questions.
Hard:
type: integer
description: The number of hard questions.
responses:
"200":
description: Question paper generated successfully
content:
application/json:
schema:
type: object
properties:
status:
type: integer
description: The HTTP status code.
message:
type: string
description: A message indicating the result of the operation.
data:
type: object
description: The generated question paper.
properties:
totalMarks:
type: integer
description: The total marks of the generated question paper.
totalQuestions:
type: object
description: The total number of questions in the paper, broken down by difficulty level.
properties:
easy:
type: integer
description: The number of easy questions.
medium:
type: integer
description: The number of medium questions.
hard:
type: integer
description: The number of hard questions.
questions:
type: array
description: The questions in the paper.
items:
type: object
properties:
question:
type: string
description: The question text
subject:
type: string
description: The subject of the question
topic:
type: string
description: The topic of the question
difficulty:
type: string
description: The difficulty level of the question
marks:
type: integer
description: The marks for the question