api/swagger.yaml at master · izinga/api · GitHub

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
swagger: "2.0"
info:
  version: "1.0.3"
  title: "RobusTest API"
  description: "RobusTest API"
  termsOfService: "http://robustest.com/terms"
  license:
    name: "Apache 2.0"
    url: "https://www.apache.org/licenses/LICENSE-2.0.html"
host: "robustest.com"
basePath: "/v3"
contact:
  email: "support@robustest.com"
tags:
- name: "note"
  description: "How to create, update and read note"
- name: "atc"
  description: "handle argumented traffic control"
- name: "espresso"
  description: "Handle espresso run"
schemes:
  - "https"
  - "http"

paths:
  /note/{id}:
    get:
      tags:
      - "note"
      summary: get a single note
      description: get all detail of single note
      operationId: note
      responses:
        '200':    # status code
          description: get note
          schema:
            $ref: '#/definitions/note'
    post:
      tags:
      - "note"
      summary: create a note
      description: create note
      operationId: note
      parameters:
        - description:  note
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/note'
      responses:
        '200':    # status code
          description: create note
          schema:
            $ref: '#/definitions/note'
    put:
      tags:
      - "note"
      summary: update note
      description: update note
      operationId: note
      parameters:
        - description:  wifi
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/note'
      responses:
        '200':    # status code
          description: update note
          schema:
            $ref: '#/definitions/note'
    delete:
      tags:
      - "note"
      summary: delete note
      description: delete note
      operationId: note
      responses:
        '200':    # status code
          description: delete note
          schema:
            $ref: '#/definitions/note'

  /notes/project/<project_id>:
    get:
      tags:
      - "note"
      summary: get all notes for given project
      description:  get all notes for given project
      operationId: note
      responses:
        '200':    # status code
          description: get all notes for given project
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/note'

  /notes:
    get:
      tags:
      - "note"
      summary: get all notes for logged in user
      description:  get all notes for logged in user
      operationId: note
      responses:
        '200':    # status code
          description: get all notes for logged in user
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/note'

  /devicegroup/{id}:
    get:
      summary: get device group
      description: get device group
      operationId: deviceGroup
      responses:
        '200':    # status code
          description: get device group
          schema:
            $ref: '#/definitions/deviceGroup'
    post:
      summary: create device group
      description: create device group
      operationId: deviceGroup
      parameters:
        - description:  wifi
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/deviceGroup'
      responses:
        '200':    # status code
          description: create device group
          schema:
            $ref: '#/definitions/deviceGroup'
    put:
      summary: update device group
      description: update device group
      operationId: deviceGroup
      parameters:
        - description:  deviceGroup
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/deviceGroup'
      responses:
        '200':    # status code
          description: update device group
          schema:
            $ref: '#/definitions/deviceGroup'

  /devicequeries/<project_id>:
    get:
      summary: get all device query for given project
      description:  get all device query for given project
      operationId: deviceGroup
      responses:
        '200':    # status code
          description: get all device query for given project
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/deviceQuery'
  /devicegroups/<project_id>:
    get:
      summary: get all device group for given project
      description:  get all deive query for given project
      operationId: deviceGroup
      responses:
        '200':    # status code
          description: get all device group for given project
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/deviceGroup'

  /devicegroup/<id>:
    get:
      summary: get device ids for given group
      description:  get device ids for given group
      operationId: deviceGroup
      responses:
        '200':    # status code
          description: get device ids for given group
          schema:
            type: array
            items:
              type : string
  /testsession/<testsession_id>/changewifi:
    put:
      summary: change wifi network
      description:  change wifi network
      operationId: wifi
      parameters:
        - description:  wifi
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/wifiRequest'
      responses:
        '200':    # status code
          description:  change wifi network
  /appium/hub/<project_id>?count=5&cursor=<cursor>:
    get:
      summary: get all appium hub for a project
      description:  get all appium hub for a project
      operationId: appium
      responses:
        '200':    # status code
          description: get all appium hub for a project
          schema:
            $ref: '#/definitions/appiumHub'
  /appium/sessions/<hub_id>:
    get:
      summary: get all appium session for a given entry
      description:  get all appium session for a given entry
      operationId: appium
      responses:
        '200':    # status code
          description: get all appium session for a given entry
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/appiumSession'
  /admin/activity/<id>:
    get:
      summary: get activity details
      description:  get activity details
      operationId: activity
      responses:
        '200':    # status code
          description: get activity details
          schema:
            $ref: '#/definitions/activity'
  /admin/activities?count=count&cursor=cur:
    get:
      summary: get n activities
      description:  get n activities
      operationId: activity
      responses:
        '200':    # status code
          description: get activities
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/activity'
  /neuron/config:
    get:
      tags:
      - "atc"
      summary: get neuron config
      description:  get neuron config
      operationId: neuron
      responses:
        '200':    # status code
          description: get neuron config
          schema:
            $ref: '#/definitions/neuronConfig'

  /atc/profiles:
    get:
      tags:
      - "atc"
      summary: get all atc profile
      description:  get all atc profile
      operationId: atc
      responses:
        '200':    # status code
          description: get all atc profile
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/atcProfile'

  /atc/profile/<testsession_id> :
    post:
      tags:
      - "atc"
      summary: shape atc traffic
      description:  shape atc traffic
      operationId: atc
      parameters:
        - description:  atc
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/atcProfile'
      responses:
        '200':    # status code
          description: shape atc traffic
          schema:
            $ref: '#/definitions/atcProfile'

    delete:
      tags:
      - "atc"
      summary: un shape atc traffic
      description:  shape atc traffic
      operationId: atc
      responses:
        '200':    # status code
          description: shape atc traffic
          schema:
            $ref: '#/definitions/atcProfile'

  /espresso/skiptest/<project_id>/all:
    get:
      tags:
      - "espresso"
      summary: get all marked espresso skipped test cases
      description:  get all marked espresso skipped test cases
      operationId: espresso
      responses:
        '200':    # status code
          description: get all marked espresso skipped test cases
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/espressoSkipTest'

  /espresso/skiptest/<id>:
    get:
      tags:
      - "espresso"
      summary: get  marked espresso skipped test cases
      description:  get  marked espresso skipped test cases
      operationId: espresso
      responses:
        '200':    # status code
          description: get  marked espresso skipped test cases
          schema:
            $ref: '#/definitions/espressoSkipTest'
    post:
      tags:
      - "espresso"
      summary: create  marked espresso skipped test cases
      description:  create  marked espresso skipped test cases
      operationId: espresso
      parameters:
        - description:  espresso
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/espressoSkipTest'
      responses:
        '200':    # status code
          description: create  marked espresso skipped test cases
          schema:
            $ref: '#/definitions/espressoSkipTest'
    put:
      tags:
      - "espresso"
      summary: update  marked espresso skipped test cases
      description:  update  marked espresso skipped test cases
      operationId: espresso
      parameters:
        - description:  espresso
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/espressoSkipTest'
      responses:
        '200':    # status code
          description: create  marked espresso skipped test cases
          schema:
            $ref: '#/definitions/espressoSkipTest'
    delete:
      tags:
      - "espresso"
      summary: delete  marked espresso skipped test cases
      description:  delete  marked espresso skipped test cases
      operationId: espresso
      responses:
        '200':    # status code
          description: delete  marked espresso skipped test cases
          schema:
            $ref: '#/definitions/espressoSkipTest'


  /device/<device_id>/restart:
    get:
      summary: restart device
      description:  restart device
      operationId: device
      responses:
        '200':    # status code
          description: restart device
          schema:
            $ref: '#/definitions/device'


  /espresso/result/<result_id>:
    get:
      tags:
      - "espresso"
      summary: espresso test result
      description:  espresso test result
      operationId: espresso
      responses:
        '200':    # status code
          description: espresso test result
          schema:
            $ref: '#/definitions/espressoTestResult'


  /espresso-testcase/<testcase_id>/history?count=100:
    get:
      tags:
      - "espresso"
      summary: get last N history of espresso-testcase
      description:  get last N history of espresso-testcase
      operationId: espresso-testcase
      responses:
        '200':    # status code
          description: espresso-testcase last N history of espresso-testcase
          schema:
            $ref: '#/definitions/espressoTestcase'

  /recording/pagesource/<testsession_id>:
    get:
      summary: get pagesource
      description:  get pagesource
      operationId: pagesource
      responses:
        '200':    # status code
          description: pagesource
          schema:
            $ref: '#/definitions/pagesource'
    put:
      summary: stop pagesource streaming
      description:  stop pagesource streaming
      operationId: pagesource
      responses:
        '200':    # status code
          description: run
    delete:
      summary: start pagesource streaming
      description:  start pagesource streaming
      operationId: pagesource
      responses:
        '200':    # status code
          description: run


  /admin/config:
    get:
      summary: get all config
      description:  get all config
      operationId: config
      responses:
        '200':    # status code
          description: run
          schema:
            $ref: '#/definitions/config'

  /admin/config/<id>:
    put:
      summary: update config
      description:  update config
      operationId: config
      parameters:
        - description: config
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/config'
      responses:
        '200':    # status code
          description: run
          schema:
            $ref: '#/definitions/config'


  /admin/db/clean:
    delete:
      summary: delete row from database
      description:  delete row from database
      operationId: dbCleanup
      parameters:
        - description: dbCleanup
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/dbCleanup'
      responses:
        '200':    # status code
          description: run


  /testsession/<testsession_id>/performance?accesskey=<access_key>:
    post:
      summary: start performance monitoring
      description: start performance monitoring
      operationId: performance
      parameters:
        - description: reserve device
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/perfomanceData'
      responses:
        '200':    # status code
          description: performance
    delete:
      summary: stop performance monitoring
      description: stop performance monitoring
      operationId: performance
      responses:
        '200':    # status code
          description: performance


  /admin/confirm/:userID/resend:
    get:
      summary: resend confirmation link
      description: resend confirmation link
      operationId: confirm
      responses:
        '200':    # status code
          description: confirm


  /testsession/{test_session_id}/screenshot:
    get:
      summary: get screenshot from device
      description: get screenshot from device
      operationId: screenshot
      responses:
        '200':    # status code
          description: screenshot

          schema:
            type: object
            properties:
              base64 :
                type: string

  /run/{run_id}/rerun?accesskey={access_key}:
    get:
      summary: Rerun test on same set of devices with same test suite and dataset
      description: Rerun test on same set of devices with same test suite and dataset
      operationId: run
      responses:
        '200':    # status code
          description: run
          schema:
            $ref: '#/definitions/runResponse'
  /devices?accesskey={access_key}:
    get:
      summary: get all devices
      description: get all devices
      operationId: device
      responses:
        '200':    # status code
          description: get all devices
          schema:
            type: object
            properties:
              available :
                type: array
                items:
                  type : object
                  $ref: '#/definitions/device'
              busy :
                type: array
                items:
                  type : object
                  $ref: '#/definitions/device'
              offline :
                type: array
                items:
                  type : object
                  $ref: '#/definitions/device'
              reserved :
                type: array
                items:
                  type : object
                  $ref: '#/definitions/device'
  /device/{device_id}/detail?accesskey={access_key}:
    get:
      summary: get device, session and live screen url by device id
      description: get device, session and live screen url by device id
      operationId: device
      responses:
        '200':    # status code
          description: get device, session and live screen url by device id
          schema:
            type: object
            properties:
              device :
                type: object
                $ref: '#/definitions/device'
              session :
                type: object
                $ref: '#/definitions/testsession'
              liveScreen :
                type: string
  /device/{device_id}/free?accesskey={access_key}:
    delete:
      summary: free device by device id
      description: free device by device id
      operationId: device
      responses:
        '200':    # status code
          description: device
          schema:
            $ref: '#/definitions/device'
  /session/live:
    get:
      summary: get all live page for logged in user
      description: get all live page for logged in user
      operationId: session
      responses:
        '200':    # status code
          description: testsession
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/testsession'


  /result/{result_id}/logcat:
    get:
      summary: get logcat for result
      description: get logcat for result
      operationId: result
      responses:
        '200':    # status code
          description: result
          schema:
            $ref: '#/definitions/logcat'

  /result/{result_id}/perfomance:
    get:
      summary: get perfomance for result
      description: get perfomance for result
      operationId: result
      responses:
        '200':    # status code
          description: perfomance
          schema:
            $ref: '#/definitions/perfomance'

  /testscript/{testscript_id}/checkForDelete:
    head:
      summary: get list of all test scripts whiche are depends on testscript
      description: get list of all test scripts whiche are depends on testscript
      operationId: testscript
      responses:
        '200':    # status code
          description: testscript
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/testscript'


  /contacts/:projectID:
    get:
      summary: get all contact for project
      description: get all contact for project
      operationId: contact
      responses:
        '200':    # status code
          description: get all contact for project
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/contactListResponse'

  /device/reserve:
    put:
      summary: reserve device
      description: reserve device
      operationId: device
      parameters:
        - description: reserve device
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/DeviceReservePayload'
      responses:
        '200':    # status code
          description: device
          schema:
              $ref: '#/definitions/device'
    delete:
      summary: unreserve device
      description: unreserve device
      operationId: unreserve

      responses:
        '200':    # status code
          description: device
          schema:
              $ref: '#/definitions/device'
  /contact/:id:
    post:
      summary: create new contact
      description: create new contact
      operationId: contact
      parameters:
        - description: new contact
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/contactListPayload'
      responses:
        '200':    # status code
          description: share
          schema:
              $ref: '#/definitions/contactListResponse'
    put:
      summary: update contact
      description: update contact
      operationId: contact
      parameters:
        - description: update contact
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/contactListPayload'
    get:
      summary: get contact
      description: get contact
      operationId: contact
      responses:
        '200':    # status code
          description: contact
          schema:
              $ref: '#/definitions/contactListResponse'
    delete:
      summary: delete contact
      description: delete contact
      operationId: contact
      responses:
        '200':    # status code
          description: share
          schema:
              $ref: '#/definitions/contactListResponse'

  /share/new:
    post:
      summary: create new share object
      description: create new share object
      operationId: share
      parameters:
        - description: new share object
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/sharePayload'
      responses:
        '200':    # status code
          description: share
          schema:
              $ref: '#/definitions/sharePayload'

  /dataset/{id}:
    post:
      summary: create dataset
      description: create dataset
      operationId: dataset
      parameters:
        - description: create dataset
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/datasetPayload'
      responses:
        '200':    # status code
          description: dataset
          schema:
              $ref: '#/definitions/dataset'
    put:
      summary: update dataset
      description: update dataset
      operationId: dataset
      parameters:
        - description: update dataset
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/datasetUpdatePayload'
      responses:
        '200':    # status code
          description: dataset
          schema:
              $ref: '#/definitions/dataset'


    get:
      summary: get dataset
      description: get dataset
      operationId: dataset
      responses:
        '200':    # status code
          description: dataset
          schema:
              $ref: '#/definitions/dataset'

  /datasets/project/{project id}:
    get:
      summary: get all dataset for project dataset
      description: get all dataset for project dataset
      operationId: setting
      responses:
        '200':    # status code
          description: get all dataset for project dataset
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/dataset'
  /datasets/testsuite/{test suite id}:
    get:
      summary: get all dataset for test suite dataset
      description: get all dataset for test suite dataset
      operationId: setting
      responses:
        '200':    # status code
          description: get all dataset for test suite dataset
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/dataset'
  /setting/{id}:
    post:
      summary: create setting
      description: create setting
      operationId: setting
      parameters:
        - description: create setting
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/settingPayload'
      responses:
        '200':    # status code
          description: setting variables
          schema:
              $ref: '#/definitions/setting'
    put:
      summary: update setting
      description: update setting
      operationId: setting
      parameters:
        - description: update setting
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/settingPayload'
      responses:
        '200':    # status code
          description: setting variables
          schema:
              $ref: '#/definitions/setting'
    get:
      summary: get setting
      description: get setting
      operationId: setting
      responses:
        '200':    # status code
          description: setting variables
          schema:
              $ref: '#/definitions/setting'
    delete:
      summary: delete setting
      description: delete setting
      operationId: setting
      responses:
        '200':    # status code
          description: delete variables
          schema:
              $ref: '#/definitions/setting'
  /settings/{project id}:
    get:
      summary: get all setting for project setting
      description: get all setting for project setting
      operationId: setting
      responses:
        '200':    # status code
          description: get all setting for project setting
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/setting'

  /settings/{id}/default:
    put:
      summary: make setting default
      description: make setting default
      operationId: setting
      responses:
        '200':    # status code
          description: make setting default
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/setting'

  /testscript/{testscript_id}/check:
    put:
      summary: make testscript as check
      description: make testscript as check
      operationId: testscript
      parameters:
        - description: make testscript as check
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/checkPayload'
      responses:
        '200':    # status code
          description: global variables
          schema:
              $ref: '#/definitions/testscript'

  /variables/{project_id}:
    get:
      summary: get all global variables
      description: get all global variables
      operationId: global variables
      responses:
        '200':    # status code
          description: global variables
          schema:
            type: array
            items:
              type : object
              $ref: '#/definitions/globalVariable'
  /variable/new:
    post:
      summary: get all global variables
      description: get all global variables
      operationId: global variables
      parameters:
        - description: create global variables
        - name: payload
          in: body
          required: true
          schema:
              $ref: '#/definitions/webBuildPayload'
      responses:
        '200':    # status code
          description: global variables
          schema:
              $ref: '#/definitions/globalVariable'
  /variable/{id}:
    get:
      summary: get global variables
      description: get global variables
      operationId: global variables
      responses:
        '200':    # status code
          description: global variables
          schema:
              $ref: '#/definitions/globalVariable'

  /notifications?page=pagenumber:
    get:
      summary: get 20 notifications for user
      description: get 20 notifications for user