Update Swagger REST API doc

cloud-barista · Oct 30, 2024 · ae6f495 · ae6f495
1 parent 43f1dc2
commit ae6f495
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 15 deletions.
diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go
@@ -849,6 +849,7 @@ const docTemplate = `{
                             "k8s",
                             "vNet",
                             "subnet",
+                            "vpn",
                             "securityGroup",
                             "sshKey",
                             "dataDisk"
@@ -911,6 +912,7 @@ const docTemplate = `{
                             "k8s",
                             "vNet",
                             "subnet",
+                            "vpn",
                             "securityGroup",
                             "sshKey",
                             "dataDisk"
@@ -984,6 +986,7 @@ const docTemplate = `{
                             "k8s",
                             "vNet",
                             "subnet",
+                            "vpn",
                             "securityGroup",
                             "sshKey",
                             "dataDisk"
@@ -9609,6 +9612,7 @@ const docTemplate = `{
                             "k8s",
                             "vNet",
                             "subnet",
+                            "vpn",
                             "securityGroup",
                             "sshKey",
                             "dataDisk"
@@ -12942,7 +12946,7 @@ const docTemplate = `{
                     "example": "Made in CB-TB"
                 },
                 "installMonAgent": {
-                    "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:yes)",
+                    "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:no)",
                     "type": "string",
                     "default": "no",
                     "enum": [
@@ -12997,14 +13001,14 @@ const docTemplate = `{
                     "example": "aws-ap-southeast-1"
                 },
                 "installMonAgent": {
-                    "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:yes)",
+                    "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:no)",
                     "type": "string",
-                    "default": "yes",
+                    "default": "no",
                     "enum": [
                         "yes",
                         "no"
                     ],
-                    "example": "yes"
+                    "example": "no"
                 },
                 "label": {
                     "description": "Label is for describing the object by keywords",
@@ -13081,7 +13085,7 @@ const docTemplate = `{
                 "installMonAgent": {
                     "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:yes)",
                     "type": "string",
-                    "default": "yes",
+                    "default": "no",
                     "enum": [
                         "yes",
                         "no"

diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json
@@ -842,6 +842,7 @@
                             "k8s",
                             "vNet",
                             "subnet",
+                            "vpn",
                             "securityGroup",
                             "sshKey",
                             "dataDisk"
@@ -904,6 +905,7 @@
                             "k8s",
                             "vNet",
                             "subnet",
+                            "vpn",
                             "securityGroup",
                             "sshKey",
                             "dataDisk"
@@ -977,6 +979,7 @@
                             "k8s",
                             "vNet",
                             "subnet",
+                            "vpn",
                             "securityGroup",
                             "sshKey",
                             "dataDisk"
@@ -9602,6 +9605,7 @@
                             "k8s",
                             "vNet",
                             "subnet",
+                            "vpn",
                             "securityGroup",
                             "sshKey",
                             "dataDisk"
@@ -12935,7 +12939,7 @@
                     "example": "Made in CB-TB"
                 },
                 "installMonAgent": {
-                    "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:yes)",
+                    "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:no)",
                     "type": "string",
                     "default": "no",
                     "enum": [
@@ -12990,14 +12994,14 @@
                     "example": "aws-ap-southeast-1"
                 },
                 "installMonAgent": {
-                    "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:yes)",
+                    "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:no)",
                     "type": "string",
-                    "default": "yes",
+                    "default": "no",
                     "enum": [
                         "yes",
                         "no"
                     ],
-                    "example": "yes"
+                    "example": "no"
                 },
                 "label": {
                     "description": "Label is for describing the object by keywords",
@@ -13074,7 +13078,7 @@
                 "installMonAgent": {
                     "description": "InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no] default:yes)",
                     "type": "string",
-                    "default": "yes",
+                    "default": "no",
                     "enum": [
                         "yes",
                         "no"

diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml
@@ -635,6 +635,7 @@ paths:
           - k8s
           - vNet
           - subnet
+          - vpn
           - securityGroup
           - sshKey
           - dataDisk
@@ -684,6 +685,7 @@ paths:
           - k8s
           - vNet
           - subnet
+          - vpn
           - securityGroup
           - sshKey
           - dataDisk
@@ -742,6 +744,7 @@ paths:
           - k8s
           - vNet
           - subnet
+          - vpn
           - securityGroup
           - sshKey
           - dataDisk
@@ -7301,6 +7304,7 @@ paths:
           - k8s
           - vNet
           - subnet
+          - vpn
           - securityGroup
           - sshKey
           - dataDisk
@@ -9652,7 +9656,7 @@ components:
         installMonAgent:
           type: string
           description: "InstallMonAgent Option for CB-Dragonfly agent installation\
-            \ ([yes/no] default:yes)"
+            \ ([yes/no] default:no)"
           example: "no"
           default: "no"
           enum:
@@ -9696,9 +9700,9 @@ components:
         installMonAgent:
           type: string
           description: "InstallMonAgent Option for CB-Dragonfly agent installation\
-            \ ([yes/no] default:yes)"
-          example: "yes"
-          default: "yes"
+            \ ([yes/no] default:no)"
+          example: "no"
+          default: "no"
           enum:
           - "yes"
           - "no"
@@ -9762,7 +9766,7 @@ components:
           description: "InstallMonAgent Option for CB-Dragonfly agent installation\
             \ ([yes/no] default:yes)"
           example: "no"
-          default: "yes"
+          default: "no"
           enum:
           - "yes"
           - "no"