Skip to content

Commit c9c5cf2

Browse files
bw-tribalbw-tribal
authored
update swagger doc to make api version mandatory (#4049)
* update swagger doc to make api version mandatory * update required status on root endpoints for api version
1 parent 9b94688 commit c9c5cf2

File tree

1 file changed

+72
-21
lines changed

1 file changed

+72
-21
lines changed

‎certified-connectors/Tribal - Platform/apiDefinition.swagger.json‎

Lines changed: 72 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,16 @@
320320
"in": "query",
321321
"required": false,
322322
"type": "string"
323+
},
324+
{
325+
"name": "api-version",
326+
"in": "query",
327+
"required": false,
328+
"type": "string",
329+
"x-ms-summary": "API Version",
330+
"description": "The API version to use for this request"
323331
}
332+
324333
],
325334
"responses": {
326335
"200": {
@@ -380,6 +389,14 @@
380389
"in": "path",
381390
"required": true,
382391
"type": "string"
392+
},
393+
{
394+
"name": "api-version",
395+
"in": "query",
396+
"required": false,
397+
"type": "string",
398+
"x-ms-summary": "API Version",
399+
"description": "The API version to use for this request"
383400
}
384401
],
385402
"responses": {
@@ -525,6 +542,14 @@
525542
"required": true,
526543
"x-ms-visibility": "important",
527544
"type": "string"
545+
},
546+
{
547+
"name": "api-version",
548+
"in": "query",
549+
"required": false,
550+
"type": "string",
551+
"x-ms-summary": "API Version",
552+
"description": "The API version to use for this request"
528553
}
529554
],
530555
"responses": {
@@ -573,6 +598,14 @@
573598
"required": true,
574599
"x-ms-visibility": "important",
575600
"type": "string"
601+
},
602+
{
603+
"name": "api-version",
604+
"in": "query",
605+
"required": false,
606+
"type": "string",
607+
"x-ms-summary": "API Version",
608+
"description": "The API version to use for this request"
576609
}
577610
],
578611
"responses": {
@@ -658,7 +691,8 @@
658691
"service": {
659692
"parameter": "service"
660693
},
661-
"actionType": "Create"
694+
"actionType": "Create",
695+
"api-version": { "parameter": "api-version" }
662696
}
663697
},
664698
"x-ms-url-encoding": "single",
@@ -838,7 +872,8 @@
838872
"service": {
839873
"parameter": "service"
840874
},
841-
"actionType": "ReadCollection"
875+
"actionType": "ReadCollection",
876+
"api-version": { "parameter": "api-version" }
842877
}
843878
},
844879
"x-ms-url-encoding": "single",
@@ -967,7 +1002,8 @@
9671002
"service": {
9681003
"parameter": "service"
9691004
},
970-
"actionType": "Read"
1005+
"actionType": "Read",
1006+
"api-version": { "parameter": "api-version" }
9711007
}
9721008
},
9731009
"x-ms-url-encoding": "single",
@@ -1052,7 +1088,8 @@
10521088
"service": {
10531089
"parameter": "service"
10541090
},
1055-
"actionType": "Update"
1091+
"actionType": "Update",
1092+
"api-version": { "parameter": "api-version" }
10561093
}
10571094
},
10581095
"x-ms-url-encoding": "single",
@@ -1233,7 +1270,8 @@
12331270
"service": {
12341271
"parameter": "service"
12351272
},
1236-
"actionType": "Delete"
1273+
"actionType": "Delete",
1274+
"api-version": { "parameter": "api-version" }
12371275
}
12381276
},
12391277
"x-ms-url-encoding": "single",
@@ -1318,7 +1356,8 @@
13181356
"parameters": {
13191357
"service": {
13201358
"parameter": "service"
1321-
}
1359+
},
1360+
"api-version": { "parameter": "api-version" }
13221361
}
13231362
},
13241363
"x-ms-url-encoding": "single",
@@ -1439,7 +1478,8 @@
14391478
"service": {
14401479
"parameter": "service"
14411480
},
1442-
"actionType": "Create"
1481+
"actionType": "Create",
1482+
"api-version": { "parameter": "api-version" }
14431483
}
14441484
},
14451485
"x-ms-url-encoding": "single",
@@ -1473,7 +1513,8 @@
14731513
},
14741514
"parentEntity": {
14751515
"parameter": "parentEntity"
1476-
}
1516+
},
1517+
"api-version": { "parameter": "api-version" }
14771518
}
14781519
},
14791520
"x-ms-url-encoding": "single",
@@ -1662,10 +1703,11 @@
16621703
"value-path": "name",
16631704
"value-title": "description",
16641705
"parameters": {
1665-
"service": {
1666-
"parameter": "service"
1667-
},
1668-
"actionType": "ReadCollection"
1706+
"service": {
1707+
"parameter": "service"
1708+
},
1709+
"actionType": "ReadCollection",
1710+
"api-version": { "parameter": "api-version" }
16691711
}
16701712
},
16711713
"x-ms-url-encoding": "single",
@@ -1699,7 +1741,8 @@
16991741
},
17001742
"parentEntity": {
17011743
"parameter": "parentEntity"
1702-
}
1744+
},
1745+
"api-version": { "parameter": "api-version" }
17031746
}
17041747
},
17051748
"x-ms-url-encoding": "single",
@@ -1841,7 +1884,8 @@
18411884
"service": {
18421885
"parameter": "service"
18431886
},
1844-
"actionType": "Read"
1887+
"actionType": "Read",
1888+
"api-version": { "parameter": "api-version" }
18451889
}
18461890
},
18471891
"x-ms-url-encoding": "single",
@@ -1875,7 +1919,8 @@
18751919
},
18761920
"parentEntity": {
18771921
"parameter": "parentEntity"
1878-
}
1922+
},
1923+
"api-version": { "parameter": "api-version" }
18791924
}
18801925
},
18811926
"x-ms-url-encoding": "single",
@@ -1976,7 +2021,8 @@
19762021
"service": {
19772022
"parameter": "service"
19782023
},
1979-
"actionType": "Delete"
2024+
"actionType": "Delete",
2025+
"api-version": { "parameter": "api-version" }
19802026
}
19812027
},
19822028
"x-ms-url-encoding": "single",
@@ -2008,7 +2054,8 @@
20082054
},
20092055
"parentEntity": {
20102056
"parameter": "parentEntity"
2011-
}
2057+
},
2058+
"api-version": { "parameter": "api-version" }
20122059
}
20132060
},
20142061
"x-ms-url-encoding": "single",
@@ -2093,7 +2140,8 @@
20932140
"service": {
20942141
"parameter": "service"
20952142
},
2096-
"actionType": "Update"
2143+
"actionType": "Update",
2144+
"api-version": { "parameter": "api-version" }
20972145
}
20982146
},
20992147
"x-ms-url-encoding": "single",
@@ -2127,7 +2175,8 @@
21272175
},
21282176
"parentEntity": {
21292177
"parameter": "parentEntity"
2130-
}
2178+
},
2179+
"api-version": { "parameter": "api-version" }
21312180
}
21322181
},
21332182
"x-ms-url-encoding": "single",
@@ -2302,7 +2351,8 @@
23022351
"parameters": {
23032352
"service": {
23042353
"parameter": "service"
2305-
}
2354+
},
2355+
"api-version": { "parameter": "api-version" }
23062356
}
23072357
},
23082358
"x-ms-url-encoding": "single",
@@ -2335,7 +2385,8 @@
23352385
},
23362386
"service": {
23372387
"parameter": "service"
2338-
}
2388+
},
2389+
"api-version": { "parameter": "api-version" }
23392390
}
23402391
},
23412392
"x-ms-url-encoding": "single",

0 commit comments

Comments
 (0)