-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi.yaml
958 lines (953 loc) · 32.5 KB
/
openapi.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
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
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
openapi: "3.1.0"
info:
version: 0.1.0
title: Unofficial Devpost API
description: In progress - nothing is hosted yet. Working on docs before the actual code
license:
name: MIT
url: https://opensource.org/licenses/MIT
contact:
name: "@thegu5 on discord"
tags:
- name: "Software"
description: "Routes for software (projects), prefixed with /software"
- name: "User"
description: "Routes for users, prefixed with /user"
- name: "Hackathon"
description: "Routes for hackathons, prefixed with /hackathon"
servers:
- url: https://devpost.gu5.org
security: [] # In the future, the api user could provide their own token for participant lists, (maybe)
paths:
/software/{software}:
get:
summary: Software
operationId: getSoftware
description: This route won't automatically grab usernames of people who've liked the project or all of its updates - use the /software/{software}/likes and /software/{software}/updates routes for that.
tags:
- Software
parameters:
- $ref: "#/components/parameters/Software"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The software's name
minLength: 1
maxLength: 60
tagline:
type: string
description: A short description of the software
minLength: 1
maxLength: 200
description:
type: string
description: The software's description
minLength: 1
createdAt:
type: string
description: The software's creation date
format: date-time
slug:
type: string
description: The software's URI slug
members:
type: array
description: Array of software member objects
items:
allOf:
- $ref: "#/components/schemas/UserCard"
- properties:
contributions:
type: [string, "null"]
description: The member's contributions to the software
bio:
type: [string, "null"]
description: The member's bio
maxLength: 140
tags:
type: array
description: Array of tag strings
items:
type: string
minLength: 1
links:
type: array
description: An array of link URLs
items:
type: string
minLength: 1
maxLength: 255
hackathons:
type: array
description: Array of hackathon submissions
items:
allOf:
- $ref: "#/components/schemas/HackathonCard"
- properties:
prizes:
type: [array, "null"]
description: Array of prizes
items:
type: string
video:
type: [string, "null"]
description: The software's video URL
carousel:
type: [array, "null"]
description: Array of carousel item data
items:
type: object
properties:
url:
type: string
description: The carousel image's URL
caption:
type: [string, "null"]
description: The carousel image's caption
maxLength: 140
# updates: TODO
stats:
type: object
description: Software statistics
properties:
likes:
type: integer
description: Number of likes
minimum: 0
comments:
type: integer
description: Number of comments
minimum: 0
updates:
type: integer
description: Number of updates
minimum: 0
"404":
$ref: "#/components/responses/NotFound"
/software/{software}/likes:
get:
summary: Software Likes
operationId: getSoftwareLikes
description: Gets a list of users who've liked a software.
tags:
- Software
parameters:
- $ref: "#/components/parameters/Software"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/UserCard"
"404":
$ref: "#/components/responses/NotFound"
/user/{user}:
get:
summary: User
operationId: getUser
description: Gets information about a user. Follows software pagination, and can get software hidden from their profile.
tags:
- User
parameters:
- $ref: "#/components/parameters/User"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The user's full name
minLength: 3
maxLength: 81
bio:
type: [string, "null"]
description: The user's bio
maxLength: 140
avatar:
type: string
description: A link to the user's avatar (can be a github/other platform cdn)
banner:
type: [string, "null"]
description: A link to the user's banner image (null if not set)
bannerColor:
type: [string]
description: The user's banner color (#000000 if using a banner image)
pattern: "^#[A-Fa-f0-9]{6}"
minLength: 7
maxLength: 7
external:
type: object
description: External links + user-specified location.
properties:
website:
type: [string, "null"]
description: The user's website URL
github:
type: [string, "null"]
description: The user's GitHub profile URL
twitter:
type: [string, "null"]
description: The user's Twitter profile URL
linkedin:
type: [string, "null"]
description: The user's LinkedIn profile URL
skills:
type: [array, "null"]
description: Array of skills
items:
type: string
minimum: 1
interests:
type: [array, "null"]
description: Array of interests
items:
$ref: "#/components/schemas/HackathonTags"
stats:
type: object
description: User statistics for various categories
properties:
projects:
type: integer
description: Number of projects
minimum: 0
hackathons:
type: integer
description: Number of hackathons
minimum: 0
achievements:
type: integer
description: Number of achievements
minimum: 0
followers:
type: integer
description: Number of followers
minimum: 0
following:
type: integer
description: Number of people the user is following
minimum: 0
likes:
type: integer
description: Number of projects the user has liked
minimum: 0
projects:
type: [array, "null"]
items:
allOf:
- $ref: "#/components/schemas/ProjectCard"
- properties:
featured:
type: boolean
description: Whether the project is was featured by the user (yellow star on profile)
"404":
$ref: "#/components/responses/NotFound"
/user/{user}/challenges:
get:
summary: User Challenges
operationId: getUserChallenges
description: Gets a list of hackathons (sometimes called 'challenges' internally) a user has participated in and the project's status. Endpoint is 'challenges' to follow Devpost's urls.
tags:
- User
parameters:
- $ref: "#/components/parameters/User"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/HackathonCard"
- properties:
featured:
type: boolean
description: Whether the hackathon is featured
status:
type: [string, "null"]
description: The project's status
enum:
- null # no project
- "Draft"
- "Submitted"
- "Winner"
"404":
$ref: "#/components/responses/NotFound"
/user/{user}/achievements:
get:
summary: User Achievements
operationId: getUserAchievements
description: Gets a list of achievements a user has earned.
tags:
- User
parameters:
- $ref: "#/components/parameters/User"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
minProperties: 1
maxProperties: 10
properties:
name:
type: string
description: The achievement's name
description:
type: string
description: The achievement's description
image:
type: string
description: The achievement's image URL
date:
type: string
description: The date the achievement was earned
"404":
$ref: "#/components/responses/NotFound"
/user/{user}/followers:
get:
summary: User Followers
operationId: getUserFollowers
description: Gets a list of users following a user. Contains advanced user card objects.
tags:
- User
parameters:
- $ref: "#/components/parameters/User"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/AdvancedUserCard"
"404":
$ref: "#/components/responses/NotFound"
/user/{user}/following:
get:
summary: User Following
operationId: getUserFollowing
description: Gets a list of users a user is following. Contains advanced user card objects.
tags:
- User
parameters:
- $ref: "#/components/parameters/User"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/AdvancedUserCard"
"404":
$ref: "#/components/responses/NotFound"
/user/{user}/likes:
get:
summary: User Likes
operationId: getUserLikes
description: Gets a list of projects a user has liked. Contains project card objects.
tags:
- User
parameters:
- $ref: "#/components/parameters/User"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ProjectCard"
"404":
$ref: "#/components/responses/NotFound"
/hackathon/{hackathon}:
get:
summary: Hackathon
operationId: getHackathon
description: Gets information about a hackathon.
tags:
- Hackathon
parameters:
- $ref: "#/components/parameters/Hackathon"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The hackathon's official name
shortDescription:
type: string
description: The hackathon's short description
description:
type: string
description: The hackathon's (long) description
banner:
type: [string, "null"]
description: A link to the hackathon's banner image (null if not set)
bannerColor:
type: string
description: The hackathon's banner color (#000000 if using a banner image)
pattern: "^#[A-Fa-f0-9]{6}"
minLength: 7
maxLength: 7
time:
type: [string, "null"]
description: Range of time the hackathon takes place
location:
type: string
description: The hackathon's location
address:
type: [string, "null"]
description: The address of the hackathon's location (null if online)
availability:
type: string
description: The hackathon's availability
enum:
- "Public"
- "Invite only"
prizeTotal:
type: integer
description: The hackathon's current available prize money
participantCount:
type: integer
description: The number of participants in the hackathon
tags:
type: [array, "null"]
description: Array of interest tags
items:
$ref: "#/components/schemas/HackathonTags"
requirementText:
type: [string, "null"]
description: The hackathon's requirement text block
requirements:
type: [string, "null"]
description: The "who can participate" list
prizes:
type: array
description: Array containing every prize for the hackathon
items:
type: object
description: Names of the prizes in the hackathon
properties:
name:
type: string
description: The name of the prize
description:
type: string
description: The description of the prize
judges:
type: array
description: Array containing every judge for the hackathon
items:
type: object
description: Names of the judges in the hackathon
minimum: 1
properties:
name:
type: string
description: The name of the judge
avatar:
type: string
description: The judge's avatar URL
judgingCriteria:
type: [string, "null"]
description: The hackathon's judging criteria text block
"404":
$ref: "#/components/responses/NotFound"
/hackathon/{hackathon}/participants:
get:
summary: Hackathon Participants
operationId: getHackathonParticipants
description: Gets a list of participants in a hackathon. Contains extended user card objects.
tags:
- Hackathon
parameters:
- $ref: "#/components/parameters/Hackathon"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/UserCard"
- properties:
stats:
type: object
description: The user's stats
properties:
projects:
type: integer
description: The number of projects the user has created
followers:
type: integer
description: The number of users following the user
achievements:
type: integer
description: The number of achievements the user has earned
specialty:
type: [string, "null"]
description: The user's specialty
skills:
type: [array, "null"]
description: Array of skills the user has
items:
type: string
description: A skill the user has
interests:
type: [array, "null"]
description: Array of interests the user has
items:
$ref: "#/components/schemas/HackathonTags"
teamStatus:
type: [string, "null"]
description: The participants's team status
enum:
- "Has a team"
- "Working solo"
- "Looking for a team"
"404":
$ref: "#/components/responses/NotFound"
"501":
description: Server-side access token not provided
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error message
"503":
description: Server-side access token expired
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error message
/hackathon/{hackathon}/rules:
get:
summary: Hackathon Rules
operationId: getHackathonRules
description: Gets a markdown string containing the rules for a hackathon
tags:
- Hackathon
parameters:
- $ref: "#/components/parameters/Hackathon"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
properties:
rules:
type: string
description: The hackathon's rules
"404":
$ref: "#/components/responses/NotFound"
/hackathon/{hackathon}/project-gallery:
get:
summary: Hackathon Project Gallery
operationId: getHackathonProjectGallery
description: Gets a list of projects in a hackathon's project gallery. Contains project card objects.
tags:
- Hackathon
parameters:
- $ref: "#/components/parameters/Hackathon"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ProjectCard"
"404":
$ref: "#/components/responses/NotFound"
/hackathon/{hackathon}/updates:
get:
summary: Hackathon Updates
operationId: getHackathonUpdates
description: Gets an array of updates for a hackathon
tags:
- Hackathon
parameters:
- $ref: "#/components/parameters/Hackathon"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
time:
type: string
description: Relative time of the update
title:
type: string
description: The update's title
url:
type: string
description: The update's url
slug:
type: string
description: The update's URI slug
contentPreview:
type: string
description: Beginning of the update's content, in html (full can be found at /hackathon/{hackathon}/updates/{update})
"404":
$ref: "#/components/responses/NotFound"
/hackathon/{hackathon}/updates/{update}:
get:
summary: Hackathon Update Details
operationId: getHackathonUpdateDetails
description: Gets information about a hackathon update
tags:
- Hackathon
parameters:
- $ref: "#/components/parameters/Hackathon"
- name: update
in: path
description: The update's URI slug
required: true
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
properties:
time:
type: string
description: Relative time of the update
title:
type: string
description: The update's title
slug:
type: string
description: The update's URI slug
content:
type: string
description: The update's content
"404":
$ref: "#/components/responses/NotFound"
/hackathon/{hackathon}/forum_topics:
get:
summary: Hackathon Forum Topics
operationId: getHackathonForumTopics
description: Gets an array of forum topics for a hackathon
tags:
- Hackathon
parameters:
- $ref: "#/components/parameters/Hackathon"
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
type: object
properties:
title:
type: string
description: Title of the forum topic
replies:
type: integer
description: Number of replies to a forum topic
slug:
type: string
description: The topic's URI slug
id:
type: integer
description: The topic's ID
minimum: 1
"404":
$ref: "#/components/responses/NotFound"
/hackathon/{hackathon}/forum_topics/{topic}:
get:
summary: Hackathon Forum Topic Details
operationId: getHackathonForumTopicDetails
description: Gets details of a hackathon's forum topic
tags:
- Hackathon
parameters:
- $ref: "#/components/parameters/Hackathon"
- name: topic
in: path
description: The topic's URI slug
required: true
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/Reply"
- type: object
properties:
title:
type: string
description: Title of the forum topic
replies:
type: [array, "null"]
description: Array of replies to the forum topic
items:
$ref: "#/components/schemas/Reply"
"404":
$ref: "#/components/responses/NotFound"
/software/{software}/updates:
get:
summary: Software Updates
operationId: getSoftwareUpdates
description: Gets an array of updates and replies on a software
parameters:
- $ref: "#/components/parameters/Software"
tags:
- Software
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: array
items:
allOf:
- $ref: "#/components/schemas/Reply"
- properties:
replies:
type: array
items:
$ref: "#/components/schemas/Reply"
"404":
$ref: "#/components/responses/NotFound"
components:
responses:
NotFound:
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Error message
parameters:
User:
name: user
in: path
description: The user's username
required: true
schema:
type: string
Software:
name: software
in: path
description: The software's URI slug
required: true
schema:
type: string
Hackathon:
name: hackathon
in: path
description: The hackathon's URL slug
required: true
schema:
type: string
schemas:
Reply:
type: object
properties:
author:
allOf:
- $ref: "#/components/schemas/UserCard"
- type: object
properties:
manager:
type: boolean
description: Whether the user is a manager of the hackathon
time:
type: string
description: Relative time (or datetime string) of the forum reply's creation
content:
type: string
description: Content of the forum reply
HackathonTags:
type: string
description: Hackathon tags (interests)
enum:
- "AR/VR"
- "Communication"
- "Design"
- "Education"
- "Gaming"
- "Lifehacks"
- "Mobile"
- "Productivity"
- "Social Good"
- "Beginner Friendly"
- "Cybersecurity"
- "DevOps"
- "Enterprise"
- "Health"
- "Low/No Code"
- "Music/Art"
- "Quantum"
- "Voice skills"
- "Blockchain"
- "Databases"
- "E-commerce/Retail"
- "Fintech"
- "IoT"
- "Machine Learning/AI"
- "Open Ended"
- "Robotic Process Automation"
- "Web"
UserCard:
type: object
description: Short user information provided outside of the user's profile
properties:
name:
type: string
description: The member's name
username:
type: [string, "null"]
description: The member's username
url:
type: [string, "null"]
description: The member's profile URL
avatar:
type: string
description: The member's avatar URL
AdvancedUserCard:
allOf:
- $ref: "#/components/schemas/UserCard"
- type: object
properties:
bannerColor:
type: string
description: The user card's banner color (hex code)
pattern: "^#[A-Fa-f0-9]{6}"
minimum: 7
maximum: 7
stats:
type: object
description: User statistics for various categories
properties:
projects:
type: integer
description: Number of projects
minimum: 0
hackathons:
type: integer
description: Number of hackathons
minimum: 0
followers:
type: integer
description: Number of followers
minimum: 0
achievements:
type: integer
description: Number of achievements
minimum: 0
bio:
type: [string, "null"]
description: The user's bio
maxLength: 140
HackathonCard:
type: object
description: Short hackathon information
properties:
name:
type: string
description: The hackathon's name
slug:
type: string
description: The hackathon's URL slug (subdomain!)
url:
type: string
description: The hackathon's URL
thumbnail:
type: string
description: The hackathon's thumbnail URL
ProjectCard:
type: object
properties:
name:
type: string
description: The project's name
tagline:
type: string
description: The project's tagline
photo:
type: string
description: The project's thumbnail URL
slug:
type: string
description: The project's URL slug
url:
type: string
description: The project's URL
members:
type: array
items:
$ref: "#/components/schemas/UserCard"
like_count:
type: integer
description: Number of likes
minimum: 0
comment_count:
type: integer
description: Number of comments
minimum: 0
winner:
type: boolean
description: Whether the project won a hackathon or not