This repository has been archived by the owner on Sep 26, 2023. It is now read-only.
forked from DevCom-IITB/instiapp-api
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathswagger.yaml
1251 lines (1231 loc) · 29.6 KB
/
swagger.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
host: localhost
info:
description: ''
title: ApnaInsti API
version: ''
paths:
/api/bodies:
get:
description: Body
operationId: bodies_list
parameters: []
responses:
'200':
description: ''
summary: Body
tags:
- bodies
post:
consumes:
- application/json
description: 'Create Body.
Needs the `AddB` Institute Role permission.'
operationId: bodies_create
parameters:
- in: body
name: data
schema:
properties:
blog_url:
description: ''
type: string
cover_url:
description: ''
type: string
description:
description: ''
type: string
image_url:
description: ''
type: string
name:
description: ''
type: string
short_description:
description: ''
type: string
website_url:
description: ''
type: string
required:
- name
type: object
responses:
'201':
description: ''
summary: Create Body.
tags:
- bodies
/api/bodies/{id}:
delete:
description: 'Delete Body.
Needs the `DelB` institute permission.'
operationId: bodies_delete
parameters:
- description: A UUID string identifying this Body.
in: path
name: id
required: true
type: string
responses:
'204':
description: ''
summary: Delete Body.
tags:
- bodies
get:
description: 'Get Body.
Retrieve by `uuid` or `str_id`.'
operationId: bodies_read
parameters:
- description: A UUID string identifying this Body.
in: path
name: id
required: true
type: string
responses:
'200':
description: ''
summary: Get Body.
tags:
- bodies
put:
consumes:
- application/json
description: 'Update Body.
Needs the `UpdB` permission.'
operationId: bodies_update
parameters:
- description: A UUID string identifying this Body.
in: path
name: id
required: true
type: string
- in: body
name: data
schema:
properties:
blog_url:
description: ''
type: string
cover_url:
description: ''
type: string
description:
description: ''
type: string
image_url:
description: ''
type: string
name:
description: ''
type: string
short_description:
description: ''
type: string
website_url:
description: ''
type: string
required:
- name
type: object
responses:
'200':
description: ''
summary: Update Body.
tags:
- bodies
/api/bodies/{id}/follow:
get:
description: Follow or unfollow a body {?action}=0,1
operationId: bodies_follow
parameters:
- description: A UUID string identifying this Body.
in: path
name: id
required: true
type: string
responses:
'200':
description: ''
summary: Follow or unfollow a body {?action}=0,1
tags:
- bodies
/api/bodies/{id}/followers:
get:
description: List followers of body.
operationId: bodies_followers_read
parameters:
- description: A UUID string identifying this Body.
in: path
name: id
required: true
type: string
responses:
'200':
description: ''
summary: List followers of body.
tags:
- bodies
/api/docs/:
get:
operationId: docs_list
parameters: []
responses:
'200':
description: ''
tags:
- docs
/api/events:
get:
description: 'List Events.
List fresh events prioritized for the current user.'
operationId: events_list
parameters: []
responses:
'200':
description: ''
summary: List Events.
tags:
- events
post:
consumes:
- application/json
description: 'Create Event.
Needs `AddE` permission for each body to be associated.'
operationId: events_create
parameters:
- in: body
name: data
schema:
properties:
all_day:
description: ''
type: boolean
bodies_id:
description: ''
items:
type: string
type: array
description:
description: ''
type: string
end_time:
description: ''
type: string
image_url:
description: ''
type: string
name:
description: ''
type: string
notify:
description: ''
type: boolean
start_time:
description: ''
type: string
user_tags:
description: ''
items:
type: string
type: array
venue_ids:
description: ''
items:
type: string
type: array
website_url:
description: ''
type: string
required:
- name
- start_time
- end_time
- bodies_id
type: object
responses:
'201':
description: ''
summary: Create Event.
tags:
- events
/api/events/{id}:
delete:
description: 'Delete Event.
Needs `DelE` permission for all associated bodies.'
operationId: events_delete
parameters:
- description: A UUID string identifying this Event.
in: path
name: id
required: true
type: string
responses:
'204':
description: ''
summary: Delete Event.
tags:
- events
get:
description: 'Get Event.
Get by `uuid` or `str_id`'
operationId: events_read
parameters:
- description: A UUID string identifying this Event.
in: path
name: id
required: true
type: string
responses:
'200':
description: ''
summary: Get Event.
tags:
- events
put:
consumes:
- application/json
description: 'Update Event.
Needs BodyRole with `UpdE` for at least one associated body.
Disassociating bodies from the event requires the `DelE`
permission and associating needs `AddE`'
operationId: events_update
parameters:
- description: A UUID string identifying this Event.
in: path
name: id
required: true
type: string
- in: body
name: data
schema:
properties:
all_day:
description: ''
type: boolean
bodies_id:
description: ''
items:
type: string
type: array
description:
description: ''
type: string
end_time:
description: ''
type: string
image_url:
description: ''
type: string
name:
description: ''
type: string
notify:
description: ''
type: boolean
start_time:
description: ''
type: string
user_tags:
description: ''
items:
type: string
type: array
venue_ids:
description: ''
items:
type: string
type: array
website_url:
description: ''
type: string
required:
- name
- start_time
- end_time
- bodies_id
type: object
responses:
'200':
description: ''
summary: Update Event.
tags:
- events
/api/locations:
get:
description: List reusable locations.
operationId: locations_list
parameters: []
responses:
'200':
description: ''
summary: List reusable locations.
tags:
- locations
post:
consumes:
- application/json
description: 'Create a Location.
Needs ''Location'' institute permission.'
operationId: locations_create
parameters:
- in: body
name: data
schema:
properties:
description:
description: ''
type: string
group_id:
description: ''
type: integer
lat:
description: ''
type: number
lng:
description: ''
type: number
name:
description: ''
type: string
parent:
description: ''
type: string
parent_relation:
description: ''
type: string
reusable:
description: ''
type: boolean
short_name:
description: ''
type: string
required:
- name
type: object
responses:
'201':
description: ''
summary: Create a Location.
tags:
- locations
/api/locations/{id}:
delete:
description: 'Delete a Location.
Needs ''Location'' institute permission.'
operationId: locations_delete
parameters:
- description: A UUID string identifying this Location.
in: path
name: id
required: true
type: string
responses:
'204':
description: ''
summary: Delete a Location.
tags:
- locations
get:
description: Location
operationId: locations_read
parameters:
- description: A UUID string identifying this Location.
in: path
name: id
required: true
type: string
responses:
'200':
description: ''
summary: Location
tags:
- locations
put:
consumes:
- application/json
description: 'Update Location.
This requires the user to have the ''Location'' institute permission
or BodyRole for the event using the location if the it is not reusable.'
operationId: locations_update
parameters:
- description: A UUID string identifying this Location.
in: path
name: id
required: true
type: string
- in: body
name: data
schema:
properties:
description:
description: ''
type: string
group_id:
description: ''
type: integer
lat:
description: ''
type: number
lng:
description: ''
type: number
name:
description: ''
type: string
parent:
description: ''
type: string
parent_relation:
description: ''
type: string
pixel_x:
description: ''
type: integer
pixel_y:
description: ''
type: integer
reusable:
description: ''
type: boolean
short_name:
description: ''
type: string
required:
- name
type: object
responses:
'200':
description: ''
summary: Update Location.
tags:
- locations
/api/login:
get:
description: Login using institute email address and password.
operationId: pass_login
parameters: []
responses:
'200':
description: ''
summary: Login using institute email address and password.
/api/login/get-user:
get:
description: Get session and profile.
operationId: login_get_user
parameters: []
responses:
'200':
description: ''
summary: Get session and profile.
tags:
- login
/api/logout:
get:
description: Log out.
operationId: logout
parameters: []
responses:
'200':
description: ''
summary: Log out.
/api/mess:
get:
description: Get mess menus of all hostels.
operationId: mess_list
parameters: []
responses:
'200':
description: ''
summary: Get mess menus of all hostels.
tags:
- mess
/api/news:
get:
description: Get News feed.
operationId: news_feed
parameters: []
responses:
'200':
description: ''
summary: Get News feed.
/api/notifications:
get:
description: Get unread notifications for current user.
operationId: get_notifications
parameters: []
responses:
'200':
description: ''
summary: Get unread notifications for current user.
/api/notifications/read:
get:
description: Mark all notifications as read.
operationId: notifications_mark_all_notifications_read
parameters: []
responses:
'200':
description: ''
summary: Mark all notifications as read.
tags:
- notifications
/api/notifications/read/{id}:
get:
description: Mark one notification as read.
operationId: notifications_mark_notification_read
parameters:
- description: ''
in: path
name: id
required: true
type: string
responses:
'200':
description: ''
summary: Mark one notification as read.
tags:
- notifications
/api/roles:
post:
consumes:
- application/json
description: Body Role
operationId: roles_create
parameters:
- in: body
name: data
schema:
properties:
body:
description: ''
type: string
inheritable:
description: ''
type: boolean
name:
description: ''
type: string
official_post:
description: ''
type: boolean
permissions:
description: ''
items:
type: string
type: array
priority:
description: ''
type: integer
users:
description: ''
items:
type: string
type: array
required:
- name
- body
- permissions
- users
type: object
responses:
'201':
description: ''
summary: Body Role
tags:
- roles
/api/roles/{id}:
delete:
description: Body Role
operationId: roles_delete
parameters:
- description: A UUID string identifying this Body Role.
in: path
name: id
required: true
type: string
responses:
'204':
description: ''
summary: Body Role
tags:
- roles
get:
description: Body Role
operationId: roles_read
parameters:
- description: A UUID string identifying this Body Role.
in: path
name: id
required: true
type: string
responses:
'200':
description: ''
summary: Body Role
tags:
- roles
put:
consumes:
- application/json
description: Body Role
operationId: roles_update
parameters:
- description: A UUID string identifying this Body Role.
in: path
name: id
required: true
type: string
- in: body
name: data
schema:
properties:
body:
description: ''
type: string
inheritable:
description: ''
type: boolean
name:
description: ''
type: string
official_post:
description: ''
type: boolean
permissions:
description: ''
items:
type: string
type: array
priority:
description: ''
type: integer
users:
description: ''
items:
type: string
type: array
required:
- name
- body
- permissions
- users
type: object
responses:
'200':
description: ''
summary: Body Role
tags:
- roles
/api/search:
get:
operationId: search
parameters: []
responses:
'200':
description: ''
/api/signup:
get:
description: 'Signup using institute email ID.
Signup using a user''s institute email ID and send them a password over there.'
operationId: signup
parameters: []
responses:
'200':
description: ''
summary: Signup using institute email ID.
/api/upload:
post:
consumes:
- application/json
description: Upload file.
operationId: upload_create
parameters:
- in: body
name: data
schema:
properties:
picture:
description: ''
type: string
required:
- picture
type: object
responses:
'201':
description: ''
summary: Upload file.
tags:
- upload
/api/upload/{id}:
delete:
description: Delete file entry.
operationId: upload_delete
parameters:
- description: A UUID string identifying this Uploaded Image.
in: path
name: id
required: true
type: string
responses:
'204':
description: ''
summary: Delete file entry.
tags:
- upload
get:
description: Upload
operationId: upload_read
parameters:
- description: A UUID string identifying this Uploaded Image.
in: path
name: id
required: true
type: string
responses:
'200':
description: ''
summary: Upload
tags:
- upload
/api/user-me:
get:
description: Get current user.
operationId: user-me_read
parameters: []
responses:
'200':
description: ''
summary: Get current user.
tags:
- user-me
patch:
consumes:
- application/json
description: Update current user.
operationId: user-me_partial_update
parameters:
- in: body
name: data
schema:
properties:
about:
description: ''
type: string
android_version:
description: ''
type: integer
fcm_id:
description: ''
type: string
hostel:
description: ''
type: string
ldap_id:
description: ''
type: string
name:
description: ''
type: string
profile_pic:
description: ''
type: string
roll_no:
description: ''
type: string
show_contact_no:
description: ''
type: boolean
website_url:
description: ''
type: string
type: object
responses:
'200':
description: ''
summary: Update current user.
tags:
- user-me
put:
consumes:
- application/json
description: Update current user.
operationId: user-me_update
parameters:
- in: body
name: data
schema:
properties:
about:
description: ''
type: string
android_version:
description: ''
type: integer
fcm_id:
description: ''
type: string
hostel:
description: ''
type: string
ldap_id:
description: ''
type: string
name:
description: ''
type: string
profile_pic:
description: ''
type: string
roll_no:
description: ''
type: string
show_contact_no:
description: ''
type: boolean
website_url:
description: ''
type: string
type: object
responses:
'200':
description: ''
summary: Update current user.
tags:
- user-me
/api/user-me/events:
get:
description: Current user's created events.
operationId: user-me_get_my_events
parameters: []
responses:
'200':
description: ''
summary: Current user's created events.
tags:
- user-me
/api/user-me/roles:
get:
description: Get roles with nested events.
operationId: user-me_get_my_roles
parameters: []
responses:
'200':
description: ''
summary: Get roles with nested events.
tags:
- user-me
/api/user-me/subscribe-wp:
post:
consumes:
- application/json
description: Subscribe to web push.
operationId: user-me_subscribe_web_push
parameters:
- in: body
name: data
schema:
properties:
about:
description: ''
type: string
android_version:
description: ''
type: integer
fcm_id:
description: ''
type: string
hostel:
description: ''
type: string
ldap_id:
description: ''
type: string
name:
description: ''
type: string
profile_pic:
description: ''
type: string
roll_no:
description: ''
type: string
show_contact_no:
description: ''
type: boolean
website_url:
description: ''
type: string
type: object
responses:
'201':
description: ''
summary: Subscribe to web push.
tags:
- user-me
/api/user-me/ues/{event_pk}:
get:
description: 'Set UES for current user.
This will create or update if record exists.'
operationId: user-me_set_ues_me
parameters:
- description: ''
in: path
name: event_pk
required: true
type: string
responses:
'200':
description: ''
summary: Set UES for current user.
tags:
- user-me