Skip to content

Commit 71eee33

Browse files
authored
feat(sdk): automated oas update (#6800)
Co-authored-by: kong[bot] <123129154+kong[bot]@users.noreply.github.com>
1 parent 582aecb commit 71eee33

1 file changed

Lines changed: 49 additions & 10 deletions

File tree

‎api-specs/konnect/mesh-control-planes/v0/openapi.yaml‎

Lines changed: 49 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ openapi: 3.0.3
22
info:
33
title: Konnect Mesh Control Plane manager
44
description: Control Plane manager API
5-
version: 0.1.0
5+
version: 0.2.0
66
x-ref-schema-name: DataplaneOverview
77
contact:
88
name: Kong
@@ -5619,6 +5619,8 @@ paths:
56195619
$ref: '#/components/responses/MeshControlPlaneNotFoundError'
56205620
'409':
56215621
$ref: '#/components/responses/ScanMeshControlPlaneConflictError'
5622+
'501':
5623+
$ref: '#/components/responses/ScanMeshControlPlaneUnsupportedError'
56225624
tags:
56235625
- Mesh
56245626
x-rpc-endpoint: true
@@ -21751,6 +21753,20 @@ components:
2175121753
- result
2175221754
x-internal: true
2175321755
x-unstable: true
21756+
MeshControlPlaneReadinessScanAccepted:
21757+
description: |
21758+
Identifier of the upgrade readiness report this scan writes. Read the report at the Location above once the scan finishes.
21759+
type: object
21760+
properties:
21761+
id:
21762+
description: Identifier of the readiness report this scan writes.
21763+
type: string
21764+
format: uuid
21765+
example: 9a4f2d3e-7c81-4a2b-9f0e-1d5c8b6a3f21
21766+
required:
21767+
- id
21768+
x-internal: true
21769+
x-unstable: true
2175421770
MeshControlPlaneReadinessReportState:
2175521771
description: |
2175621772
How far the scan got, which is separate from what the scan found. While it is running, result and failure_reason are both null. When it has finished, result holds what the scan found and failure_reason stays null. The result then says whether anything blocks the upgrade. When it has failed, the opposite holds: result is null and failure_reason says why, so a consumer must read state before reaching into result.
@@ -22545,6 +22561,21 @@ components:
2254522561
example: 'kong:trace:1234567890'
2254622562
detail:
2254722563
example: Conflict
22564+
NotImplementedError:
22565+
allOf:
22566+
- $ref: '#/components/schemas/BaseError'
22567+
- type: object
22568+
properties:
22569+
status:
22570+
example: 501
22571+
title:
22572+
example: Not Implemented
22573+
type:
22574+
example: 'https://httpstatuses.com/501'
22575+
instance:
22576+
example: 'kong:trace:1234567890'
22577+
detail:
22578+
example: Not Implemented
2254822579
ForbiddenError:
2254922580
allOf:
2255022581
- $ref: '#/components/schemas/BaseError'
@@ -22672,12 +22703,6 @@ components:
2267222703
MeshControlPlaneScanAcceptedExample:
2267322704
value:
2267422705
id: 9a4f2d3e-7c81-4a2b-9f0e-1d5c8b6a3f21
22675-
control_plane_id: bf138ba2-c9b1-4229-b268-04d9d8a6410b
22676-
state: running
22677-
requested_at: '2026-08-07T09:15:04.000Z'
22678-
finished_at: null
22679-
failure_reason: null
22680-
result: null
2268122706
MeshControlPlaneReadinessReportExample:
2268222707
value:
2268322708
id: 9a4f2d3e-7c81-4a2b-9f0e-1d5c8b6a3f21
@@ -24538,7 +24563,7 @@ components:
2453824563
$ref: '#/components/examples/MeshControlPlaneReadinessReportFailedExample'
2453924564
ScanMeshControlPlaneResponse:
2454024565
description: |
24541-
The scan was accepted and runs in the background. The report carries no result until the scan finishes.
24566+
The scan was accepted. The body carries only the id of the report it writes; read the report at the Location below.
2454224567
headers:
2454324568
Location:
2454424569
description: |
@@ -24550,9 +24575,9 @@ components:
2455024575
content:
2455124576
application/json:
2455224577
schema:
24553-
$ref: '#/components/schemas/MeshControlPlaneReadinessReport'
24578+
$ref: '#/components/schemas/MeshControlPlaneReadinessScanAccepted'
2455424579
examples:
24555-
Running Scan:
24580+
Scan Accepted:
2455624581
$ref: '#/components/examples/MeshControlPlaneScanAcceptedExample'
2455724582
ScanMeshControlPlaneValidationError:
2455824583
description: Validation Error
@@ -24587,6 +24612,20 @@ components:
2458724612
title: Conflict
2458824613
instance: 'konnect:trace:2587793459331520595'
2458924614
detail: a scan of this control plane is already running
24615+
ScanMeshControlPlaneUnsupportedError:
24616+
description: Readiness scanning is not supported in this environment.
24617+
content:
24618+
application/problem+json:
24619+
schema:
24620+
$ref: '#/components/schemas/NotImplementedError'
24621+
examples:
24622+
Scanning Unsupported:
24623+
value:
24624+
status: 501
24625+
type: 'https://kongapi.info/konnect/not-implemented'
24626+
title: Not Implemented
24627+
instance: 'konnect:trace:2587793459331520595'
24628+
detail: readiness scanning is not supported in this environment
2459024629
RetrieveMeshControlPlaneResponse:
2459124630
description: A response to creating a control plane.
2459224631
content:

0 commit comments

Comments
 (0)