forked from postmanlabs/swagger2-postman2
-
Notifications
You must be signed in to change notification settings - Fork 3
/
swagger1.yaml
1006 lines (959 loc) · 23.4 KB
/
swagger1.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
---
swagger: '2.0'
################################################################################
# API Information #
################################################################################
info:
version: v1
title: API
description: |
termsOfService: http://xyz.in/about/legal/terms/api
################################################################################
# Host, Base Path, Schemes and Content Types #
################################################################################
host: localhost:8080
basePath: /api/v1
schemes:
- http
produces:
- application/json
consumes:
- appication/x-www-form-urlencoded
################################################################################
# Tags #
################################################################################
tags:
- name: Source
- name: Users
- name: Roles
- name: Capabilities
- name: Mapping
description: |
Mapping can be performed in one of the two ways
* Users and Roles alotted to the users.
* Roles and capabilities alloted to the roles.
- name: Transaction
################################################################################
# Security #
################################################################################
securityDefinitions:
key:
type: apiKey
in: query
name: api_key
################################################################################
# Parameters #
################################################################################
parameters:
source-id:
name: source-id
in: path
description: The source identifier number
type: integer
required: true
user-id:
name: user-id
in: path
description: The user identifier number
type: integer
required: true
tag-name:
name: tag-name
in: path
description: Tag name
type: string
required: true
################################################################################
# Paths #
################################################################################
paths:
/source/:
get:
tags:
- Source
description: Get information about all sources.
responses:
200:
description: The source object
schema:
type: array
items:
$ref: '#/definitions/Source'
post:
tags:
- Source
description: Add a source.
consumes:
- application/x-www-form-urlencoded
parameters:
- name: source_name
in: formData
description: New source name
required: true
type: string
- name: parent_source_id
in: formData
description: Parent Source ID
required: true
type: integer
responses:
201:
description: Created
schema:
type: object
properties:
id:
type: integer
/source/{source-id}:
get:
parameters:
- $ref: '#/parameters/source-id'
tags:
- Source
description: Get basic information about a source.
responses:
200:
description: The source object
schema:
type: array
items:
$ref: '#/definitions/Source'
delete:
parameters:
- $ref: '#/parameters/source-id'
tags:
- Source
description: Deletes source based on its ID.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
/users/:
get:
tags:
- Users
description: Get information about all users.
responses:
200:
description: The user object
schema:
type: array
items:
$ref: '#/definitions/User'
post:
tags:
- Users
description: Add a user.
consumes:
- application/x-www-form-urlencoded
parameters:
- name: name
in: formData
description: New user name
required: true
type: string
- name: client_id
in: formData
description: Client ID
required: true
type: integer
- name: user_source_id
in: formData
description: Source ID for user
required: true
type: integer
- name: address
in: formData
description: User address
required: false
type: string
- name: address_type
in: formData
description: User address type
required: false
type: string
- name: locality_id
in: formData
description: Locality ID
required: false
type: integer
- name: phone
in: formData
description: User's phone number
required: false
type: integer
- name: email
in: formData
description: User's email address
required: false
type: string
responses:
201:
description: Created
schema:
type: object
properties:
id:
type: integer
/users/{user-id}:
get:
parameters:
- $ref: '#/parameters/user-id'
tags:
- Users
description: Get basic information about a user.
responses:
200:
description: The user object
schema:
type: array
items:
$ref: '#/definitions/User'
put:
parameters:
- $ref: '#/parameters/user-id'
- name: name
in: formData
description: New user name
type: string
required: true
tags:
- Users
description: Update user name based on his ID.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
delete:
parameters:
- $ref: '#/parameters/user-id'
tags:
- Users
description: Delete user based on his ID.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
/users/lookup:
get:
tags:
- Users
description: Get user id using user's mobile number or email. Atleast one parameter must be passed.
parameters:
- name: phone
in: formData
description: User's phone number.
type: integer
- name: email
in: formData
description: User's email.
type: string
responses:
200:
description: OK
schema:
type: object
properties:
user_id:
type: integer
/users/merge:
put:
parameters:
- name: email
in: formData
required: true
description: User's email address
type: string
- name: phone
in: formData
required: true
description: User's phone number
type: integer
tags:
- Users
description: Merge users together based on email and phone number.
responses:
200:
description: Merged
/users/restaurant/{restaurant-id}:
get:
tags:
- Users
description: |
See the list of users belonging to a restaurant based on `restaurant-id`.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/User'
parameters:
- name: restaurant-id
in: path
description: Restaurant ID.
type: integer
required: true
/users/source/{source-id}:
get:
tags:
- Users
description: |
See the list of users belonging to a restaurant based on `source-id`.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/User'
parameters:
- name: source-id
in: path
description: Source ID.
type: integer
required: true
/address/{address-id}:
get:
parameters:
- name: address-id
in: path
description: User's address ID
type: integer
required: true
description: |
Get address details of the user based on his address ID.
tags:
- Users
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Address'
put:
parameters:
- name: address-id
in: path
description: User's address ID
type: integer
required: true
tags:
- Users
responses:
200:
description: |
OK
schema:
type: object
properties:
message:
type: string
delete:
parameters:
- name: address-id
in: path
description: User's address ID
type: integer
required: true
tags:
- Users
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
/users/restaurant/{restaurant-id}/transactions:
get:
tags:
- Transaction
description: List of Transactions made by users for a specific restaurant.
parameters:
- name: restaurant-id
in: path
description: Restaurant's ID for which transactions need to be returned.
type: integer
required: true
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Transaction'
/users/{user-id}/transactions:
parameters:
- name: user-id
in: path
description: User's ID
type: integer
required: true
get:
tags:
- Transaction
description: List of Transactions made by User across LT platform based on phone number or email. Atleast one parameter is required.
parameters:
- name: phone
in: formData
description: User's phone number.
type: integer
- name: email
in: formData
description: User's email address
type: string
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Transaction'
post:
tags:
- Transaction
description: Add a new transaction to the user based on `user-id` and return a `transaction-id`.
parameters:
- name: transaction-date
in: formData
description: Date of transaction.
type: string
- name: outlet-id
in: formData
description: Outlet's ID
type: integer
responses:
201:
description: Created
schema:
type: object
properties:
id:
type: integer
/capabilities:
get:
tags:
- Capabilities
description: |
List all the available capabilities.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Capabilities'
post:
tags:
- Capabilities
description: |
Generate a new capability
parameters:
- name: name
in: formData
required: true
description: Name of capability
type: string
responses:
201:
description: Created
schema:
type: object
properties:
id:
type: integer
/capabilities/{capability-id}:
parameters:
- name: capability-id
in: path
required: true
description: Capability ID
type: integer
get:
tags:
- Capabilities
description: |
Get a specific Capability.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Capabilities'
put:
parameters:
- name: name
in: formData
required: true
description: New name for capability
type: string
tags:
- Capabilities
description: |
Update a capability based on its `capability-id`.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
delete:
tags:
- Capabilities
description: |
Delete a capability based on its `capability-id`.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
/roles:
get:
tags:
- Roles
description: |
List all the available roles.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Roles'
post:
tags:
- Roles
description: Generate a new role
parameters:
- name: name
in: formData
description: Name of the new role.
type: string
responses:
201:
description: Created
schema:
type: object
properties:
id:
type: integer
/roles/{role-id}:
parameters:
- name: role-id
in: path
required: true
description: Role ID
type: integer
get:
tags:
- Roles
description: |
Get a specific Role based on its `role-id`.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Roles'
put:
parameters:
- name: name
in: formData
required: true
description: New name for role
type: string
tags:
- Roles
description: |
Update a role based on its `role-id`.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
delete:
tags:
- Roles
description: |
Delete a role based on its `role-id`.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
/users/{user-id}/roles:
parameters:
- name: user-id
description: user identifier number
in: path
type: integer
required: true
get:
tags:
- Mapping
description: |
List all the available roles for the user identified by `user-id`.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Roles'
post:
parameters:
- name: role-name
in: formData
type: string
description: Name of the role
- name: role-id
in: formData
type: integer
description: Role ID
tags:
- Mapping
description: |
Assign roles to a user based on `role-id` or `role-name`. Atleast one parameter needs to be provided.
responses:
201:
description: Created
delete:
tags:
- Mapping
description: |
Delete all roles assigned to a user based on `user-id`.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
/users/{user-id}/roles/{role-id}:
get:
parameters:
- name: user-id
description: user identifier number
in: path
type: integer
required: true
- name: role-id
in: path
type: integer
description: role identifier number
required: true
tags:
- Mapping
description: |
Show a role assigned to a user based on `role-id`.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Roles'
delete:
parameters:
- name: user-id
description: user identifier number
in: path
type: integer
required: true
- name: role-id
in: path
type: integer
description: role identifier number
required: true
tags:
- Mapping
description: |
Delete a role assigned to a user based on `role-id`.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
/roles/{role-id}/capabilities:
parameters:
- name: role-id
description: role identifier number
in: path
type: integer
required: true
get:
tags:
- Mapping
description: |
List all the available capabilities for the role identified by `role-id`.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Capabilities'
post:
parameters:
- name: capability-name
in: formData
type: string
description: Name of the capability
- name: capability-id
in: formData
type: integer
description: Capability ID
tags:
- Mapping
description: |
Assign capabilities to a role based on `capability-id` or `capability-name`. Atleast one parameter needs to be provided.
responses:
201:
description: Created
delete:
tags:
- Mapping
description: |
Delete all capabilities assigned to the role based on `role-id`.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
/roles/{role-id}/capabilities/{capability-id}:
get:
parameters:
- name: role-id
description: role identifier number
in: path
type: integer
required: true
- name: capability-id
in: path
type: integer
description: capability identifier number
required: true
tags:
- Mapping
description: |
Show a capability assigned to a role based on `capability-id`.
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Capabilities'
delete:
parameters:
- name: role-id
description: role identifier number
in: path
type: integer
required: true
- name: capability-id
in: path
type: integer
description: Capability ID
required: true
tags:
- Mapping
description: |
Delete a capability assigned to a role based on `capability-id`.
responses:
200:
description: OK
schema:
type: object
properties:
message:
type: string
################################################################################
# Definitions #
################################################################################
definitions:
Source:
type: object
properties:
id:
type: integer
source_name:
type: string
parent_source_id:
type: integer
created_at:
format: date-time
updated_at:
format: date-time
User:
type: object
properties:
id:
type: integer
client_id:
type: integer
user_source_id:
type: integer
name:
type: string
status:
type: string
user_account_id:
type: integer
user_account_type:
type: string
created_at:
format: date-time
updated_at:
format: date-time
deleted_at:
format: date-time
Address:
type: object
properties:
id:
type: integer
user_id:
type: integer
address:
type: string
address_type:
type: string
locality_id:
type: integer
status:
type: string
created_at:
format: date-time
updated_at:
format: date-time
deleted_at:
format: date-time
Email:
type: object
properties:
id:
type: string
user_id:
type: integer
user_email:
type: string
status:
type: string
created_at:
format: date-time
deleted_at:
format: date-time
Phone:
type: object
properties:
id:
type: integer
user_id:
type: integer
user_phone_number:
type: integer
status:
type: string
created_at:
format: date-time
deleted_at:
format: date-time
Transaction:
type: object
properties:
id:
type: integer
user_id:
type: integer
user_address_id:
type: integer
source_id:
type: integer
user_phone_number_id:
type: integer
user_email_id:
type: integer
outlet_id:
type: integer
transaction_date:
format: date
created_at:
format: date-time
updated_at:
format: date-time
Roles:
type: object
properties:
id:
type: integer
name:
type: string
created_at:
format: date-time
updated_at:
format: date-time
deleted_at:
format: date-time
Capabilities:
type: object
properties:
id:
type: integer
name:
type: string
created_at:
format: date-time
updated_at:
format: date-time
deleted_at:
format: date-time
User_Role_Mappings:
type: object
properties:
user_id:
type: integer
role_id:
type: integer
Role_Capability_Mappings: