-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathopenapi.yml
1134 lines (1068 loc) · 31.1 KB
/
openapi.yml
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
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: "3.1.0"
info:
title: Geode Index
description: Documentation for the Geode Index API
version: "1.0.0"
servers:
- url: https://api.geode-sdk.org/
tags:
- name: mods
description: Access to Index mods
- name: user
description: User management
paths:
/:
get:
summary: Health check
description: Returns a 200 OK if the index is up and running
responses:
"200":
description: OK
/v1/login/github:
post:
tags:
- user
summary: Login with GitHub OAuth
description: This endpoint is used to login with GitHub OAuth. It returns a UUID which is used for authentication.
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
error:
type: "null"
payload:
type: object
properties:
uuid:
type: string
description: The UUID used to identify the login attempt at POST /v1/login/github/poll
example: "a1b2c3d4-1234-5678-9abc-1234567890ab"
interval:
type: integer
description: The interval in seconds to poll the server for the login status
example: 5
uri:
type: string
description: The GitHub URI for OAuth verification
example: "https://github.com/login/device"
code:
type: string
description: The code used to complete the OAuth process
example: "ABCD-EFGH"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/login/github/poll:
post:
tags:
- user
summary: Poll the server for the login status
description: Used to poll the API for the OAuth status. Returns a token if the login was successful.
requestBody:
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
description: The UUID used to identify the login attempt, taken from POST /v1/login/github
example: "a1b2c3d4-1234-5678-9abc-1234567890ab"
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
error:
type: "null"
payload:
type: string
description: The token used for authentication
example: "a1b2c3d4-1234-5678-9abc-1234567890ab"
"400":
description: Bad request - for different reasons, like IP mismatch, interval not being respected, etc.
content:
application/json:
schema:
type: object
properties:
error:
type: string
payload:
type: "null"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/login/github/token:
post:
tags:
- user
summary: Login with GitHub access token
description: Log in immediately with a GitHub access token. Returns a token if the login was successful.
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: The access token from GitHub
example: "ghp_1234567890abcdefgh"
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
error:
type: "null"
payload:
type: object
properties:
type: string
description: The Geode token used for authentication
example: "a1b2c3d4-1234-5678-9abc-1234567890ab"
"400":
description: Bad request - invalid access token.
content:
application/json:
schema:
type: object
properties:
error:
type: string
payload:
type: "null"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods:
get:
tags:
- mods
summary: Search all mods, paginated
description: Returns a list of mods, paginated. Does not include about.md and changelog.md. Does not include dependencies and incompatibilities.
parameters:
- name: query
in: query
description: Search query
schema:
type: string
- name: gd
in: query
description: Geometry Dash version
required: true
schema:
$ref: "#/components/schemas/GDVersionString"
- name: platforms
in: query
description: Platforms that mods have to support, comma separated [win,android32,android64,mac,ios]
example: "win,android32,android64"
schema:
type: string
- name: tags
in: query
description: Tags that mods have to have, comma separated. Can only use allowed tags.
example: "gameplay,enhancement"
schema:
type: string
- name: featured
in: query
description: Filter by featured mods
schema:
type: boolean
- name: sort
in: query
description: Sort by a specific enum field, in descending order. Default is "downloads"
example: "downloads"
schema:
type: enum
enum:
- downloads
- recently_updated
- recently_published
- name: developer
in: query
description: Filter by developer username
schema:
type: string
- name: status
in: query
description: Filter by mod version status (rejected is admin only)
schema:
$ref: "#/components/schemas/ModVersionStatus"
- name: pending_validation
in: query
description: Filter by pending validation status (admin only)
schema:
type: boolean
- $ref: "#/components/parameters/GeodeVersionQuery"
- $ref: "#/components/parameters/Page"
- $ref: "#/components/parameters/PerPage"
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Mod"
"500":
$ref: "#/components/responses/InternalServerError"
post:
tags:
- mods
summary: Create a new mod
description: This endpoint is only used for adding a new mod. For creating a new version, use the POST /mods/{id}/versions endpoint.
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
download_link:
type: string
description: The download URL for the .geode file. You can use a Github Release for this.
examples:
- "https://github.com/geode-sdk/NodeIDs/releases/download/v1.0.0/geode.node-ids.geode"
- "https://github.com/geode-sdk/DevTools/releases/download/v1.3.0/geode.devtools.geode"
responses:
"204":
description: No Content (Mod created)
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods/{id}:
get:
tags:
- mods
summary: Get info for a mod
description: Returns info for the mod, without dependencies and incompatibilities.
parameters:
- $ref: "#/components/parameters/ModID"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Mod"
"404":
$ref: "#/components/responses/NotFoundError"
"500":
$ref: "#/components/responses/InternalServerError"
put:
tags:
- mods
summary: Update a mod (admin only)
description: At the moment it's only used to set a mod to featured / not featured
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
featured:
type: boolean
description: Whether the mod should be featured or not
example: true
parameters:
- $ref: "#/components/parameters/ModID"
responses:
"204":
description: No Content (Mod updated)
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/ForbiddenError"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods/{id}/logo:
get:
tags:
- mods
summary: Get the logo for a mod
description: Returns the logo for the mod
parameters:
- $ref: "#/components/parameters/ModID"
responses:
"200":
description: Returns the mod logo
content:
image/png:
schema:
type: string
format: binary
"404":
$ref: "#/components/responses/NotFoundError"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods/{id}/versions/latest:
get:
tags:
- mods
summary: Get info for the latest version of a mod
description: Returns info for the current latest approved version of the mod
parameters:
- $ref: "#/components/parameters/ModID"
- $ref: "#/components/parameters/Platforms"
- name: gd
in: query
description: Geometry Dash version
schema:
$ref: "#/components/schemas/GDVersionString"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ModVersion"
/v1/mods/{id}/versions:
post:
tags:
- mods
summary: Create a new version of a mod
description: This endpoint is only used for adding a new version of a mod. For creating a new mod, use the POST /mods endpoint.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/ModID"
requestBody:
content:
application/json:
schema:
type: object
properties:
download_link:
type: string
description: The download URL for the .geode file. You can use a Github Release for this.
examples:
- "https://github.com/geode-sdk/NodeIDs/releases/download/v1.0.0/geode.node-ids.geode"
responses:
"204":
description: No Content (Mod version created)
"400":
$ref: "#/components/responses/BadRequest"
"404":
$ref: "#/components/responses/NotFoundError"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods/{id}/versions/{version}:
get:
tags:
- mods
summary: Get info for a specific version of a mod
parameters:
- $ref: "#/components/parameters/ModID"
- $ref: "#/components/parameters/ModVersion"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ModVersion"
"404":
$ref: "#/components/responses/NotFoundError"
"500":
$ref: "#/components/responses/InternalServerError"
put:
tags:
- mods
summary: Update a specific version of a mod (admin only)
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/ModID"
- $ref: "#/components/parameters/ModVersion"
requestBody:
content:
application/json:
schema:
type: object
properties:
status:
$ref: "#/components/schemas/ModVersionStatus"
info:
required: false
type: string
description: "Extra information about why that status was picked"
responses:
"204":
description: No Content (Mod updated)
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/ForbiddenError"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods/{id}/versions/{version}/download:
get:
tags:
- mods
summary: Download a specific version of a mod
parameters:
- $ref: "#/components/parameters/ModID"
- $ref: "#/components/parameters/ModVersion"
responses:
"302":
description: Redirect to the actual mod download link
"404":
$ref: "#/components/responses/NotFoundError"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods/{id}/versions/latest/download:
get:
tags:
- mods
summary: Download the latest available version of a mod
parameters:
- $ref: "#/components/parameters/ModID"
responses:
"302":
description: Redirect to the actual mod download link
"404":
$ref: "#/components/responses/NotFoundError"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods/updates:
get:
tags:
- mods
summary: Get available mod updates
description: Gets latest versions of the requested mods
parameters:
- name: platform
in: query
required: false
schema:
$ref: "#/components/schemas/Platform"
- name: ids
in: query
required: true
schema:
type: string
description: Semicolon separated list of mod IDs
example: "geode.devtools;geode.nodeids"
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
error:
type: "null"
payload:
type: array
items: "#/components/schemas/ModUpdate"
/v1/mods/{id}/developers:
post:
tags:
- mods
summary: Add a developer to a mod
description: This endpoint is only used for adding a developer to a mod. Must be the owner the mod to access this endpoint.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/ModID"
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: The username of the developer. At the moment it's the same as the GitHub username of the developer.
example: "fleeym"
responses:
"204":
description: No Content (Developer added)
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/mods/{id}/developers/{username}:
delete:
tags:
- mods
summary: Remove a developer from a mod
description: This endpoint is only used for removing a developer from a mod. Must be the owner the mod to access this endpoint.
security:
- bearerAuth: []
parameters:
- $ref: "#/components/parameters/ModID"
- name: username
in: path
required: true
schema:
type: string
example: "fleeym"
responses:
"204":
description: No Content (Developer removed)
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/me:
get:
tags:
- user
summary: Get your own info
security:
- bearerAuth: []
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/DeveloperProfile"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
put:
tags:
- user
summary: Update your own info (just display name at the moment)
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
display_name:
type: string
example: "Flame"
responses:
"204":
description: No Content (User updated)
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/me/mods:
get:
tags:
- user
summary: Get your own mods
parameters:
- name: validated
in: query
description: Filter by validation status
schema:
type: boolean
required: false
security:
- bearerAuth: []
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: ""
payload:
type: array
items:
$ref: "#/components/schemas/DeveloperMod"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/me/token:
delete:
tags:
- user
summary: Revoke current token
security:
- bearerAuth: []
responses:
"204":
description: No Content (Token revoked)
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/me/tokens:
delete:
tags:
- user
summary: Revoke all tokens
security:
- bearerAuth: []
responses:
"204":
description: No Content (Tokens revoked)
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: uuid
schemas:
ModID:
type: string
pattern: '[a-z0-9_\-]+\.[a-z0-9_\-]+'
description: Mod ID
examples:
- geode.devtools
- mat.circle-tool
ModVersionString:
type: string
pattern: '^v?\d+\.\d+\.\d+(?:-.+)?$'
examples:
- "v1.0.0"
- "v2.3.4"
- "1.3.0"
- "v1.0.0-beta"
GDVersionString:
type: string
examples:
- "2.200"
- "2.204"
- "2.205"
GDVersionObject:
type: object
properties:
win:
anyOf:
- type: "null"
- $ref: "#/components/schemas/GDVersionString"
mac:
oneOf:
- type: "null"
- $ref: "#/components/schemas/GDVersionString"
ios:
oneOf:
- type: "null"
- $ref: "#/components/schemas/GDVersionString"
android32:
oneOf:
- type: "null"
- $ref: "#/components/schemas/GDVersionString"
android64:
oneOf:
- type: "null"
- $ref: "#/components/schemas/GDVersionString"
ModUpdate:
type: object
properties:
id:
$ref: "#/components/schemas/ModID"
version:
$ref: "#/components/schemas/ModVersionString"
download_link:
type: string
examples:
- "https://api.geode-sdk.com/v1/mods/geode.nodeids/versions/1.0.0/download"
- "https://api.geode-sdk.com/v1/mods/geode.devtools/versions/1.0.0/download"
replacement:
oneOf:
- "null"
- $ref: "#/components/schemas/ModReplacement"
dependencies:
type: array
items:
$ref: "#/components/schemas/ModDependency"
incompatibilities:
type: array
items:
$ref: "#/components/schemas/ModIncompatibility"
ModReplacement:
type: object
properties:
id:
$ref: "#/components/schemas/ModID"
version:
$ref: "#/components/schemas/ModVersionString"
download_link:
type: string
examples:
- "https://api.geode-sdk.com/v1/mods/geode.nodeids/versions/1.0.0/download"
- "https://api.geode-sdk.com/v1/mods/geode.devtools/versions/1.0.0/download"
dependencies:
type: array
items:
$ref: "#/components/schemas/ModDependency"
incompatibilities:
type: array
items:
$ref: "#/components/schemas/ModIncompatibility"
ModDependency:
type: object
properties:
mod_id:
$ref: "#/components/schemas/ModID"
version:
type: string
examples:
- ">1.0.0"
- "*"
- "<=2.0.0"
importance:
$ref: "#/components/schemas/DependencyImportance"
ModIncompatibility:
type: object
properties:
mod_id:
$ref: "#/components/schemas/ModID"
version:
type: string
examples:
- ">1.0.0"
- "*"
- "<=2.0.0"
importance:
$ref: "#/components/schemas/IncompatibilityImportance"
Mod:
type: object
properties:
id:
$ref: "#/components/schemas/ModID"
repository:
oneOf:
- type: "null"
- type: string
examples:
- "https://github.com/geode-sdk/geode"
developers:
type: array
items:
$ref: "#/components/schemas/ModDeveloper"
download_count:
type: integer
tags:
type: array
items:
type: string
examples:
- "enhancement"
- "gameplay"
versions:
type: array
items:
$ref: "#/components/schemas/ModVersion"
about:
type: string
examples:
- "This mod adds bugfixes to the game"
changelog:
type: string
examples:
- "Fixed a bug with the mod"
required:
- id
ModVersion:
type: object
properties:
id:
type: integer
name:
type: string
examples:
- Devtools
download_count:
type: integer
description:
type: string
early_load:
type: boolean
api:
type: boolean
geode:
$ref: "#/components/schemas/ModVersionString"
version:
$ref: "#/components/schemas/ModVersionString"
download_link:
type: string
examples:
- "https://api.geode-sdk.com/v1/mods/geode.nodeids/versions/1.0.0/download"
- "https://api.geode-sdk.com/v1/mods/geode.devtools/versions/1.0.0/download"
hash:
type: string
description: This is generated serverside
examples:
- "3c8d6d3d48967758055a5569a24617c3e6fdc456fbf6a4adbf1222954e61b634"
gd:
description: The GD version the mod supports (can be specified per platform)
oneOf:
- $ref: "#/components/schemas/GDVersionString"
- $ref: "#/components/schemas/GDVersionObject"
tags:
type: array
items:
type: string
mod_id:
$ref: "#/components/schemas/ModID"
dependencies:
type: array
items:
$ref: "#/components/schemas/ModDependency"
incompatibilities:
type: array
items:
$ref: "#/components/schemas/ModIncompatibility"
ModVersionStatus:
type: string
enum:
- approved
- rejected
- pending
- unlisted
DependencyImportance:
type: string
enum:
- suggested
- recommended
- required
IncompatibilityImportance:
type: string
enum:
- breaking
- conflicting
- superseded
ModDeveloper:
type: object
properties:
id:
type: integer
username:
type: string
description: The username of the developer. At the moment it's the same as the GitHub username of the developer.
examples:
- fleeym
display_name:
type: string
examples:
- Flame
verified:
type: boolean,
description: Whether the developer can post mods without admin verification
examples:
- true
admin:
type: boolean,
description: Whether the developer is an admin (which can verify mods and developers)
examples:
- true
is_owner:
type: boolean,
description: Whether the developer is the owner of the mod
examples:
- true
DeveloperProfile:
type: object
properties:
id:
type: integer
username:
type: string
description: The username of the developer. At the moment it's the same as the GitHub username of the developer.
examples:
- fleeym
display_name:
type: string
examples:
- Flame
verified:
type: boolean,
description: Whether the developer can post mods without admin verification
examples:
- true
admin:
type: boolean,
description: Whether the developer is an admin (which can verify mods and developers)
examples:
- true
DeveloperMod:
type: object
properties:
id:
$ref: "#/components/schemas/ModID"
featured:
type: boolean
description: Whether the mod is featured or not
example: true
download_count:
type: integer
example: 500
versions:
type: array
items:
$ref: "#/components/schemas/DeveloperModVersion"
DeveloperModVersion:
type: object
properties:
name:
type: string