Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Workflow] Update Swagger REST API doc #1713

Merged
merged 1 commit into from
Aug 14, 2024
Merged

[Workflow] Update Swagger REST API doc #1713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 46 additions & 1 deletion src/api/rest/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,51 @@ const docTemplate = `{
}
}
},
"/checkNodeGroupsOnK8sCreation": {
"get": {
"description": "Check whether nodegroups are required during the k8scluster creation",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"[Infra resource] K8sCluster management"
],
"summary": "Check whether nodegroups are required during the k8scluster creation",
"operationId": "CheckNodeGroupsOnK8sCreation",
"parameters": [
{
"type": "string",
"description": "Name of the CSP to retrieve",
"name": "providerName",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/common.SimpleMsg"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/common.SimpleMsg"
}
}
}
}
},
"/cloudInfo": {
"get": {
"description": "Get cloud information",
Expand Down Expand Up @@ -9180,7 +9225,7 @@ const docTemplate = `{
"$ref": "#/definitions/common.K8sClusterNodeImageDetail"
}
},
"nodegroups_with_cluster": {
"nodegroups_on_creation": {
"type": "boolean"
},
"root_disks": {
Expand Down
47 changes: 46 additions & 1 deletion src/api/rest/docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,51 @@
}
}
},
"/checkNodeGroupsOnK8sCreation": {
"get": {
"description": "Check whether nodegroups are required during the k8scluster creation",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"[Infra resource] K8sCluster management"
],
"summary": "Check whether nodegroups are required during the k8scluster creation",
"operationId": "CheckNodeGroupsOnK8sCreation",
"parameters": [
{
"type": "string",
"description": "Name of the CSP to retrieve",
"name": "providerName",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/common.SimpleMsg"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/common.SimpleMsg"
}
}
}
}
},
"/cloudInfo": {
"get": {
"description": "Get cloud information",
Expand Down Expand Up @@ -9173,7 +9218,7 @@
"$ref": "#/definitions/common.K8sClusterNodeImageDetail"
}
},
"nodegroups_with_cluster": {
"nodegroups_on_creation": {
"type": "boolean"
},
"root_disks": {
Expand Down
32 changes: 31 additions & 1 deletion src/api/rest/docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ definitions:
items:
$ref: '#/definitions/common.K8sClusterNodeImageDetail'
type: array
nodegroups_with_cluster:
nodegroups_on_creation:
type: boolean
root_disks:
items:
Expand Down Expand Up @@ -3320,6 +3320,36 @@ paths:
summary: Get available kubernetes cluster version
tags:
- '[Infra resource] K8sCluster management'
/checkNodeGroupsOnK8sCreation:
get:
consumes:
- application/json
description: Check whether nodegroups are required during the k8scluster creation
operationId: CheckNodeGroupsOnK8sCreation
parameters:
- description: Name of the CSP to retrieve
in: query
name: providerName
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
type: boolean
"404":
description: Not Found
schema:
$ref: '#/definitions/common.SimpleMsg'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/common.SimpleMsg'
summary: Check whether nodegroups are required during the k8scluster creation
tags:
- '[Infra resource] K8sCluster management'
/cloudInfo:
get:
consumes:
Expand Down