forked from Catrobat/Catroweb-API
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcatroweb.yaml
executable file
·1608 lines (1502 loc) · 43.7 KB
/
catroweb.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
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.0.2
info:
title: Catroweb API
description: API for the Catrobat Share Platform
version: "v1.0.55"
termsOfService: 'https://share.catrob.at/pocketcode/termsOfUse'
contact:
name: Catrobat
url: 'https://share.catrob.at'
email: [email protected]
servers:
- url: 'https://share.catrob.at/api'
description: Main production server
- url: 'https://web-test.catrob.at/api'
description: WEB test server (might be unstabe)
- url: 'https://catblocks.test.catrob.at/api'
description: Catblocks test server
- url: 'https://android.test.catrob.at/api'
description: Android test server
- url: 'http://localhost/api'
description: Local test server (postman help)
tags:
- name: Authentication
description: Everything related to authenticating to our project
- name: User
description: Everything related to users
- name: Projects
description: Everything related to projects
- name: Media Library
description: Everything related to the media library
- name: Utility
description: Utility frunctionality for infrastructure
- name: Notifications
description: Everything related for notifications
paths:
##############################################
# Authentication
###
/authentication:
get:
security:
- PandaAuth: []
tags:
- Authentication
summary: Check token
description: Checks if a token is valid or expired.
responses:
'200':
$ref: '#/components/responses/OK'
'401':
$ref: '#/components/responses/UnauthorizedError'
post:
security:
- PandaAuth: []
tags:
- Authentication
summary: Login
description: Returns an JWT token which provides authorization for a limited time.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/JWTResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/InvalidCredentials'
'406':
$ref: '#/components/responses/NotAcceptable'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
put:
security:
- PandaAuth: []
tags:
- Authentication
summary: Refresh token
description: Returns a new JWT token with help of the refresh token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RefreshRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/JWTResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/InvalidRefreshToken'
'406':
$ref: '#/components/responses/NotAcceptable'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
delete:
security:
- PandaAuth: [ ]
tags:
- Authentication
summary: Expires refresh token
description: Sets refresh token to expired
parameters:
- $ref: '#/components/parameters/RefreshToken'
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/InvalidRefreshToken'
'406':
$ref: '#/components/responses/NotAcceptable'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
/authentication/oauth:
post:
tags:
- Authentication
summary: OAuth Login
description: Returns an JWT token which provides authorization.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthLoginRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/JWTResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/InvalidIdToken'
'406':
$ref: '#/components/responses/NotAcceptable'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
422:
description: Unprocessable Entity
##############################################
# Utility
###
/health:
get:
tags:
- Utility
summary: Health Check
responses:
'204':
description: System is alive and healthy!
/survey/{lang_code}:
get:
parameters:
- in: path
name: lang_code
schema:
type: string
example: de
required: true
description: 2 letter Language-Code is based on ISO693-1 (e.g. German = de, English = en, Russian = ru)
tags:
- Utility
summary: Get survey link for given language code.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SurveyResponse'
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
##############################################
# User
###
/user:
get:
security:
- PandaAuth: []
tags:
- User
summary: Get your private user data
description: |
Get your private user data. Additionally to the public user data,
this responses contains all your private data like settings.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedUserDataResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/UnauthorizedError'
'406':
$ref: '#/components/responses/NotAcceptable'
post:
parameters:
- $ref: '#/components/parameters/Locale'
tags:
- User
summary: Register
description: |
Register a user. For pre-validation use the dry-run option.
Using Dry run the request is validated but no object is created on the server.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterRequest'
responses:
201:
description: User successfully registered
headers:
Location:
schema:
type: string
example: >-
https://share.catrob.at/app/user/3ef85528-5f08-11ea-a2ae-000c292a0f49
description: Resource location on server
content:
application/json:
schema:
$ref: '#/components/schemas/JWTResponse'
204:
description: 'Dry-run successful (No Validation Error)'
400:
$ref: '#/components/responses/BadRequest'
406:
$ref: '#/components/responses/NotAcceptable'
415:
$ref: '#/components/responses/UnsupportedMediaType'
422:
description: Unprocessable Entity (Specific error messages will be translated to the locale)
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterErrorResponse'
put:
parameters:
- $ref: '#/components/parameters/Locale'
security:
- PandaAuth: []
tags:
- User
summary: Update User
description: |
Update your user account. All attributes are optional.
For example you can update only the username.
Or you can update multiple attributes at once. E.g. username + email.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
responses:
'204':
description: User successfully updated
# Content hack necessary else OpenAPI-generator will ignore content for error responses (hopefully fixed sometime)
content:
application/json:
schema:
type: object
'401':
$ref: '#/components/responses/InvalidCredentials'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
description: Unprocessable Entity. (Specific error messages will be translated to the locale)
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserErrorResponse'
delete:
security:
- PandaAuth: [ ]
tags:
- User
summary: Delete user account
description: Delete your user account. But be warned, there is no way to restore the user data!
responses:
'204':
description: User successfully deleted.
'401':
$ref: '#/components/responses/UnauthorizedError'
/user/{id}:
get:
tags:
- User
summary: Get public user data
description: Get all the public data of a user.
parameters:
- $ref: '#/components/parameters/Uuid'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/BasicUserDataResponse'
'404':
$ref: '#/components/responses/NotFound'
'406':
$ref: '#/components/responses/NotAcceptable'
/users/search:
get:
tags:
- User
summary: Search for users
description: Search for users associated by keywords.
parameters:
- name: query
in: query
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UsersDataResponse'
'400':
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'
################################################
# Projects
#
/projects:
parameters:
- $ref: '#/components/parameters/Locale'
get:
tags:
- Projects
summary: Get projects
parameters:
- $ref: '#/components/parameters/ProjectType'
- $ref: '#/components/parameters/MaxVersion'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Flavor'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsResponse'
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
'400':
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'
post:
security:
- PandaAuth: []
tags:
- Projects
summary: Upload a catrobat project
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/ProjectUploadRequest'
responses:
'201':
description: Project successfully uploaded.
headers:
Location:
schema:
type: string
example: >-
https://share.catrob.at/app/project/63768cf1-5f07-11ea-a2ae-000c292a0f49
description: Resource location on server
content:
application/json:
schema:
type: object
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/UnauthorizedError'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
description: Upload Error
content:
application/json:
schema:
$ref: '#/components/schemas/UploadErrorResponse'
/projects/featured:
get:
tags:
- Projects
summary: Get the currently featured projects
parameters:
- name: platform
in: query
schema:
type: string
description: 'Indication what platform should be used (ios, android)'
enum:
- android
- ios
- $ref: '#/components/parameters/MaxVersion'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Flavor'
responses:
'200':
description: OK
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
content:
application/json:
schema:
$ref: '#/components/schemas/FeaturedProjectsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'
/projects/search:
get:
tags:
- Projects
summary: Search for projects associated with a keywords
parameters:
- name: query
in: query
required: true
schema:
type: string
- $ref: '#/components/parameters/MaxVersion'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Flavor'
responses:
'200':
description: OK
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'
/projects/user/:
get:
security:
- PandaAuth: []
tags:
- Projects
summary: Get the projects of the logged in user
parameters:
- $ref: '#/components/parameters/MaxVersion'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Flavor'
responses:
'200':
description: Valid request
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/UnauthorizedError'
'406':
$ref: '#/components/responses/NotAcceptable'
'/projects/user/{id}':
get:
tags:
- Projects
summary: Get the public projects of a given user
parameters:
- $ref: '#/components/parameters/Uuid'
- $ref: '#/components/parameters/MaxVersion'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Flavor'
responses:
'200':
description: Valid request
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'406':
$ref: '#/components/responses/NotAcceptable'
'/project/{id}':
get:
tags:
- Projects
summary: Get the information of a project
parameters:
- $ref: '#/components/parameters/Uuid'
responses:
'200':
description: Valid request
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectResponse'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'406':
$ref: '#/components/responses/NotAcceptable'
'/project/{id}/report':
post:
security:
- PandaAuth: []
tags:
- Projects
summary: Report a project
parameters:
- $ref: '#/components/parameters/Uuid'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectReportRequest'
responses:
'204':
description: Project successfully reported.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFound'
'406':
$ref: '#/components/responses/NotAcceptable'
'/project/{id}/recommendations':
parameters:
- $ref: '#/components/parameters/Locale'
get:
tags:
- Projects
summary: Get recommended projects related to the specific project
parameters:
- $ref: '#/components/parameters/Uuid'
- $ref: '#/components/parameters/RecommendedProjectType'
- $ref: '#/components/parameters/MaxVersion'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Flavor'
responses:
'200':
description: OK
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'
################################################
# Notifications
#
/notifications:
get:
security:
- PandaAuth: []
tags:
- Notifications
summary: Get user notifications
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/NotificationsType'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/UnauthorizedError'
'/notifications/{id}/read':
put:
security:
- PandaAuth: []
tags:
- Notifications
summary: Mark specified notification as read
parameters:
- $ref: '#/components/parameters/NotificationsId'
responses:
'204':
$ref: '#/components/responses/NoContent'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFound'
/notifications/read:
put:
security:
- PandaAuth: []
tags:
- Notifications
summary: Mark all notifications as read
responses:
'204':
$ref: '#/components/responses/NoContent'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFound'
/notifications/count:
get:
security:
- PandaAuth: []
tags:
- Notifications
summary: Count the number of unseen notifications
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationsCountResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
################################################
# Media Library
#
'/media/package/{name}':
get:
tags:
- Media Library
summary: Get media-library asstes of a named package
parameters:
- in: path
name: name
schema:
type: string
pattern: '^[a-zA-Z0-9\-_]+$'
example: looks
required: true
description: Name of the package
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MediaFilesResponse'
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'406':
$ref: '#/components/responses/NotAcceptable'
'/media/files':
get:
tags:
- Media Library
summary: 'Get *all* content of the media library.'
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Flavor'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MediaFilesResponse'
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
'400':
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'
'/media/file/{id}':
get:
tags:
- Media Library
summary: Get the information of a specific media file
parameters:
- in: path
name: id
schema:
type: integer
example: 123
required: true
description: ID of any given media file
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MediaFileResponse'
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
'406':
$ref: '#/components/responses/NotAcceptable'
'/media/files/search':
get:
tags:
- Media Library
summary: Search for mediafiles associated with keywords
parameters:
- name: query
in: query
required: true
schema:
type: string
- $ref: '#/components/parameters/Flavor'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Offset'
- name: package_name
description: In which package you want to search (for more fine tuned results)
example: looks
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MediaFilesResponse'
headers:
X-Response-Hash:
schema:
type: string
example: '56asfd5a56sfd564a56dsf65a56sdf'
description: 'MD5 Hash of response body. Used for caching responses.'
'400':
$ref: '#/components/responses/BadRequest'
'406':
$ref: '#/components/responses/NotAcceptable'
components:
##############################################
# Default Response messages
###
responses:
OK:
description: OK
NoContent:
description: No Content
UnauthorizedError:
description: Invalid JWT token | JWT token not found | JWT token expired
BadRequest:
description: Bad request (Invalid, or missing parameters)
InvalidCredentials:
description: Invalid credentials
InvalidRefreshToken:
description: Refresh Token expired | Refresh Token has been used more than once (single use)
NotAcceptable:
description: Not acceptable - client must accept application/json as content type
UnsupportedMediaType:
description: >-
Unsupported Media Type - request must use application/json as content type
NotFound:
description: Not found
UnprocessableEntity:
description: Unprocessable Entity
InvalidIdToken:
description: Invalid Client ID token
##############################################
# Security Schemes
###
securitySchemes:
PandaAuth:
type: http
scheme: bearer
bearerFormat: JWT
##############################################
# Request Parameters
###
parameters:
##
# Default
#
Locale:
in: header
name: Accept-Language
required: false
schema:
type: string
description: ISO_639-1 or ISO_3166-1 locale of the user. Defaults internally to en
Uuid:
name: id
in: path
schema:
$ref: '#/components/schemas/Uuid'
required: true
Flavor:
in: query
name: flavor
schema:
type: string
example: luna
Limit:
name: limit
in: query
schema:
$ref: '#/components/schemas/Limit'
Offset:
name: offset
in: query
schema:
$ref: '#/components/schemas/Offset'
RefreshToken:
name: X-Refresh
in: header
description: Refresh Token
schema:
type: string
example: xxxxx.yyyyy.zzzzz
required: true
##
# Notifications specific
#
NotificationsId:
name: id
in: path
schema:
$ref: '#/components/schemas/NotificationsId'
required: true
NotificationsType:
name: type
in: query
schema:
$ref: '#/components/schemas/NotificationsType'
##
# Project specific
#
ProjectType: