From 78e3a375b6bae155e22f9344fe1353c60e8276a6 Mon Sep 17 00:00:00 2001 From: cb-github-robot Date: Fri, 1 Nov 2024 10:38:23 +0000 Subject: [PATCH] Update Swagger REST API doc --- src/api/rest/docs/docs.go | 12 ++++++------ src/api/rest/docs/swagger.json | 12 ++++++------ src/api/rest/docs/swagger.yaml | 12 ++++++------ 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go index 195289f4..a3a6bb33 100644 --- a/src/api/rest/docs/docs.go +++ b/src/api/rest/docs/docs.go @@ -930,7 +930,7 @@ const docTemplate = `{ "[Kubernetes] Cluster Management" ], "summary": "Recommend K8sCluster's Node plan (filter and priority)", - "operationId": "RecommendNode", + "operationId": "RecommendK8sNode", "parameters": [ { "description": "Recommend K8sCluster's Node plan (filter and priority)", @@ -3213,7 +3213,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/1570", + "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", "name": "k8sclusterReq", "in": "body", "required": true, @@ -11161,7 +11161,7 @@ const docTemplate = `{ "type": "string" }, "example": [ - "azure+koreacentral+Standard_B2s" + "tencent+ap-seoul+S2.MEDIUM4" ] } } @@ -13195,17 +13195,17 @@ const docTemplate = `{ "commonImage": { "description": "CommonImage is field for id of a image in common namespace", "type": "string", - "example": "default, azure+koreacentrall+ubuntu20.04" + "example": "default, tencent+ap-seoul+ubuntu20.04" }, "commonSpec": { "description": "CommonSpec is field for id of a spec in common namespace", "type": "string", - "example": "azure+koreacentral+standard_b2s" + "example": "tencent+ap-seoul+S2.MEDIUM4" }, "connectionName": { "description": "if ConnectionName is given, the VM tries to use associtated credential.\nif not, it will use predefined ConnectionName in Spec objects", "type": "string", - "default": "azure-koreacentral" + "default": "tencent-ap-seoul" }, "description": { "type": "string", diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json index 72ab18c1..56a6540c 100644 --- a/src/api/rest/docs/swagger.json +++ b/src/api/rest/docs/swagger.json @@ -923,7 +923,7 @@ "[Kubernetes] Cluster Management" ], "summary": "Recommend K8sCluster's Node plan (filter and priority)", - "operationId": "RecommendNode", + "operationId": "RecommendK8sNode", "parameters": [ { "description": "Recommend K8sCluster's Node plan (filter and priority)", @@ -3206,7 +3206,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/1570", + "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", "name": "k8sclusterReq", "in": "body", "required": true, @@ -11154,7 +11154,7 @@ "type": "string" }, "example": [ - "azure+koreacentral+Standard_B2s" + "tencent+ap-seoul+S2.MEDIUM4" ] } } @@ -13188,17 +13188,17 @@ "commonImage": { "description": "CommonImage is field for id of a image in common namespace", "type": "string", - "example": "default, azure+koreacentrall+ubuntu20.04" + "example": "default, tencent+ap-seoul+ubuntu20.04" }, "commonSpec": { "description": "CommonSpec is field for id of a spec in common namespace", "type": "string", - "example": "azure+koreacentral+standard_b2s" + "example": "tencent+ap-seoul+S2.MEDIUM4" }, "connectionName": { "description": "if ConnectionName is given, the VM tries to use associtated credential.\nif not, it will use predefined ConnectionName in Spec objects", "type": "string", - "default": "azure-koreacentral" + "default": "tencent-ap-seoul" }, "description": { "type": "string", diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml index 9958a759..682799bf 100644 --- a/src/api/rest/docs/swagger.yaml +++ b/src/api/rest/docs/swagger.yaml @@ -688,7 +688,7 @@ paths: summary: Recommend K8sCluster's Node plan (filter and priority) description: Recommend K8sCluster's Node plan (filter and priority) Find details from https://github.com/cloud-barista/cb-tumblebug/discussions/1234 - operationId: RecommendNode + operationId: RecommendK8sNode requestBody: description: Recommend K8sCluster's Node plan (filter and priority) content: @@ -2435,7 +2435,7 @@ paths: \ include commonSpec and commonImage info.
(ex: {name: k8scluster-01,\ \ commonImage: azure+koreacentral+ubuntu22.04, commonSpec: azure+koreacentral+Standard_B2s}]})\ \
You can use /k8sclusterRecommendNode and /k8sclusterDynamicCheckRequest\ - \ to get it.
Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1570" + \ to get it.
Check the guide: https://github.com/cloud-barista/cb-tumblebug/discussions/1913" content: application/json: schema: @@ -8413,7 +8413,7 @@ components: type: array description: CommonSpec is field for id of a spec in common namespace example: - - azure+koreacentral+Standard_B2s + - tencent+ap-seoul+S2.MEDIUM4 items: type: string model.K8sClusterDetail: @@ -9832,17 +9832,17 @@ components: commonImage: type: string description: CommonImage is field for id of a image in common namespace - example: "default, azure+koreacentrall+ubuntu20.04" + example: "default, tencent+ap-seoul+ubuntu20.04" commonSpec: type: string description: CommonSpec is field for id of a spec in common namespace - example: azure+koreacentral+standard_b2s + example: tencent+ap-seoul+S2.MEDIUM4 connectionName: type: string description: |- if ConnectionName is given, the VM tries to use associtated credential. if not, it will use predefined ConnectionName in Spec objects - default: azure-koreacentral + default: tencent-ap-seoul description: type: string example: Description