-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger-new.yaml
2040 lines (1980 loc) · 63.5 KB
/
swagger-new.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'
info:
description: An API driven product management system to facilitate easy management, as well as retrieval and updation of relevant items
version: 1.0.0
title: Genesys
contact:
email: [email protected]
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
# Added by API Auto Mocking Plugin
host: virtserver.swaggerhub.com
basePath: /nikjohn7/Genesys/1.0.0
securityDefinitions:
isRegistered:
# This scheme uses the header: "Authorization: Basic {base64 encoded string defined by username:password}"
# Scopes are not supported with this type of authorization.
type: basic
isProductTeam:
# This scheme uses the header: "X-Custom-Key: {base64 encoded string}"
# Scopes are not supported with this type of authorization.
type: apiKey
in: header
name: X-Custom-Key
hasRole:
# This scheme uses the header: "Authorization: Bearer {base64 encoded string representing a JWT}"
# Alternatively, the query param: "access_token" may be used.
#
# In this system, we must use the query param: "access_token" version in order to avoid passing several headers with key 'Authorization'
type: oauth2
# The flow and URLs in spec are for documentary purpose only
flow: accessCode
authorizationUrl: 'https://dummy.oauth.net/auth'
tokenUrl: 'https://dumy.oauth.net/token'
# Required scopes are passed by the runtime to the authorizer
scopes:
ProductManager: scope of Product Manager
Employee: scope of employees working under the Product Manager
Client: scope of added clients
# Default Security requirements for all operations
security:
- isRegistered: []
tags:
- name: Backlog Details
description: Add, Fetch, Modify and Delete Epics and User Stories from the Product Backlog
- name: Category Details
description: Add, Fetch, Modify and Remove Categories
- name: Product Details
description: Add, Fetch, Modify and Remove Products
- name: Client Details
description: Add, Fetch, Modify and Remove Clients
- name: Search
description: Search the catalog for categories and products via various queries
- name: costUtils
description: Fetch, set, calculate and more operations on prices
- name: Miscellaneous
description: Endpoints that have no concrete functionality, but have semantic relevance
# schemes:
# - http
produces:
- "application/json"
paths:
/:
get:
tags:
- Miscellaneous
summary: Get a list of valid endpoints
description: An endpoint to fetch a list of all accessible endpoints
operationId: GetEndPointList
security: []
responses:
'200':
description: List of all endpoints
schema:
type: object
properties:
listOfEndpoints:
type: array
items:
type: string
/specSheet:
get:
tags:
- Miscellaneous
summary: Download a copy of the swagger spec sheet of this system
description: Download a copy of the swagger spec sheet of this system for further development prospects
operationId: GetSwaggerSpecSheet
security: []
produces:
- text/yaml
responses:
'200':
description: Returns yaml Swagger spec sheet
schema:
type: file
/backlog/epic:
get:
tags:
- Backlog Details
summary: View product Backlog
description: View all epics present in the Backlog
operationId: viewBacklog
security:
- isRegistered: []
responses:
'200':
description: Returns a JSON object with the array of all epics
schema:
type: object
properties:
AllEpics:
type: array
items:
$ref: '#/definitions/Epic'
'400':
description: An error while creating retrieving Backlog
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
post:
tags:
- Backlog Details
summary: Add a new Epic
description: Add a new epic into the Backlog
operationId: addEpic
security:
- isRegistered: []
parameters:
- name: body
in: body
description: Details of the new Epic
required: true
schema:
$ref: '#/definitions/Epic'
responses:
'200':
description: Epic created successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred while creating an Epic
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
put:
tags:
- Backlog Details
summary: Update an Epic
description: Update an existing Epic (make sure the correct epicID is specified)
operationId: updateEpic
security:
- isProductTeam: []
hasRole: [ProductManager]
parameters:
- name: body
in: body
description: Details to be modified in the Epic
required: true
schema:
$ref: '#/definitions/Epic'
responses:
'200':
description: Epic has been successfully updated
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error while updating the Epic
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
/backlog/epic/{epicID}:
get:
tags:
- Backlog Details
summary: Get a particular Epic
description: Fetch all the details of a particular Epic by specifying it's unique ID
operationId: getEpic
security:
- isRegistered: []
parameters:
- name: epicID
in: path
description: Unique ID of the requested Epic
required: true
type: string
responses:
'200':
description: Returns a JSON object with details of the requested Epic
schema:
$ref: '#/definitions/Epic'
'400':
description: A valid Epic ID was not sent along with the request
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
'404':
description: The Epic ID entered does not exist
schema:
$ref: '#/definitions/MessageResponse'
post:
tags:
- Backlog Details
summary: Add a new Epic via a form
description: Add a new Epic by specifying it's unique ID and info in a form
operationId: addEpicForm
security:
- isProductTeam: []
hasRole: [ProductManager, Employee]
consumes:
- application/x-www-form-urlencoded
parameters:
- name: epicID
in: path
description: Unique ID for the Epic
required: true
type: string
- name: Epic Message
in: formData
description: Overview of the feature that the Epic represents
required: true
type: string
responses:
'200':
description: Epic created successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred while creating an Epic
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
delete:
tags:
- Backlog Details
summary: Delete an Epic from Backlog
description: Delete an existing Epic by specifying it's unique ID
operationId: deleteEpic
security:
- isProductTeam: []
hasRole: [ProductManager]
parameters:
- name: epicID
in: path
description: Unique ID for the Epic
required: true
type: string
responses:
'200':
description: Epic deleted successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred while deleting an Epic
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
/backlog/epic/{epicID}/UserStories:
get:
tags:
- Backlog Details
summary: Retrieve all User Stories
description: View all User Stories associated with a particular Epic
operationId: viewUserStories
security:
- isRegistered: []
parameters:
- name: epicID
in: path
description: Unique ID for the Epic
required: true
type: string
responses:
'200':
description: User Stories retrieved successfully
schema:
type: object
properties:
AllStories:
type: array
items:
$ref: '#/definitions/UserStory'
'400':
description: An error while creating retrieving User Stories
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
post:
tags:
- Backlog Details
summary: Add a new User Story
description: Add a new User Story under a specific Epic
operationId: addUserStory
security:
- isRegistered: []
parameters:
- name: epicID
in: path
description: Unique ID of the Epic to be accessed
required: true
type: string
- name: body
in: body
description: Details of the new User Story
required: true
schema:
$ref: '#/definitions/UserStory'
responses:
'200':
description: User Story created successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred while creating the User Story
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
put:
tags:
- Backlog Details
summary: Update an User Story
description: Update an existing User Story under a specific Epic (make sure the correct storyID and epicID is specified)
operationId: updateUserStory
security:
- isProductTeam: []
hasRole: [ProductManager]
parameters:
- name: epicID
in: path
description: Unique ID of the Epic to be accessed
required: true
type: string
- name: body
in: body
description: Details to be modified in the UserStory
required: true
schema:
$ref: '#/definitions/UserStory'
responses:
'200':
description: User Story has been successfully updated
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred while updating the User Story
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
/backlog/epic/{epicID}/UserStories/{storyID}:
get:
tags:
- Backlog Details
summary: Get a particular User Story
description: Fetch all the details of a particular User Story by specifying it's unique ID and its parent Epic ID
operationId: getUserStory
security:
- isRegistered: []
parameters:
- name: storyID
in: path
description: Unique ID of the requested User Story
required: true
type: string
- name: epicID
in: path
description: Unique ID of the Epic under which the User Story is to be added
required: true
type: string
responses:
'200':
description: Returns a JSON object with details of the requested User Story
schema:
$ref: '#/definitions/UserStory'
'400':
description: A valid Story ID was not sent along with the request
schema:
$ref: '#/definitions/MessageResponse'
'404':
description: The Story ID entered does not exist
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
post:
tags:
- Backlog Details
summary: Add a new User Story via a form
description: Add a new User Story by specifying it's unique ID, parent Epic ID and info in a form
operationId: addStoryForm
security:
- isRegistered: []
consumes:
- application/x-www-form-urlencoded
parameters:
- name: storyID
in: path
description: Unique ID of the User Story (with prefix "US")
required: true
type: string
- name: storyDetails
in: formData
description: Specific change/feature to ne implemented
required: true
type: string
- name: epicID
in: path
description: ID of the Epic to which this User Story belongs to (with prefix "EP")
required: true
type: string
- name: status
in: formData
description: The status of the User Story. By default when the User Story is created, the value is set to "Ready"
type: string
default: Ready
enum:
- Ready
- Assigned
- In Progress
- Done
- Tested
- name: module
in: formData
description: The corresponding module/component which this User Story primarily affects
required: true
type: string
enum:
- API
- Database
- UI/UX
- Testing
- Analytics
responses:
'200':
description: User Story created successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred while creating the User Story. Check if conditions for Unique IDs of Epic and User story is satisfied
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
delete:
tags:
- Backlog Details
summary: Delete a User Story from Backlog
description: Delete an existing User Story by specifying it's storyID
operationId: deleteStory
security:
- isProductTeam: []
hasRole: [ProductManager]
parameters:
- name: storyID
in: path
description: Unique ID for the User Story to be deleted
required: true
type: string
- name: epicID
in: path
description: Unique ID of the Epic under which the User Story to be deleted is present
required: true
type: string
responses:
'200':
description: Epic deleted successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred while deleting an Epic. Check if storyID exists
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
/backlog/module/{moduleName}:
get:
tags:
- Backlog Details
summary: Get all the User Stories associated with the specified module
description: Fetch all the User Stories with the same module by specifying the module name
operationId: getModule
security:
- isProductTeam: []
hasRole: [ProductManager, Employee]
parameters:
- name: moduleName
in: path
description: Name of the module
required: true
type: string
enum:
- API
- Database
- UI/UX
- Testing
- Analytics
responses:
'200':
description: User Stories under the specified module retrieved successfully
schema:
type: object
properties:
AllStories:
type: array
items:
$ref: '#/definitions/UserStory'
'400':
description: An error while creating retrieving User Stories
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
'404':
description: The module name entered does not exist
schema:
$ref: '#/definitions/MessageResponse'
/category:
get:
tags:
- Category Details
summary: Get categories based on name
operationId: getCategoriesByName
security:
- isRegistered: []
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: Name string that is used for searching for categories
type: string
responses:
'200':
description: A list of categories satisfying name search
schema:
type: array
items:
$ref: '#/definitions/Category'
'400':
description: An error while creating retrieving products
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
post:
tags:
- Category Details
summary: Add a new category
description: Add a new category of products to database
operationId: createCategory
security:
- isProductTeam: []
hasRole: [ProductManager, Employee]
parameters:
- name: body
in: body
description: Details of the new category
required: true
schema:
$ref: '#/definitions/Category'
responses:
'200':
description: Category was added successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error while creating new category
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
put:
tags:
- Category Details
summary: Update an existing category
description: Request body must contain the category ID and the details to be updated. To remove parent from a category, set parentCategoryID to -1
operationId: updateCategory
security:
- isProductTeam: []
hasRole: [ProductManager, Employee]
parameters:
- name: body
in: body
description: Details of the category to be updated
required: true
schema:
$ref: '#/definitions/Category'
responses:
'200':
description: Category was updated successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred with updating the category
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
'404':
description: No such category exists with the provided category ID
schema:
$ref: '#/definitions/MessageResponse'
/category/{categoryID}:
get:
tags:
- Category Details
summary: Get the details of a specific category
description: Fetch all the details of a category by specifying categoryID
operationId: GetCategory
security:
- isRegistered: []
parameters:
- name: categoryID
in: path
description: Unique ID of the requested category
required: true
type: integer
responses:
'200':
description: Returns a JSON object with details of the category
schema:
$ref: '#/definitions/Category'
'400':
description: A valid category ID was not sent along with the request
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
'404':
description: No such category exists with the provided category ID
schema:
$ref: '#/definitions/MessageResponse'
delete:
tags:
- Category Details
summary: Delete an existing category and all its subcategories
description: Remove a category and all its subcategories and the products associated with them
operationId: deleteCategory
security:
- isProductTeam: []
hasRole: [ProductManager]
parameters:
- name: categoryID
in: path
description: Unique ID of the category to be deleted
required: true
type: integer
responses:
'200':
description: Successfully deleted the category and all of its children
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
'404':
description: No such category exists with the provided category ID
schema:
$ref: '#/definitions/MessageResponse'
post:
tags:
- Category Details
summary: Add a new category via a form
description: Creates a new category with the new categoryId specified in the path
operationId: createCategoryForm
security:
- isProductTeam: []
hasRole: [ProductManager, Employee]
consumes:
- application/x-www-form-urlencoded
parameters:
- name: categoryID
in: path
description: Unique ID for the Category
required: true
type: integer
- name: name
in: formData
description: Name of the Category
required: true
type: string
- name: parentCategoryID
in: formData
description: Category ID of its parent category. Leave blank if no parent
type: integer
responses:
'200':
description: Category was added successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred while creating the new category
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
/product:
get:
tags:
- Product Details
summary: "Get all products based on name"
operationId: "getProductsByName"
security:
- isRegistered: []
hasRole: [Client]
- isProductTeam: []
hasRole: [ProductManager, Employee]
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: name
description: "Name string that is used for searching for products"
type: string
responses:
'200':
description: A list of products satisfying name search
schema:
type: array
items:
$ref: '#/definitions/Category'
'400':
description: An error while creating retrieving products
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
post:
tags:
- Product Details
summary: Add a new product
description: Add a new product to the database
operationId: createProduct
security:
- isProductTeam: []
hasRole: [ProductManager, Employee]
parameters:
- name: body
in: body
description: the details of the new product
required: true
schema:
$ref: '#/definitions/Product'
responses:
'200':
description: Product was added successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error while creating new product
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
put:
tags:
- Product Details
summary: Update an existing product
description: Request body must contain the productSKU and other details to be updated
operationId: updateProduct
security:
- isProductTeam: []
hasRole: [ProductManager, Employee]
parameters:
- name: body
in: body
description: Details of the product to be updated
required: true
schema:
$ref: '#/definitions/Product'
responses:
'200':
description: Product was updated successfully
schema:
$ref: '#/definitions/MessageResponse'
'400':
description: An error occurred with updating the product
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
'404':
description: No such product exists with the provided productSKU
schema:
$ref: '#/definitions/MessageResponse'
/product/{productSKU}:
get:
tags:
- Product Details
summary: Get the details of a product
description: Fetch all the details of a product whose productSKU is specified
operationId: getProduct
security:
- isRegistered: []
hasRole: [Client]
- isProductTeam: []
hasRole: [ProductManager]
parameters:
- name: productSKU
in: path
description: SKU of the requested product
required: true
type: string
responses:
'200':
description: Returns a JSON object with details of the respective product
schema:
$ref: '#/definitions/Product'
'400':
description: A valid productSKU was not sent along with the request
schema:
$ref: '#/definitions/MessageResponse'
'401':
description: Authentication failed due to invalid authentication credentials
schema:
$ref: '#/definitions/MessageResponse'
'403':
description: Authorization failed due to insufficient permissions
schema:
$ref: '#/definitions/MessageResponse'
'404':
description: No such product exists with the provided productSKU
schema:
$ref: '#/definitions/MessageResponse'