Merge pull request #1449 from Jeon-Jinhyeok/master

Edit for Swagger documentation
cloud-barista · Feb 5, 2025 · e6af4ed · e6af4ed
2 parents 3c41d91 + dccf930
commit e6af4ed
Show file tree

Hide file tree

Showing 4 changed files with 141 additions and 141 deletions.
diff --git a/api-runtime/rest-runtime/SecurityGroupRest.go b/api-runtime/rest-runtime/SecurityGroupRest.go
@@ -242,7 +242,7 @@ func ListAllSecurity(c echo.Context) error {
 // @Success 200 {object} restruntime.SecurityGroupListResponse "Response containing security groups under the key 'securitygroup'"
 // @Failure 400 {object} SimpleMsg "Bad Request, possibly due to missing parameters"
 // @Failure 500 {object} SimpleMsg "Internal Server Error"
-// @Router /vpcsecuritygroup/{VPCName} [get]
+// @Router /securitygroup/vpc/{VPCName} [get]
 func ListVpcSecurity(c echo.Context) error {
 	cblog.Info("call ListVpcSecurity()")
 

diff --git a/api/docs.go b/api/docs.go
@@ -6724,6 +6724,58 @@ const docTemplate = `{
                 }
             }
         },
+        "/securitygroup/vpc/{VPCName}": {
+            "get": {
+                "description": "Retrieve a list of Security Groups associated with a specific VPC in a given cloud connection.",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[SecurityGroup Management]"
+                ],
+                "summary": "List Security Groups in a Specific VPC",
+                "operationId": "list-vpc-securitygroup",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "The name of the VPC to list Security Groups for",
+                        "name": "VPCName",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "type": "string",
+                        "description": "The name of the Connection to list Security Groups for",
+                        "name": "ConnectionName",
+                        "in": "query",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Response containing security groups under the key 'securitygroup'",
+                        "schema": {
+                            "$ref": "#/definitions/spider.SecurityGroupListResponse"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request, possibly due to missing parameters",
+                        "schema": {
+                            "$ref": "#/definitions/spider.SimpleMsg"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/spider.SimpleMsg"
+                        }
+                    }
+                }
+            }
+        },
         "/securitygroup/{Name}": {
             "get": {
                 "description": "Retrieve details of a specific Security Group.",
@@ -8359,58 +8411,6 @@ const docTemplate = `{
                     }
                 }
             }
-        },
-        "/vpcsecuritygroup/{VPCName}": {
-            "get": {
-                "description": "Retrieve a list of Security Groups associated with a specific VPC in a given cloud connection.",
-                "consumes": [
-                    "application/json"
-                ],
-                "produces": [
-                    "application/json"
-                ],
-                "tags": [
-                    "[SecurityGroup Management]"
-                ],
-                "summary": "List Security Groups in a Specific VPC",
-                "operationId": "list-vpc-securitygroup",
-                "parameters": [
-                    {
-                        "type": "string",
-                        "description": "The name of the VPC to list Security Groups for",
-                        "name": "VPCName",
-                        "in": "path",
-                        "required": true
-                    },
-                    {
-                        "type": "string",
-                        "description": "The name of the Connection to list Security Groups for",
-                        "name": "ConnectionName",
-                        "in": "query",
-                        "required": true
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Response containing security groups under the key 'securitygroup'",
-                        "schema": {
-                            "$ref": "#/definitions/spider.SecurityGroupListResponse"
-                        }
-                    },
-                    "400": {
-                        "description": "Bad Request, possibly due to missing parameters",
-                        "schema": {
-                            "$ref": "#/definitions/spider.SimpleMsg"
-                        }
-                    },
-                    "500": {
-                        "description": "Internal Server Error",
-                        "schema": {
-                            "$ref": "#/definitions/spider.SimpleMsg"
-                        }
-                    }
-                }
-            }
         }
     },
     "definitions": {

diff --git a/api/swagger.json b/api/swagger.json
@@ -6721,6 +6721,58 @@
                 }
             }
         },
+        "/securitygroup/vpc/{VPCName}": {
+            "get": {
+                "description": "Retrieve a list of Security Groups associated with a specific VPC in a given cloud connection.",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[SecurityGroup Management]"
+                ],
+                "summary": "List Security Groups in a Specific VPC",
+                "operationId": "list-vpc-securitygroup",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "The name of the VPC to list Security Groups for",
+                        "name": "VPCName",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "type": "string",
+                        "description": "The name of the Connection to list Security Groups for",
+                        "name": "ConnectionName",
+                        "in": "query",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Response containing security groups under the key 'securitygroup'",
+                        "schema": {
+                            "$ref": "#/definitions/spider.SecurityGroupListResponse"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request, possibly due to missing parameters",
+                        "schema": {
+                            "$ref": "#/definitions/spider.SimpleMsg"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/spider.SimpleMsg"
+                        }
+                    }
+                }
+            }
+        },
         "/securitygroup/{Name}": {
             "get": {
                 "description": "Retrieve details of a specific Security Group.",
@@ -8356,58 +8408,6 @@
                     }
                 }
             }
-        },
-        "/vpcsecuritygroup/{VPCName}": {
-            "get": {
-                "description": "Retrieve a list of Security Groups associated with a specific VPC in a given cloud connection.",
-                "consumes": [
-                    "application/json"
-                ],
-                "produces": [
-                    "application/json"
-                ],
-                "tags": [
-                    "[SecurityGroup Management]"
-                ],
-                "summary": "List Security Groups in a Specific VPC",
-                "operationId": "list-vpc-securitygroup",
-                "parameters": [
-                    {
-                        "type": "string",
-                        "description": "The name of the VPC to list Security Groups for",
-                        "name": "VPCName",
-                        "in": "path",
-                        "required": true
-                    },
-                    {
-                        "type": "string",
-                        "description": "The name of the Connection to list Security Groups for",
-                        "name": "ConnectionName",
-                        "in": "query",
-                        "required": true
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Response containing security groups under the key 'securitygroup'",
-                        "schema": {
-                            "$ref": "#/definitions/spider.SecurityGroupListResponse"
-                        }
-                    },
-                    "400": {
-                        "description": "Bad Request, possibly due to missing parameters",
-                        "schema": {
-                            "$ref": "#/definitions/spider.SimpleMsg"
-                        }
-                    },
-                    "500": {
-                        "description": "Internal Server Error",
-                        "schema": {
-                            "$ref": "#/definitions/spider.SimpleMsg"
-                        }
-                    }
-                }
-            }
         }
     },
     "definitions": {

diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -7704,6 +7704,42 @@ paths:
       summary: Add Rules to SecurityGroup
       tags:
       - '[SecurityGroup Management]'
+  /securitygroup/vpc/{VPCName}:
+    get:
+      consumes:
+      - application/json
+      description: Retrieve a list of Security Groups associated with a specific VPC
+        in a given cloud connection.
+      operationId: list-vpc-securitygroup
+      parameters:
+      - description: The name of the VPC to list Security Groups for
+        in: path
+        name: VPCName
+        required: true
+        type: string
+      - description: The name of the Connection to list Security Groups for
+        in: query
+        name: ConnectionName
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: Response containing security groups under the key 'securitygroup'
+          schema:
+            $ref: '#/definitions/spider.SecurityGroupListResponse'
+        "400":
+          description: Bad Request, possibly due to missing parameters
+          schema:
+            $ref: '#/definitions/spider.SimpleMsg'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/spider.SimpleMsg'
+      summary: List Security Groups in a Specific VPC
+      tags:
+      - '[SecurityGroup Management]'
   /tag:
     get:
       consumes:
@@ -8675,42 +8711,6 @@ paths:
       summary: Get Subnet
       tags:
       - '[VPC Management]'
-  /vpcsecuritygroup/{VPCName}:
-    get:
-      consumes:
-      - application/json
-      description: Retrieve a list of Security Groups associated with a specific VPC
-        in a given cloud connection.
-      operationId: list-vpc-securitygroup
-      parameters:
-      - description: The name of the VPC to list Security Groups for
-        in: path
-        name: VPCName
-        required: true
-        type: string
-      - description: The name of the Connection to list Security Groups for
-        in: query
-        name: ConnectionName
-        required: true
-        type: string
-      produces:
-      - application/json
-      responses:
-        "200":
-          description: Response containing security groups under the key 'securitygroup'
-          schema:
-            $ref: '#/definitions/spider.SecurityGroupListResponse'
-        "400":
-          description: Bad Request, possibly due to missing parameters
-          schema:
-            $ref: '#/definitions/spider.SimpleMsg'
-        "500":
-          description: Internal Server Error
-          schema:
-            $ref: '#/definitions/spider.SimpleMsg'
-      summary: List Security Groups in a Specific VPC
-      tags:
-      - '[SecurityGroup Management]'
 schemes:
 - http
 securityDefinitions: