Skip to content

Commit fdb6324

Browse files
lghiurTyk Bot
authored andcommitted
[TT-15100][TT-15091] adjusted swagger enum and tyk vendor extension schema name (#7535)
- Schema XTykApiGateway is renamed to TykVendorExtension in the schemas section - All $ref references to XTykApiGateway are updated to reference TykVendorExtension - BooleanQueryParam schema has enum removed while preserving type: boolean - All inline boolean parameter enums are removed from the specification <!---TykTechnologies/jira-linter starts here--> ### Ticket Details <details> <summary> <a href="https://tyktech.atlassian.net/browse/TT-15100" title="TT-15100" target="_blank">TT-15100</a> </summary> | | | |---------|----| | Status | Ready for Dev | | Summary | Tyk Dashboard Swagger YAML Schema Discrepancy | Generated at: 2025-11-12 09:34:58 </details> <!---TykTechnologies/jira-linter ends here--> (cherry picked from commit b091f91)
1 parent 9d07f09 commit fdb6324

1 file changed

Lines changed: 10 additions & 26 deletions

File tree

swagger.yml

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -745,7 +745,7 @@ paths:
745745
items:
746746
allOf:
747747
- $ref: https://raw.githubusercontent.com/TykTechnologies/tyk/refs/heads/master/apidef/oas/schema/3.0.json
748-
- $ref: '#/components/schemas/XTykAPIGateway'
748+
- $ref: '#/components/schemas/TykVendorExtension'
749749
type: array
750750
description: List of API definitions in Tyk OAS format.
751751
"403":
@@ -846,7 +846,7 @@ paths:
846846
schema:
847847
allOf:
848848
- $ref: https://raw.githubusercontent.com/TykTechnologies/tyk/refs/heads/master/apidef/oas/schema/3.0.json
849-
- $ref: '#/components/schemas/XTykAPIGateway'
849+
- $ref: '#/components/schemas/TykVendorExtension'
850850
responses:
851851
"200":
852852
content:
@@ -984,7 +984,7 @@ paths:
984984
schema:
985985
allOf:
986986
- $ref: https://raw.githubusercontent.com/TykTechnologies/tyk/refs/heads/master/apidef/oas/schema/3.0.json
987-
- $ref: '#/components/schemas/XTykAPIGateway'
987+
- $ref: '#/components/schemas/TykVendorExtension'
988988
description: OK
989989
headers:
990990
x-tyk-base-api-id:
@@ -1207,7 +1207,7 @@ paths:
12071207
schema:
12081208
allOf:
12091209
- $ref: https://raw.githubusercontent.com/TykTechnologies/tyk/refs/heads/master/apidef/oas/schema/3.0.json
1210-
- $ref: '#/components/schemas/XTykAPIGateway'
1210+
- $ref: '#/components/schemas/TykVendorExtension'
12111211
responses:
12121212
"200":
12131213
content:
@@ -1946,9 +1946,6 @@ paths:
19461946
name: hashed
19471947
required: false
19481948
schema:
1949-
enum:
1950-
- true
1951-
- false
19521949
type: boolean
19531950
requestBody:
19541951
content:
@@ -2051,9 +2048,6 @@ paths:
20512048
name: hashed
20522049
required: false
20532050
schema:
2054-
enum:
2055-
- true
2056-
- false
20572051
type: boolean
20582052
- description: The key ID.
20592053
example: 5e9d9544a1dcd60001d0ed20e7f75f9e03534825b7aef9df749582e5
@@ -2114,9 +2108,6 @@ paths:
21142108
name: hashed
21152109
required: false
21162110
schema:
2117-
enum:
2118-
- true
2119-
- false
21202111
type: boolean
21212112
- description: The key ID.
21222113
example: 5e9d9544a1dcd60001d0ed20e7f75f9e03534825b7aef9df749582e5
@@ -2230,9 +2221,6 @@ paths:
22302221
name: hashed
22312222
required: false
22322223
schema:
2233-
enum:
2234-
- true
2235-
- false
22362224
type: boolean
22372225
- description: Name to give the custom key.
22382226
example: customKey
@@ -2357,9 +2345,6 @@ paths:
23572345
name: hashed
23582346
required: false
23592347
schema:
2360-
enum:
2361-
- true
2362-
- false
23632348
type: boolean
23642349
- description: ID of the key you want to update.
23652350
example: 5e9d9544a1dcd60001d0ed20766d9a6ec6b4403b93a554feefef4708
@@ -4398,9 +4383,6 @@ paths:
43984383
name: block
43994384
required: false
44004385
schema:
4401-
enum:
4402-
- true
4403-
- false
44044386
type: boolean
44054387
responses:
44064388
"200":
@@ -5616,9 +5598,6 @@ components:
56165598
type: string
56175599
type: object
56185600
BooleanQueryParam:
5619-
enum:
5620-
- true
5621-
- false
56225601
example: true
56235602
type: boolean
56245603
CORS:
@@ -7771,7 +7750,7 @@ components:
77717750
oas:
77727751
oneOf:
77737752
- $ref: 'https://raw.githubusercontent.com/TykTechnologies/tyk/refs/heads/master/apidef/oas/schema/3.0.json'
7774-
- $ref: '#/components/schemas/XTykAPIGateway'
7753+
- $ref: '#/components/schemas/TykVendorExtension'
77757754
oneOf:
77767755
- required: [oas]
77777756
- required: [spec]
@@ -8188,6 +8167,11 @@ components:
81888167
upstream:
81898168
$ref: '#/components/schemas/Upstream'
81908169
type: object
8170+
TykVendorExtension:
8171+
properties:
8172+
x-tyk-api-gateway:
8173+
$ref: '#/components/schemas/XTykAPIGateway'
8174+
type: object
81918175
securitySchemes:
81928176
api_key:
81938177
description: Api key

0 commit comments

Comments
 (0)