-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
500 lines (500 loc) · 14.4 KB
/
openapi.yaml
File metadata and controls
500 lines (500 loc) · 14.4 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
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
openapi: 3.0.0
info:
description: バルセロナ動物園
version: 1.0.0
title: バルセロナ動物園API
termsOfService: 'http://swagger.io/terms/'
contact:
email: apiteam@swagger.io
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags: []
paths:
/challengethemes:
post:
summary: チャレンジネタ新規作成API
description: チャレンジネタ新規作成
operationId: ''
requestBody:
description: ''
content:
multipart/form-data:
schema:
type: object
properties:
challenge_theme:
type: object
properties:
title:
type: string
description:
type: string
recordable:
type: boolean
is_int:
type: boolean
unit:
type: string
ranking_type:
type: integer
content:
type: string
format: binary
application/json:
schema:
type: object
properties:
'':
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/challenge-theme'
examples:
example-1:
value:
id: 2
title: トイレットペーパーリフティング
description: １０秒間でトイレットペーパーを使用して何回リフティングできるか競おう！
user:
id: 3
name: ロナウド
recordable: true
is_int: true
unit: 回
ranking_type: DESC
created_at: '2020-05-03 16:04:35'
example-1:
examples:
response:
value:
id: 2
title: トイレットペーパーリフティング
description: １０秒間でトイレットペーパーを使用して何回リフティングできるか競おう！
user:
id: 3
name: ロナウド
recordable: true
is_int: true
unit: 回
ranking_type: DESC
created_at: '2020-05-03 16:04:35'
'400':
description: Bad Request
content:
application/json:
schema: {}
'403':
description: Forbidden
content:
application/json:
schema: {}
security:
- Authorization: []
tags:
- ChallengeTheme
parameters: []
get:
summary: チャレンジネタ一覧取得API
operationId: get-challengethemes
responses:
'200':
description: チャレンジネタのリスト
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/challenge-theme'
examples:
example-1:
value:
- id: 2
title: トイレットペーパーリフティング
description: １０秒間でトイレットペーパーを使用して何回リフティングできるか競おう！
user:
id: 3
name: ロナウド
recordable: true
is_int: true
unit: 回
ranking_type: DESC
created_at: '2020-05-03 16:04:35'
example-1:
examples:
response:
value:
- id: 2
title: トイレットペーパーリフティング
description: １０秒間でトイレットペーパーを使用して何回リフティングできるか競おう！
user:
id: 3
name: ロナウド
recordable: true
is_int: true
unit: 回
ranking_type: DESC
created_at: '2020-05-03 16:04:35'
'400':
description: Bad Request
content:
application/json:
schema: {}
description: チャレンジネタ一覧取得API
parameters: []
tags:
- ChallengeTheme
'/challengerecords/{challenge_theme_id}':
parameters:
- schema:
type: integer
name: challenge_theme_id
in: path
required: true
get:
summary: チャレンジレコード一覧取得API
operationId: get-challengerecords
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/challenge-record'
example-1:
examples:
response:
value:
- id: 1
content: url
comment: 挑戦してみました！
challenge_theme:
id: 2
title: トイレットペーパーリフティング
description: １０秒間でトイレットペーパーを使用して何回リフティングできるか競おう！
user:
id: 3
name: ロナウド
recordable: true
is_int: true
unit: 回
ranking_type: DESC
created_at: '2020-05-03 16:04:35'
user:
id: 4
name: メッシ
record: 30
created_at: '2020-05-03 16:06:52'
'':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/challenge-record'
examples:
example-1:
value:
- id: 1
content: url
comment: 挑戦してみました！
user:
id: 4
name: メッシ
record: 30
fav_count: 156
created_at: '2020-05-03 16:06:52'
description: ''
parameters: []
description: チャレンジネタに紐付くチャレンジレコードをranking_typeに応じたソート順で返却する
tags:
- ChallengeRecord
post:
summary: 新規チャレンジレコード投稿API
operationId: post-challengerecords
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/challenge-record'
examples:
example-1:
value:
id: 1
content: url
comment: 挑戦してみました！
user:
id: 4
name: メッシ
record: 30
fav_count: 0
created_at: '2020-05-03 16:06:52'
example-1:
examples:
response:
value:
id: 1
content: url
comment: 挑戦してみました！
challenge_theme:
id: 2
title: トイレットペーパーリフティング
description: １０秒間でトイレットペーパーを使用して何回リフティングできるか競おう！
user:
id: 3
name: ロナウド
recordable: true
is_int: true
unit: 回
ranking_type: DESC
created_at: '2020-05-03 16:04:35'
user:
id: 4
name: メッシ
record: 30
created_at: '2020-05-03 16:06:52'
'400':
description: Bad Request
content:
application/json:
schema: {}
'403':
description: Forbidden
content:
application/json:
schema: {}
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
content:
description: image or movie
type: string
format: binary
record_data:
description: JSON
type: object
properties:
comment:
type: string
record:
type: number
required:
- content
- record_data
security:
- Authorization: []
description: チャレンジネタに対するチャレンジレコードを投稿できる
tags:
- ChallengeRecord
/users:
post:
summary: 新規ユーザ作成API
operationId: post-users
responses:
'200':
description: ''
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/user'
application/json:
examples:
response:
value:
id: 4
name: メッシ
icon: 'https://s3.com/hoge.png'
schema:
$ref: '#/components/schemas/user'
'400':
description: Bad Request
content:
'*/*':
schema: {}
'401':
description: Unauthorized
content:
'*/*':
schema: {}
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
icon:
type: string
required:
- name
- icon
examples: {}
security:
- Authorization: []
description: 新規ユーザ作成API
tags:
- User
'/challengerecords/favorite/{challenge_record_id}':
put:
summary: チャレンジレコード投稿お気に入りAPI
operationId: put-challengerecords-favorite
responses:
'204':
description: No Content
description: チャレンジレコード投稿favorite機能
security:
- Authorization: []
requestBody: {}
tags:
- ChallengeRecord
parameters:
- schema:
type: integer
name: challenge_record_id
in: path
required: true
externalDocs:
description: Find out more about Swagger
url: 'http://swagger.io'
servers:
- url: 'https://stoplight.io/p/mocks/12872/27371/'
components:
securitySchemes:
Authorization:
name: X-JWT-TOKEN
type: apiKey
in: header
schemas:
challenge-theme:
title: challenge-theme
type: object
description: ''
properties:
id:
type: integer
title:
type: string
description:
type: string
user:
$ref: '#/components/schemas/user'
recordable:
type: boolean
is_int:
type: boolean
unit:
type: string
ranking_type:
type: string
enum:
- ASC
- DESC
- FAV
created_at:
type: string
format: date-time
required:
- id
- title
- description
- user
- recordable
- is_int
- unit
- ranking_type
- created_at
x-examples:
example-1:
id: 2
title: トイレットペーパーリフティング
description: １０秒間でトイレットペーパーを使用して何回リフティングできるか競おう！
user:
id: 3
name: ロナウド
recordable: true
is_int: true
unit: 回
ranking_type: DESC
created_at: '2020-05-03 16:04:35'
user:
title: user
type: object
description: ''
x-examples:
example-1:
id: 4
name: メッシ
properties:
id:
type: integer
name:
type: string
icon:
type: string
required:
- id
- name
- icon
challenge-record:
title: challenge-record
type: object
description: ''
x-examples:
example-1:
id: 1
content: url
comment: 挑戦してみました！
user:
id: 4
name: メッシ
record: 30
fav_count: 156
created_at: '2020-05-03 16:06:52'
properties:
id:
type: integer
content:
type: string
format: uri
comment:
type: string
user:
$ref: '#/components/schemas/user'
record:
type: number
created_at:
type: string
format: date-time
fav_count:
type: integer
required:
- id
- content
- comment
- user
- record
- created_at
tag:
title: tag
type: object
properties:
id:
type: integer
text:
type: string
required:
- id
- text