Update Swagger REST API doc

cloud-barista · Nov 21, 2024 · 530c005 · 530c005
1 parent c503de3
commit 530c005
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git 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
@@ -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
@@ -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