From 530c0055a119110410870a3fb007c72da2911fe5 Mon Sep 17 00:00:00 2001 From: cb-github-robot Date: Thu, 21 Nov 2024 04:36:54 +0000 Subject: [PATCH] Update Swagger REST API doc --- src/api/rest/docs/docs.go | 6 +++--- src/api/rest/docs/swagger.json | 6 +++--- src/api/rest/docs/swagger.yaml | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go index f6d49ae3..aa351061 100644 --- a/src/api/rest/docs/docs.go +++ b/src/api/rest/docs/docs.go @@ -14139,9 +14139,9 @@ const docTemplate = `{ "example": "My K8sCluster" }, "id": { - "description": "Id is unique identifier for the object", + "description": "Id is unique identifier for the object, same as Name", "type": "string", - "example": "aws-ap-southeast-1" + "example": "k8scluster-01" }, "label": { "description": "Label is for describing the object by keywords", @@ -14153,7 +14153,7 @@ const docTemplate = `{ "name": { "description": "Name is human-readable string to represent the object", "type": "string", - "example": "aws-ap-southeast-1" + "example": "k8scluster-01" }, "resourceType": { "description": "ResourceType is the type of the resource", diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json index 1db0c7c9..caa94343 100644 --- a/src/api/rest/docs/swagger.json +++ b/src/api/rest/docs/swagger.json @@ -14132,9 +14132,9 @@ "example": "My K8sCluster" }, "id": { - "description": "Id is unique identifier for the object", + "description": "Id is unique identifier for the object, same as Name", "type": "string", - "example": "aws-ap-southeast-1" + "example": "k8scluster-01" }, "label": { "description": "Label is for describing the object by keywords", @@ -14146,7 +14146,7 @@ "name": { "description": "Name is human-readable string to represent the object", "type": "string", - "example": "aws-ap-southeast-1" + "example": "k8scluster-01" }, "resourceType": { "description": "ResourceType is the type of the resource", diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml index e6bb313f..05fff4b0 100644 --- a/src/api/rest/docs/swagger.yaml +++ b/src/api/rest/docs/swagger.yaml @@ -10594,8 +10594,8 @@ components: example: My K8sCluster id: type: string - description: Id is unique identifier for the object - example: aws-ap-southeast-1 + description: "Id is unique identifier for the object, same as Name" + example: k8scluster-01 label: type: object additionalProperties: @@ -10604,7 +10604,7 @@ components: name: type: string description: Name is human-readable string to represent the object - example: aws-ap-southeast-1 + example: k8scluster-01 resourceType: type: string description: ResourceType is the type of the resource