-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
403 lines (395 loc) · 10.1 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
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
swagger: "2.0"
info:
description: "竜王戦管理アプリ用API"
version: "1.0.0"
title: "Ryuou-Manager"
basePath: "/v2"
tags:
- name: "questions"
- name: "admin/questions"
- name: "admin/teams"
- name: "users"
schemes:
- "http"
paths:
/questions/{team_id}:
get:
tags:
- "questions"
summary: "問題全件取得API"
description: "一覧ページ用に使います．実際の問題分は詳細ページで表示"
parameters:
- name: "team_id"
in: "path"
description: "チームID"
required: true
type: "integer"
responses:
200:
description: "成功時レスポンス"
schema:
type: array
items:
type: "object"
properties:
id:
type: "integer"
title:
type: "string"
score:
type: "integer"
is_opened:
type: "boolean"
is_passed:
type: "boolean"
/questions/{team_id}/{question_id}:
get:
tags:
- "questions"
summary: "問題詳細取得API"
description: "詳細ページ用"
parameters:
- name: "team_id"
in: "path"
description: "チームID"
required: true
type: "integer"
- name: "question_id"
in: "path"
description: "問題ID"
required: true
type: "integer"
responses:
200:
description: "成功時レスポンス"
schema:
type: "object"
properties:
id:
type: "integer"
title:
type: "string"
description:
type: "string"
score:
type: "integer"
is_passed:
type: "boolean"
post:
tags:
- "questions"
summary: "問題回答登録API"
description: "回答登録API"
parameters:
- name: "team_id"
in: "path"
description: "チームID"
required: true
type: "integer"
- name: "question_id"
in: "path"
description: "問題ID"
required: true
type: "integer"
- name: "body"
in: "body"
description: "回答"
required: true
schema:
type: "object"
properties:
answer:
type: "string"
responses:
200:
description: "成功時レスポンス"
put:
tags:
- "questions"
summary: "問題オープンAPI"
description: "ここを叩いたあとに，もう一度問題取得を行う．"
parameters:
- name: "team_id"
in: "path"
description: "チームID"
required: true
type: "integer"
- name: "question_id"
in: "path"
description: "問題ID"
required: true
type: "integer"
responses:
200:
description: "成功時レスポンス"
/admin/questions/{team_id}/{question_id}:
put:
tags:
- "admin/questions"
summary: "正解用API"
description: "問題を正解にします"
parameters:
- name: "team_id"
in: "path"
description: "チームID"
required: true
type: "integer"
- name: "question_id"
in: "path"
description: "問題ID"
required: true
type: "integer"
responses:
200:
description: "成功時レスポンス"
/admin/questions:
get:
tags:
- "admin/questions"
summary: "提出された問題リストを取得します"
responses:
200:
description: "問題一覧"
schema:
type: array
items:
type: "object"
properties:
id:
type: "integer"
title:
type: "string"
team_id:
type: "integer"
question_id:
type: "integer"
url:
type: "string"
post:
tags:
- "admin/questions"
summary: "問題登録API"
description: "問題を登録します"
parameters:
- name: "body"
in: "body"
description: "問題"
required: true
schema:
type: "object"
properties:
title:
type: "string"
description:
type: "string"
score:
type: "integer"
responses:
200:
description: "成功時レスポンス"
/admin/questions/{question_id}:
delete:
tags:
- "admin/questions"
summary: "問題削除API"
description: "問題を削除します"
parameters:
- name: "question_id"
in: "path"
description: "問題ID"
required: true
type: "integer"
responses:
200:
description: "成功時レスポンス"
put:
tags:
- "admin/questions"
summary: "問題更新API"
description: "問題を更新します"
parameters:
- name: "question_id"
in: "path"
description: "問題ID"
required: true
type: "integer"
- name: "body"
in: "body"
description: "問題"
required: true
schema:
type: "object"
properties:
title:
type: "string"
description:
type: "string"
score:
type: "integer"
responses:
200:
description: "成功時レスポンス"
/admin/teams:
get:
tags:
- "admin/teams"
summary: "チーム一覧取得API"
description: "チーム一覧を取得します"
responses:
200:
description: "成功時レスポンス"
schema:
type: array
items:
type: "object"
properties:
id:
type: "integer"
name:
type: "string"
score:
type: "integer"
post:
tags:
- "admin/teams"
summary: "チーム作成API"
description: "チームを作成します"
parameters:
- name: "body"
in: "body"
description: "問題"
required: true
schema:
type: "object"
properties:
name:
type: "string"
responses:
200:
description: "成功時レスポンス"
/admin/teams/{team_id}:
delete:
tags:
- "admin/teams"
summary: "チーム削除API"
description: "チームを削除します"
parameters:
- name: "team_id"
in: "path"
description: "チームID"
required: true
type: "integer"
responses:
200:
description: "成功時レスポンス"
/admin/teams/{team_id}/{user_id}:
post:
tags:
- "admin/teams"
summary: "チームメンバー登録API"
description: "チームにメンバーを登録します"
parameters:
- name: "team_id"
in: "path"
description: "チームID"
required: true
type: "integer"
- name: "user_id"
in: "path"
description: "ユーザーID"
required: true
type: "integer"
responses:
200:
description: "成功時レスポンス"
delete:
tags:
- "admin/teams"
summary: "チームメンバー削除API"
description: "チームからメンバーを削除します"
parameters:
- name: "team_id"
in: "path"
description: "チームID"
required: true
type: "integer"
- name: "user_id"
in: "path"
description: "ユーザーID"
required: true
type: "integer"
responses:
200:
description: "成功時レスポンス"
/users:
post:
tags:
- "users"
summary: "ユーザー登録API"
description: "ユーザーを登録します"
parameters:
- name: "body"
in: "body"
description: "ユーザー"
required: true
schema:
type: "object"
properties:
name:
type: "string"
email:
type: "string"
password:
type: "string"
responses:
200:
description: "成功時レスポンス"
get:
tags:
- "users"
summary: "ユーザー取得API"
description: "ユーザーを取得します"
responses:
200:
description: "成功時レスポンス"
schema:
type: "object"
properties:
id:
type: "integer"
name:
type: "string"
email:
type: "string"
score:
type: "integer"
is_admin:
type: "boolean"
/users/login:
post:
tags:
- "users"
summary: "ログインAPI"
description: "ユーザーをログインします"
parameters:
- name: "body"
in: "body"
description: "ログイン情報"
required: true
schema:
type: "object"
properties:
email:
type: "string"
password:
type: "string"
responses:
200:
description: "成功時レスポンス"
schema:
type: object
properties:
user_id:
type: "integer"
session_id:
type: "string"