Fix api description for subnet

cloud-barista · Jan 12, 2024 · a1a8fce · a1a8fce
2 parents 7ba0fc1 + 0a183f3
commit a1a8fce
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 0 deletions.
diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go
@@ -6666,6 +6666,13 @@ const docTemplate = `{
                         "in": "path",
                         "required": true
                     },
+                    {
+                        "type": "string",
+                        "description": "VNet ID",
+                        "name": "vNetId",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "description": "Details for an Subnet object",
                         "name": "subnetReq",
@@ -6720,6 +6727,13 @@ const docTemplate = `{
                         "in": "path",
                         "required": true
                     },
+                    {
+                        "type": "string",
+                        "description": "VNet ID",
+                        "name": "vNetId",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "type": "string",
                         "description": "Subnet ID",

diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json
@@ -6659,6 +6659,13 @@
                         "in": "path",
                         "required": true
                     },
+                    {
+                        "type": "string",
+                        "description": "VNet ID",
+                        "name": "vNetId",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "description": "Details for an Subnet object",
                         "name": "subnetReq",
@@ -6713,6 +6720,13 @@
                         "in": "path",
                         "required": true
                     },
+                    {
+                        "type": "string",
+                        "description": "VNet ID",
+                        "name": "vNetId",
+                        "in": "path",
+                        "required": true
+                    },
                     {
                         "type": "string",
                         "description": "Subnet ID",

diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml
@@ -6987,6 +6987,11 @@ paths:
         name: nsId
         required: true
         type: string
+      - description: VNet ID
+        in: path
+        name: vNetId
+        required: true
+        type: string
       - description: Details for an Subnet object
         in: body
         name: subnetReq
@@ -7023,6 +7028,11 @@ paths:
         name: nsId
         required: true
         type: string
+      - description: VNet ID
+        in: path
+        name: vNetId
+        required: true
+        type: string
       - description: Subnet ID
         in: path
         name: subnetId

diff --git a/src/api/rest/server/mcir/subnet.go b/src/api/rest/server/mcir/subnet.go
@@ -27,6 +27,7 @@ import (
 // @Accept  json
 // @Produce  json
 // @Param nsId path string true "Namespace ID" default(ns01)
+// @Param vNetId path string true "VNet ID"
 // @Param subnetReq body mcir.TbSubnetReq true "Details for an Subnet object"
 // @Success 200 {object} mcir.TbSubnetInfo
 // @Failure 404 {object} common.SimpleMsg
@@ -113,6 +114,7 @@ func RestGetAllSubnet(c echo.Context) error {
 // @Accept  json
 // @Produce  json
 // @Param nsId path string true "Namespace ID" default(ns01)
+// @Param vNetId path string true "VNet ID"
 // @Param subnetId path string true "Subnet ID"
 // @Success 200 {object} common.SimpleMsg
 // @Failure 404 {object} common.SimpleMsg