Skip to content

Commit

Permalink
Update Swagger REST API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@cb-github-robot @web-flow
cb-github-robot authored and web-flow committed Nov 26, 2024
1 parent 88310f7 commit bcef34f
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 42 deletions.
31 changes: 17 additions & 14 deletions src/api/rest/docs/docs.go
View file
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
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

0 comments on commit bcef34f

Please sign in to comment.