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 #1945

Merged
merged 1 commit into from
Nov 26, 2024
Merged

[Workflow] Update Swagger REST API doc #1945

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
31 changes: 17 additions & 14 deletions src/api/rest/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2161,7 +2161,7 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -2778,7 +2778,7 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -2830,7 +2830,7 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -2887,7 +2887,7 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -2950,15 +2950,15 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
"required": true
},
{
"type": "string",
"default": "k8snodegroup-01",
"default": "k8snodegroup01",
"description": "K8sNodeGroup Name",
"name": "k8sNodeGroupName",
"in": "path",
Expand Down Expand Up @@ -3015,15 +3015,15 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
"required": true
},
{
"type": "string",
"default": "ng-01",
"default": "nodegroup01",
"description": "K8sNodeGroup Name",
"name": "k8sNodeGroupName",
"in": "path",
Expand Down Expand Up @@ -3086,15 +3086,15 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
"required": true
},
{
"type": "string",
"default": "ng-01",
"default": "nodegroup01",
"description": "K8sNodeGroup Name",
"name": "k8sNodeGroupName",
"in": "path",
Expand Down Expand Up @@ -3157,14 +3157,14 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
"required": true
},
{
"description": "Request body to provision K8sNodeGroup dynamically. \u003cbr\u003e Must include commonSpec and commonImage info. \u003cbr\u003e (ex: {name: k8snodegroup-01, commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]}) \u003cbr\u003e You can use /k8sClusterRecommendNode and /k8sClusterDynamicCheckRequest to get it. \u003cbr\u003e Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913",
"description": "Request body to provision K8sNodeGroup dynamically. \u003cbr\u003e Must include commonSpec and commonImage info. \u003cbr\u003e (ex: {name: k8snodegroup01, commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]}) \u003cbr\u003e You can use /k8sClusterRecommendNode and /k8sClusterDynamicCheckRequest to get it. \u003cbr\u003e Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913",
"name": "k8sNodeGroupDynamicReq",
"in": "body",
"required": true,
Expand Down Expand Up @@ -3226,7 +3226,7 @@ const docTemplate = `{
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -3288,7 +3288,7 @@ const docTemplate = `{
"required": true
},
{
"description": "Request body to provision K8sCluster dynamically. \u003cbr\u003e Must include commonSpec and commonImage info. \u003cbr\u003e (ex: {name: k8scluster-01, commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]}) \u003cbr\u003e You can use /k8sClusterRecommendNode and /k8sClusterDynamicCheckRequest to get it. \u003cbr\u003e Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913",
"description": "Request body to provision K8sCluster dynamically. \u003cbr\u003e Must include commonSpec and commonImage info. \u003cbr\u003e (ex: {name: k8scluster01, commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]}) \u003cbr\u003e You can use /k8sClusterRecommendNode and /k8sClusterDynamicCheckRequest to get it. \u003cbr\u003e Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913",
"name": "k8sClusterDyanmicReq",
"in": "body",
"required": true,
Expand Down Expand Up @@ -11767,6 +11767,9 @@ const docTemplate = `{
"$ref": "#/definitions/model.K8sClusterNodeImageDetail"
}
},
"nodegroup_naming_rule": {
"type": "string"
},
"nodegroups_on_creation": {
"type": "boolean"
},
Expand Down
31 changes: 17 additions & 14 deletions src/api/rest/docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2154,7 +2154,7 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -2771,7 +2771,7 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -2823,7 +2823,7 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -2880,7 +2880,7 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -2943,15 +2943,15 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
"required": true
},
{
"type": "string",
"default": "k8snodegroup-01",
"default": "k8snodegroup01",
"description": "K8sNodeGroup Name",
"name": "k8sNodeGroupName",
"in": "path",
Expand Down Expand Up @@ -3008,15 +3008,15 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
"required": true
},
{
"type": "string",
"default": "ng-01",
"default": "nodegroup01",
"description": "K8sNodeGroup Name",
"name": "k8sNodeGroupName",
"in": "path",
Expand Down Expand Up @@ -3079,15 +3079,15 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
"required": true
},
{
"type": "string",
"default": "ng-01",
"default": "nodegroup01",
"description": "K8sNodeGroup Name",
"name": "k8sNodeGroupName",
"in": "path",
Expand Down Expand Up @@ -3150,14 +3150,14 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
"required": true
},
{
"description": "Request body to provision K8sNodeGroup dynamically. \u003cbr\u003e Must include commonSpec and commonImage info. \u003cbr\u003e (ex: {name: k8snodegroup-01, commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]}) \u003cbr\u003e You can use /k8sClusterRecommendNode and /k8sClusterDynamicCheckRequest to get it. \u003cbr\u003e Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913",
"description": "Request body to provision K8sNodeGroup dynamically. \u003cbr\u003e Must include commonSpec and commonImage info. \u003cbr\u003e (ex: {name: k8snodegroup01, commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]}) \u003cbr\u003e You can use /k8sClusterRecommendNode and /k8sClusterDynamicCheckRequest to get it. \u003cbr\u003e Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913",
"name": "k8sNodeGroupDynamicReq",
"in": "body",
"required": true,
Expand Down Expand Up @@ -3219,7 +3219,7 @@
},
{
"type": "string",
"default": "k8scluster-01",
"default": "k8scluster01",
"description": "K8sCluster ID",
"name": "k8sClusterId",
"in": "path",
Expand Down Expand Up @@ -3281,7 +3281,7 @@
"required": true
},
{
"description": "Request body to provision K8sCluster dynamically. \u003cbr\u003e Must include commonSpec and commonImage info. \u003cbr\u003e (ex: {name: k8scluster-01, commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]}) \u003cbr\u003e You can use /k8sClusterRecommendNode and /k8sClusterDynamicCheckRequest to get it. \u003cbr\u003e Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913",
"description": "Request body to provision K8sCluster dynamically. \u003cbr\u003e Must include commonSpec and commonImage info. \u003cbr\u003e (ex: {name: k8scluster01, commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]}) \u003cbr\u003e You can use /k8sClusterRecommendNode and /k8sClusterDynamicCheckRequest to get it. \u003cbr\u003e Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913",
"name": "k8sClusterDyanmicReq",
"in": "body",
"required": true,
Expand Down Expand Up @@ -11760,6 +11760,9 @@
"$ref": "#/definitions/model.K8sClusterNodeImageDetail"
}
},
"nodegroup_naming_rule": {
"type": "string"
},
"nodegroups_on_creation": {
"type": "boolean"
},
Expand Down
Loading