Skip to content

Commit 06a9048

Browse files
authored
feat(sdk): automated oas update (#3716)
Co-authored-by: kong[bot] <123129154+kong[bot]@users.noreply.github.com>
1 parent fd5c0ca commit 06a9048

File tree

1 file changed

+98
-3
lines changed

1 file changed

+98
-3
lines changed

api-specs/konnect/event-gateway/v1/openapi.yaml

Lines changed: 98 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ info:
1414
Additionally, `x-sensitive` flag indicates that a field contains sensitive information. When the value
1515
of the field is provided in plain text, it's encrypted at rest and it's never returned in API responses.
1616
When the value is an expression, the expression itself is stored and returned in API responses.
17+
18+
`x-min-runtime-version` indicates the minimum Event Gateway runtime version required to use a certain policy or
19+
policy feature. The runtime version can be configured at the Event Gateway entity level.
1720
contact:
1821
name: Kong
1922
url: 'https://cloud.konghq.com'
20-
x-oas-source: kong/platform-api@1271ef747690f068287732330269a47c8984b1d9
21-
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/1271ef747690f068287732330269a47c8984b1d9'
23+
x-oas-source: kong/platform-api@6071deefac069662eeb4c62ea0a0ed67eaca705d
24+
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/6071deefac069662eeb4c62ea0a0ed67eaca705d'
2225
servers:
2326
- url: 'https://us.api.konghq.com/v1'
2427
description: United-States Production region
@@ -148,6 +151,33 @@ paths:
148151
$ref: '#/components/responses/NotAvailable'
149152
tags:
150153
- Event Gateways
154+
patch:
155+
operationId: patch-event-gateway
156+
summary: Partially Update Event Gateway
157+
description: Patch an individual gateway.
158+
requestBody:
159+
required: true
160+
content:
161+
application/json:
162+
schema:
163+
$ref: '#/components/schemas/PatchGatewayRequest'
164+
responses:
165+
'200':
166+
$ref: '#/components/responses/UpdateGatewayResponse'
167+
'400':
168+
$ref: '#/components/responses/BadRequest'
169+
'401':
170+
$ref: '#/components/responses/Unauthorized'
171+
'403':
172+
$ref: '#/components/responses/Forbidden'
173+
'404':
174+
$ref: '#/components/responses/NotFound'
175+
'500':
176+
$ref: '#/components/responses/Internal'
177+
'503':
178+
$ref: '#/components/responses/NotAvailable'
179+
tags:
180+
- Event Gateways
151181
delete:
152182
operationId: delete-event-gateway
153183
summary: Delete Event Gateway
@@ -1627,12 +1657,14 @@ components:
16271657
virtual_clusters_total:
16281658
description: The total number of virtual clusters associated with the Event Gateway.
16291659
type: integer
1660+
min_runtime_version:
1661+
$ref: '#/components/schemas/MinRuntimeVersion'
16301662
version:
16311663
description: |
16321664
The version number of the event gateway. Every change to an entity
16331665
under this gateway will modify the version.
16341666
type: string
1635-
example: v1_123
1667+
example: v1.123
16361668
additionalProperties: false
16371669
required:
16381670
- id
@@ -1641,6 +1673,7 @@ components:
16411673
- updated_at
16421674
- nodes_total
16431675
- virtual_clusters_total
1676+
- min_runtime_version
16441677
- version
16451678
x-examples:
16461679
Example 1:
@@ -1779,6 +1812,7 @@ components:
17791812
description: The unique identifier of the virtual cluster.
17801813
type: string
17811814
format: uuid
1815+
minLength: 1
17821816
required:
17831817
- id
17841818
VirtualClusterReferenceByName:
@@ -2122,6 +2156,7 @@ components:
21222156
description: The unique identifier of the backend cluster.
21232157
type: string
21242158
format: uuid
2159+
minLength: 1
21252160
required:
21262161
- id
21272162
BackendClusterReferenceByName:
@@ -2502,6 +2537,7 @@ components:
25022537
description: The unique identifier of the schema registry.
25032538
type: string
25042539
format: uuid
2540+
minLength: 1
25052541
required:
25062542
- id
25072543
SchemaRegistryReferenceByName:
@@ -3881,6 +3917,7 @@ components:
38813917
description: The ID of the static key defined in the key source.
38823918
type: string
38833919
format: uuid
3920+
minLength: 1
38843921
required:
38853922
- id
38863923
EncryptionKeyStaticReferenceByName:
@@ -4611,6 +4648,14 @@ components:
46114648
maxLength: 63
46124649
maxProperties: 50
46134650
title: Labels
4651+
MinRuntimeVersion:
4652+
description: |
4653+
The minimum runtime version supported by the API. This is the lowest version of the data plane
4654+
release that can be used with the entity model.
4655+
When not specified, the minimum runtime version will be pinned to the latest available release.
4656+
type: string
4657+
example: '1.1'
4658+
pattern: ^\d+\.\d+$
46144659
CreateGatewayRequest:
46154660
description: The request schema for the create gateway request.
46164661
type: object
@@ -4619,6 +4664,8 @@ components:
46194664
$ref: '#/components/schemas/GatewayName'
46204665
description:
46214666
$ref: '#/components/schemas/GatewayDescription'
4667+
min_runtime_version:
4668+
$ref: '#/components/schemas/MinRuntimeVersion'
46224669
labels:
46234670
$ref: '#/components/schemas/Labels'
46244671
additionalProperties: false
@@ -4655,6 +4702,14 @@ components:
46554702
example: 'kong:trace:1234567890'
46564703
detail:
46574704
example: Conflict
4705+
MinRuntimeVersionUpdate:
4706+
description: |
4707+
The minimum runtime version supported by the API. This is the lowest version of the data plane
4708+
release that can be used with the entity model.
4709+
When not specified, the minimum runtime version will not be updated.
4710+
type: string
4711+
example: '1.1'
4712+
pattern: ^\d+\.\d+$
46584713
UpdateGatewayRequest:
46594714
description: The request schema for the update gateway request.
46604715
type: object
@@ -4663,10 +4718,50 @@ components:
46634718
$ref: '#/components/schemas/GatewayName'
46644719
description:
46654720
$ref: '#/components/schemas/GatewayDescription'
4721+
min_runtime_version:
4722+
$ref: '#/components/schemas/MinRuntimeVersionUpdate'
46664723
labels:
46674724
$ref: '#/components/schemas/Labels'
46684725
additionalProperties: false
46694726
title: UpdateGatewayRequest
4727+
PatchGatewayRequest:
4728+
description: The request schema for the patch gateway request.
4729+
type: object
4730+
properties:
4731+
name:
4732+
$ref: '#/components/schemas/GatewayName'
4733+
description:
4734+
description: A human-readable description of the Gateway.
4735+
type: string
4736+
maxLength: 512
4737+
nullable: true
4738+
min_runtime_version:
4739+
description: |
4740+
The minimum runtime version supported by the API. This is the lowest version of the data plane
4741+
release that can be used with the entity model.
4742+
When not specified, the minimum runtime version will not be updated.
4743+
type: string
4744+
example: '1.1'
4745+
nullable: true
4746+
pattern: ^\d+\.\d+$
4747+
labels:
4748+
description: |
4749+
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
4750+
4751+
Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
4752+
type: object
4753+
example:
4754+
env: test
4755+
additionalProperties:
4756+
type: string
4757+
pattern: '^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$'
4758+
minLength: 1
4759+
maxLength: 63
4760+
maxProperties: 50
4761+
nullable: true
4762+
title: Labels
4763+
additionalProperties: false
4764+
title: PatchGatewayRequest
46704765
CreatedAt:
46714766
description: An ISO-8601 timestamp representation of entity creation date.
46724767
type: string

0 commit comments

Comments
 (0)