mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
120 lines
3.0 KiB
YAML
120 lines
3.0 KiB
YAML
get:
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Get a specified ManagedCluster.
|
|
description: Retrieve a ManagedCluster by ID.
|
|
operationId: getManagedCluster
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: ID of the ManagedCluster to get
|
|
required: true
|
|
style: simple
|
|
explode: false
|
|
schema:
|
|
type: string
|
|
example: aClusterId
|
|
responses:
|
|
"200":
|
|
description: Responds with ManagedCluster having the given ID.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/ManagedCluster.yaml'
|
|
"400":
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
"403":
|
|
$ref: '../../v3/responses/403.yaml'
|
|
"404":
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:remote-client:read, idn:remote-client:manage]
|
|
patch:
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Update a Managed Cluster
|
|
description: >-
|
|
Update an existing Managed Cluster.
|
|
operationId: updateManagedCluster
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The Managed Cluster ID
|
|
example: aClusterId
|
|
requestBody:
|
|
required: true
|
|
description: The JSONPatch payload used to update the schema.
|
|
content:
|
|
application/json-patch+json:
|
|
schema:
|
|
$ref: '../schemas/JsonPatch.yaml'
|
|
responses:
|
|
"200":
|
|
description: The updated Managed Cluster
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/ManagedCluster.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:remote-client:manage]
|
|
delete:
|
|
operationId: deleteManagedCluster
|
|
tags:
|
|
- Managed Clusters
|
|
summary: Delete a Managed Cluster
|
|
description: >-
|
|
Delete an existing Managed Cluster.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The Managed Cluster ID
|
|
example: aClusterId
|
|
- in: query
|
|
name: removeClients
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
required: false
|
|
description: Flag to determine the need to delete a cluster with clients
|
|
example: false
|
|
responses:
|
|
'204':
|
|
$ref: '../../v3/responses/204.yaml'
|
|
description: The Managed Cluster was successfully deleted.
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:remote-client:manage]
|