-
Notifications
You must be signed in to change notification settings - Fork 8
/
api-v2-public.yaml
2067 lines (2038 loc) · 57.6 KB
/
api-v2-public.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.0'
info:
version: 2.0.0
title: Scarf API
license:
name: MIT
servers:
- url: https://api.scarf.sh
tags:
- name: Users
description: Public information about users.
- name: Organizations
- name: Packages
- name: Tracking Pixels
- name: Auto Creation Rules
security:
- ApiToken: []
paths:
/v2/packages/{owner}/overview:
parameters:
- '$ref': '#/components/parameters/owner'
get:
operationId: getPackagesOverview
summary: Returns a paginated list of packages belonging to the given account
tags:
- Packages
parameters:
- name: type
in: query
required: false
explode: true
schema:
type: array
items:
'$ref': '#/components/schemas/PackageType'
- name: after
in: query
required: false
schema:
type: string
example: b9aef4a5-f4b4-472c-ad49-088781a175d4
- '$ref': '#/components/parameters/per_page'
responses:
'200':
description: A page of packages
content:
application/json:
schema:
type: object
required:
- results
properties:
results:
type: array
items:
'$ref': '#/components/schemas/OverviewPackage'
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
description: Package not found
/v2/packages/{owner}:
parameters:
- '$ref': '#/components/parameters/owner'
get:
operationId: getPackages
summary: Returns a paginated list of packages belonging to the given account
tags:
- Packages
parameters:
- name: type
in: query
required: false
explode: true
schema:
type: array
items:
'$ref': '#/components/schemas/PackageType'
- name: after
in: query
required: false
schema:
type: string
example: b9aef4a5-f4b4-472c-ad49-088781a175d4
- '$ref': '#/components/parameters/per_page'
responses:
'200':
description: A page of packages
content:
application/json:
schema:
type: object
required:
- results
properties:
results:
type: array
items:
'$ref': '#/components/schemas/Package'
_links:
'$ref': '#/components/schemas/CursorLinks'
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
description: Package not found
post:
operationId: createPackage
summary: Creates a new package
tags:
- Packages
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/CreatePackage'
responses:
'201':
description: Successfully created package
content:
application/json:
schema:
'$ref': '#/components/schemas/Package'
'404':
description: Not found
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/CreatePackageError'
/v2/packages/{owner}/{package_type}/{package_name}:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_type'
- '$ref': '#/components/parameters/package_name'
get:
operationId: getPackageByName
summary: Returns a package by specified its package type and name
tags:
- Packages
responses:
'200':
description: Package details
content:
application/json:
schema:
'$ref': '#/components/schemas/Package'
'404':
description: Owner or Package not found
/v2/packages/{owner}/{package_id}:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_id'
get:
operationId: getPackageById
summary: Returns a package by specified id
tags:
- Packages
responses:
'200':
description: Package details
content:
application/json:
schema:
'$ref': '#/components/schemas/Package'
'404':
description: Owner or Package not found
put:
operationId: updatePackage
summary: Updates an existing package
tags:
- Packages
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdatePackage'
responses:
'200':
description: Package updated successfully
content:
application/json:
schema:
'$ref': '#/components/schemas/Package'
'404':
description: Not found
'422':
description: Invalid request
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdatePackageError'
delete:
operationId: deletePackage
summary: Deletes a package
tags:
- Packages
responses:
'204':
description: Package deleted successfully
'404':
description: Not found
/v2/packages/{owner}/{package_id}/tracking-pixels:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_id'
get:
parameters:
- name: after
in: query
required: false
schema:
type: string
example: dbba955a-7567-4300-8630-088054db2222
- '$ref': '#/components/parameters/per_page'
operationId: getPackageTrackingPixels
summary: Returns all the tracking-pixels associated with a particular package
tags:
- Packages
responses:
'200':
description: List of tracking pixels for the requested package
content:
application/json:
schema:
type: array
items:
'$ref': '#/components/schemas/TrackingPixel'
'404':
description: Not found
/v2/packages/{owner}/{package_id}/domains:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_id'
get:
operationId: getPackageDomains
summary: Get all domains of a specified package. Currently, it only works for File, Python, and Docker packages
tags:
- Packages
responses:
'200':
description: List of package domains
content:
application/json:
schema:
type: array
items:
'$ref': '#/components/schemas/Domain'
'404':
description: Owner or package not found
post:
operationId: createPackageDomain
summary: Creates a new package domain. Currently, it only works for File and Python packages
tags:
- Packages
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/CreatePackageDomain'
responses:
'201':
description: Package domain created successfully
content:
application/json:
schema:
'$ref': '#/components/schemas/Domain'
'404':
description: Not found
'422':
description: Invalid request
content:
application/json:
schema:
'$ref': '#/components/schemas/CreatePackageDomainError'
/v2/packages/{owner}/{package_id}/domains/{domain_id}:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_id'
- '$ref': '#/components/parameters/domain_id'
get:
operationId: getPackageDomain
summary: Gets a package domain by specified id
tags:
- Packages
responses:
'200':
description: Package domain
content:
application/json:
schema:
'$ref': '#/components/schemas/Domain'
'404':
description: Package domain not found
delete:
operationId: deletePackageDomain
summary: Deletes a package domain
tags:
- Packages
responses:
'204':
description: Package domain deleted successfully
'404':
description: Not found
/v2/packages/{owner}/{package_id}/routes:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_id'
get:
parameters:
- name: after
in: query
required: false
schema:
type: string
x-tie-haskell-type: Scarf.Capability.Parameters.RouteId
example: 3kTMd
- '$ref': '#/components/parameters/per_page'
operationId: getPackageRoutes
summary: Gets all package routes (only for File Packages)
tags:
- Packages
responses:
'200':
description: List of package routes returned successfully
content:
application/json:
schema:
type: array
items:
'$ref': '#/components/schemas/PackageRoute'
'404':
description: Not found
post:
operationId: createPackageRoute
summary: Creates a new package route (only for File Packages)
tags:
- Packages
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/CreatePackageRoute'
responses:
'201':
description: Package route created successfully
content:
application/json:
schema:
'$ref': '#/components/schemas/PackageRoute'
'404':
description: Not found
'422':
description: Invalid request
content:
application/json:
schema:
'$ref': '#/components/schemas/CreatePackageRouteError'
/v2/packages/{owner}/{package_id}/routes/{route_id}:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_id'
- '$ref': '#/components/parameters/route_id'
get:
operationId: getPackageRoute
summary: Gets the details of a package route
tags:
- Packages
responses:
'200':
description: Package route returned successfully
content:
application/json:
schema:
'$ref': '#/components/schemas/PackageRoute'
'404':
description: Not found
delete:
operationId: deletePackageRoute
summary: Deletes a package route
tags:
- Packages
responses:
'204':
description: Package route deleted successfully
'404':
description: Not found
'422':
description: Invalid request
content:
application/json:
schema:
'$ref': '#/components/schemas/DeletePackageRouteError'
/v2/packages/{owner}/{package_id}/permissions:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_id'
get:
parameters:
- '$ref': '#/components/parameters/per_page'
- name: after
in: query
required: false
schema:
type: string
x-tie-haskell-type: Scarf.Capability.Parameters.UserId
example: 7bea2612-d30a-43e3-bf2b-d390eb125eb0
operationId: getPackagePermissions
summary: Gets list of package permissions. Only when owner is a User
tags:
- Packages
responses:
'200':
description: Package permissions returned successfully
content:
application/json:
schema:
type: array
items:
'$ref': '#/components/schemas/PackagePermission'
'404':
description: Not found
post:
operationId: setPackagePermission
summary: Sets a package permission. Only when owner is a User
tags:
- Packages
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/SetPackagePermission'
responses:
'204':
description: Package permission set successfully
'404':
description: Not found
'422':
description: Invalid request
content:
application/json:
schema:
'$ref': '#/components/schemas/Error'
/v2/packages/{owner}/{package_id}/permissions/{username}:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/package_id'
- '$ref': '#/components/parameters/username'
delete:
operationId: deletePackagePermission
summary: Deletes a package permission
tags:
- Packages
responses:
'204':
description: Package permission deleted successfully
'404':
description: Not found
/v2/organizations/{organization_name}:
parameters:
- '$ref': '#/components/parameters/organization_name'
get:
operationId: getOrganization
summary: Returns the organization details
tags:
- Organizations
responses:
'200':
description: Requested organization
content:
application/json:
schema:
'$ref': '#/components/schemas/Organization'
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
description: Not found
put:
operationId: updateOrganization
summary: Update the organization details
tags:
- Organizations
requestBody:
description: Organization details
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdateOrganization'
responses:
'200':
description: Updated organization
content:
application/json:
schema:
'$ref': '#/components/schemas/Organization'
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
description: Not found
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdateOrganizationError'
/v2/organizations/{organization_name}/members:
parameters:
- '$ref': '#/components/parameters/organization_name'
get:
operationId: getOrganizationMembers
summary: Returns a paginated list of members of an organization
tags:
- Organizations
parameters:
- name: after
in: query
required: false
schema:
type: string
x-tie-haskell-type: Scarf.Capability.Parameters.UserId
example: 3kTMd
- '$ref': '#/components/parameters/per_page'
responses:
'200':
description: Members response
content:
application/json:
schema:
type: object
required:
- results
properties:
results:
type: array
items:
'$ref': '#/components/schemas/OrganizationMember'
_links:
'$ref': '#/components/schemas/CursorLinks'
'404':
'$ref': '#/components/responses/LoginNotFound'
'403':
'$ref': '#/components/responses/Unauthorized'
post:
operationId: addOrganizationMember
summary: Adds user to an organization
tags:
- Organizations
requestBody:
description: Member details
content:
application/json:
schema:
'$ref': '#/components/schemas/AddOrganizationMember'
responses:
'201':
description: Member created
content:
application/json:
schema:
'$ref': '#/components/schemas/OrganizationMember'
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
description: Not found
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/UpsertOrganizationMemberError'
/v2/organizations/{organization_name}/members/{organization_member}:
parameters:
- '$ref': '#/components/parameters/organization_name'
- '$ref': '#/components/parameters/organization_member'
get:
operationId: getOrganizationMember
summary: Returns an organization member
tags:
- Organizations
responses:
'200':
description: Member
content:
application/json:
schema:
'$ref': '#/components/schemas/OrganizationMember'
'404':
description: Not found
put:
operationId: updateOrganizationMemberRole
summary: Updates the role of an organization member
tags:
- Organizations
requestBody:
description: New role
content:
application/json:
schema:
'$ref': '#/components/schemas/OrganizationMemberRoleObject'
responses:
'200':
description: Updated role
content:
application/json:
schema:
'$ref': '#/components/schemas/OrganizationMember'
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
description: Not found
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/UpsertOrganizationMemberError'
delete:
operationId: deleteOrganizationMember
summary: Removes the user from the organization
tags:
- Organizations
responses:
'204':
description: Member removed
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
description: Not found
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/DeleteOrganizationMemberError'
/v2/users/{username}:
parameters:
- '$ref': '#/components/parameters/username'
get:
operationId: getUserInformation
summary: Gets user information
tags:
- Users
responses:
'200':
description: User's public information.
content:
application/json:
schema:
'$ref': '#/components/schemas/User'
'404':
description: User not found
'401':
'$ref': '#/components/responses/Unauthorized'
/v2/users/{username}/organizations:
parameters:
- '$ref': '#/components/parameters/username'
get:
parameters:
- '$ref': '#/components/parameters/organization_id'
- '$ref': '#/components/parameters/per_page'
operationId: getUserOrganizations
summary: List the organizations of an user
tags:
- Users
responses:
'200':
description: Organizations
content:
application/json:
schema:
type: object
required:
- results
properties:
results:
type: array
items:
'$ref': '#/components/schemas/OrganizationMembership'
_links:
'$ref': '#/components/schemas/CursorLinks'
'404':
description: User not found
/v2/tracking-pixels/{owner}:
parameters:
- '$ref': '#/components/parameters/owner'
get:
operationId: getTrackingPixels
summary: Returns a paginated list of tracking pixels belonging to the given account
tags:
- Tracking Pixels
parameters:
- name: after
in: query
required: false
schema:
type: string
example: dbba955a-7567-4300-8630-088054db2222
- '$ref': '#/components/parameters/per_page'
responses:
'200':
description: A page of tracking pixels
content:
application/json:
schema:
type: object
required:
- results
properties:
results:
type: array
items:
'$ref': '#/components/schemas/TrackingPixel'
_links:
'$ref': '#/components/schemas/CursorLinks'
'404':
description: Owner not found
post:
operationId: createTrackingPixel
summary: Creates a tracking pixel
tags:
- Tracking Pixels
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/CreateTrackingPixel'
responses:
'201':
description: Created tracking pixel
content:
application/json:
schema:
'$ref': '#/components/schemas/TrackingPixel'
'404':
description: Not found
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/CreateTrackingPixelError'
/v2/tracking-pixels/{owner}/{tracking_pixel_id}:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/tracking_pixel_id'
get:
operationId: getTrackingPixel
summary: Returns the tracking pixel
tags:
- Tracking Pixels
responses:
'200':
description: Tracking pixel
content:
application/json:
schema:
'$ref': '#/components/schemas/TrackingPixel'
'404':
description: Not found
put:
operationId: updateTrackingPixel
summary: Updates a tracking pixel
tags:
- Tracking Pixels
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdateTrackingPixel'
responses:
'200':
description: Updated tracking pixel
content:
application/json:
schema:
'$ref': '#/components/schemas/TrackingPixel'
'404':
description: Pixel not found
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdateTrackingPixelError'
delete:
operationId: deleteTrackingPixel
summary: Deletes a tracking pixel
tags:
- Tracking Pixels
responses:
'204':
description: Tracking pixel deleted successfully
'404':
'$ref': '#/components/responses/LoginNotFound'
'403':
'$ref': '#/components/responses/Unauthorized'
/v2/auto-creation-rules/{owner}:
parameters:
- '$ref': '#/components/parameters/owner'
get:
operationId: getAutoCreationRules
summary: Returns a paginated list of auto-creation rules belonging to the given account
tags:
- Auto Creation Rules
parameters:
- name: after
in: query
required: false
schema:
type: string
x-tie-haskell-type: Scarf.Capability.Parameters.AutoCreationRuleId
example: 3kTMd
- '$ref': '#/components/parameters/per_page'
responses:
'200':
description: A page of auto-creation rules
content:
application/json:
schema:
type: object
required:
- results
- _links
properties:
results:
type: array
items:
'$ref': '#/components/schemas/AutoCreationRule'
_links:
'$ref': '#/components/schemas/CursorLinks'
'404':
'$ref': '#/components/responses/LoginNotFound'
'403':
'$ref': '#/components/responses/Unauthorized'
post:
operationId: createAutoCreationRule
summary: Creates an auto-creation rule
tags:
- Auto Creation Rules
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/CreateAutoCreationRule'
responses:
'201':
description: Created auto-creation rule
content:
application/json:
schema:
'$ref': '#/components/schemas/AutoCreationRule'
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
'$ref': '#/components/responses/LoginNotFound'
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/CreateAutoCreationRuleError'
/v2/auto-creation-rules/{owner}/{auto_creation_rule_id}:
parameters:
- '$ref': '#/components/parameters/owner'
- '$ref': '#/components/parameters/auto_creation_rule_id'
get:
operationId: getAutoCreationRule
summary: Returns the auto-creation rule
tags:
- Auto Creation Rules
responses:
'200':
description: Auto-creation rule
content:
application/json:
schema:
'$ref': '#/components/schemas/AutoCreationRule'
'404':
'$ref': '#/components/responses/LoginNotFound'
'403':
'$ref': '#/components/responses/Unauthorized'
put:
operationId: updateAutoCreationRule
summary: Updates an auto-creation rule
tags:
- Auto Creation Rules
requestBody:
required: true
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdateAutoCreationRule'
responses:
'200':
description: Updated auto-creation rule
content:
application/json:
schema:
'$ref': '#/components/schemas/AutoCreationRule'
'403':
'$ref': '#/components/responses/Unauthorized'
'404':
'$ref': '#/components/responses/LoginNotFound'
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdateAutoCreationRuleError'
delete:
operationId: deleteAutoCreationRule
summary: Deletes an auto-creation rule
tags:
- Auto Creation Rules
responses:
'204':
description: Auto-creation rule deleted successfully
'404':
'$ref': '#/components/responses/LoginNotFound'
'403':
'$ref': '#/components/responses/Unauthorized'
'422':
description: Request is not valid
content:
application/json:
schema:
'$ref': '#/components/schemas/UpdateAutoCreationRuleError'
components:
securitySchemes:
ApiToken:
type: http
scheme: bearer
bearerFormat: JWT
responses:
LoginNotFound:
description: The requested login does not exist
Unauthorized:
description: Unauthorized access
parameters:
username:
name: username
in: path
required: true
schema:
type: string
x-tie-haskell-type: Scarf.Capability.Parameters.UserName
example: johndoe
login:
name: login
in: path
required: true
schema:
type: string
example: johndoe
owner:
name: owner
in: path
required: true
schema:
type: string
example: johndoe
page:
name: page
in: query