Repository navigation
Expand file tree
/
Copy pathddocs-api.yaml
More file actions
681 lines (681 loc) · 17.1 KB
/
Copy pathddocs-api.yaml
File metadata and controls
681 lines (681 loc) · 17.1 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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
openapi: 3.1.0
info:
title: DDocs API
version: '1.0'
servers:
- url: 'https://api.ddocs.io'
description: Main site
paths:
/auth/login:
get:
summary: Login
tags: []
responses:
'200':
description: The authentication was successful
headers:
Set-Cookie:
schema:
type: string
description: The refresh cookie with the name r_
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: The JWT Token
'400':
description: 'The `code` parameter couldn''t be validated '
operationId: get-auth-login
description: Accepts a Discord OAuth code and creates a new jwt session and refresh token for the user
parameters:
- schema:
type: string
in: query
name: code
description: The discord OAuth code
parameters: []
/auth/refresh:
get:
summary: Refresh
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: The new JWT token
'400':
description: |
This can happen for multiple reasons:
- The JWT token used for this request was still valid.
- The refresh token provided was invalid.
'401':
description: No refresh token was provided.
operationId: get-auth-refresh
description: Refreshes a JWT token
parameters:
- schema:
type: string
in: header
name: Cookie
description: The provided r_ cookie to refresh with
/users/@me:
get:
summary: Get current user
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
examples:
example-1:
value:
id: '259053800755691520'
username: quin
discriminator: '3017'
avatar: 'https://cdn.discordapp.com/avatars/259053800755691520/1b1a1c1a62756406ebb3319138e08d4b.png?size=128'
isAuthor: true
'401':
description: 'Unauthorized: refresh your token'
'403':
description: 'Forbidden: The discord oauth is no longer valid, please sign in again.'
'404':
description: The user was not found? treat as 403
operationId: get-users-@me
description: Gets the current user
security:
- JWT: []
/events:
get:
summary: GET Events
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Event'
operationId: get-events
description: Gets a collection of events within a specific year
parameters:
- schema:
type: string
in: query
name: year
description: The year to fetch the events from
- schema:
type: string
in: query
name: search
description: Returns events based off of a string search
'/event/{eventId}':
parameters:
- schema:
type: string
name: eventId
in: path
required: true
description: The ID of the event to get
get:
summary: GET Event
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
'404':
description: Not Found
'500':
description: Internal Server Error
operationId: get-event-eventId
description: Gets an event based off of the id supplied
/assets:
post:
summary: Create asset
operationId: post-assets
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
format:
type: string
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
description: Creates a site asset and thumbnail image
security:
- JWT: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
content:
type: string
format: binary
examples: {}
description: The form content for the asset
'/assets/{id}':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: The id of the asset to fetch
get:
summary: Get asset
tags: []
responses:
'200':
description: OK
content:
image/jpeg:
schema:
type: object
properties: {}
examples: {}
image/png:
schema:
type: object
properties: {}
'400':
description: Bad Request
'404':
description: Not Found
operationId: get-assets-id
description: Gets an asset
'/assets/{id}.thumb':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: The id of the assets thumbnail to fetch
get:
summary: Get asset thumbnail
tags: []
responses:
'200':
description: OK
content:
image/jpeg:
schema:
type: object
properties: {}
image/png:
schema:
type: object
properties: {}
'400':
description: Bad Request
'404':
description: Not Found
operationId: get-assets-id-.thumb
description: 'Gets an assets thumbnail, this is only applicable to user generated content. Avatars don''t have thumbnails.'
/drafts:
get:
summary: Get all drafts
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Draft'
'401':
description: Unauthorized
'403':
description: Forbidden
operationId: get-drafts
description: Gets all the current drafts
security:
- JWT: []
post:
summary: Create draft
operationId: post-drafts
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Draft'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
requestBody:
$ref: '#/components/requestBodies/CreateDraft'
security:
- JWT: []
description: Creates a draft
'/drafts/{id}':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: 'The id of the draft '
get:
summary: Get draft
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Draft'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
operationId: get-drafts-id
security:
- JWT: []
description: Gets a draft
patch:
summary: Modify draft
operationId: patch-drafts-id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Draft'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: 'Modifies a draft, all json properties are optional.'
security:
- JWT: []
requestBody:
$ref: '#/components/requestBodies/CreateDraft'
'/drafts/{id}/summaries':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: The id of the draft
post:
summary: Create summary
operationId: post-drafts-id-summaries
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Draft'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: Creates a new summary for this draft
requestBody:
$ref: '#/components/requestBodies/CreateSummary'
security:
- JWT: []
'/drafts/{id}/summaries/{summary.id}':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: The draft id
- schema:
type: string
name: summary.id
in: path
required: true
description: The summary id
patch:
summary: Modify summary
operationId: patch-drafts-id-summaries-summary.id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Draft'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: 'Modifies this summary, all json properties are optional'
requestBody:
$ref: '#/components/requestBodies/CreateSummary'
delete:
summary: Delete summary
operationId: delete-drafts-id-summaries-summary.id
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Draft'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
description: Deletes this summary
'/events/{id}/related':
parameters:
- schema:
type: string
name: id
in: path
required: true
description: The id of the event to get related ones from
get:
summary: Get related events
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Event'
'400':
description: Bad Request
'404':
description: Not Found
operationId: get-events-id-related
description: Gets a collection of related events to the specified event
/socket:
get:
summary: Open websocket
tags: []
responses:
'101':
description: Switching Protocols
operationId: get-socket
description: Opens a websocket
components:
schemas:
User:
title: User
type: object
properties:
id:
type: string
username:
type: string
discriminator:
type: string
avatar:
type: string
isAuthor:
type: boolean
PartialEvent:
title: Partial event
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
thumbnail:
type: string
heldAt:
type: string
description: ISO8601 datetime
description: A partial event
Event:
description: ''
type: object
x-examples:
example-1:
author:
Username: quin
Discriminator: '3017'
UserId: '259053800755691520'
Avatar: 'https://cdn.discordapp.com/avatars/259053800755691520/1b1a1c1a62756406ebb3319138e08d4b.png?size=128'
contributors: []
summaries:
- id: 9d9c1a6ad69c4b5598e77a00bc9f369e
title: Test title
content: Test content
type: qnaanswer
isNew: true
thumbnail: null
featureType: null
id: 9587372f767141499a7d94e7a9bee01d
title: Test
description: Test desc
thumbnail: null
heldAt: '2022-02-01T18:29:48.793764+00:00'
properties:
author:
$ref: '#/components/schemas/Author'
contributors:
type: array
items:
$ref: '#/components/schemas/Author'
summaries:
type: array
uniqueItems: true
minItems: 1
items:
$ref: '#/components/schemas/Summary'
id:
type: string
minLength: 1
title:
type: string
minLength: 1
description:
type:
- string
- 'null'
minLength: 1
thumbnail:
type:
- string
- 'null'
heldAt:
type: string
minLength: 1
required:
- author
- contributors
- summaries
- id
- title
- description
- heldAt
Author:
description: An author on a summary or event
type: object
properties:
username:
type: string
minLength: 1
discriminator:
type: string
minLength: 1
id:
type: string
minLength: 1
avatar:
type: string
minLength: 1
required:
- username
- discriminator
- id
- avatar
x-examples:
example-1:
username: quin
discriminator: '3017'
id: '259053800755691520'
avatar: 'https://cdn.discordapp.com/avatars/259053800755691520/1b1a1c1a62756406ebb3319138e08d4b.png?size=128'
Summary:
description: ''
type: object
x-examples:
example-1:
id: 9d9c1a6ad69c4b5598e77a00bc9f369e
title: Test title
content: Test content
type: qnaanswer
isNew: true
thumbnail: null
featureType: null
properties:
id:
type: string
minLength: 1
title:
type: string
minLength: 1
content:
type: string
minLength: 1
type:
type: string
minLength: 1
isNew:
type: boolean
thumbnail:
type:
- 'null'
- string
featureType:
type:
- string
- 'null'
required:
- id
- title
- content
- type
- isNew
Draft:
title: Draft
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
heldAt:
type: string
author:
$ref: '#/components/schemas/Author'
contributors:
type: array
items:
$ref: '#/components/schemas/Author'
thumbnail:
type: string
summaries:
type: array
items:
$ref: '#/components/schemas/Summary'
securitySchemes:
JWT:
type: http
scheme: bearer
requestBodies:
CreateDraft:
content:
application/json:
schema:
type: object
properties:
heldAt:
type: string
title:
type: string
description:
type: string
thumbnail:
type: string
description: The model for creating a draft
CreateSummary:
content:
application/json:
schema:
type: object
properties:
title:
type: string
content:
type: string
type:
type: string
isNew:
type: string
featureType:
type:
- string
- 'null'