Merge pull request #1102 from cloud-barista/update-swagger-doc

[Workflow] Update Swagger REST API doc
cloud-barista · May 10, 2022 · 349d440 · 349d440
2 parents fa25285 + 84e7ece
commit 349d440
Show file tree

Hide file tree

Showing 3 changed files with 161 additions and 0 deletions.
diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go
@@ -2272,6 +2272,66 @@ const docTemplate = `{
             }
         },
         "/ns/{nsId}/network/mcis/{mcisId}": {
+            "put": {
+                "description": "Inject Cloud Information For Cloud Adaptive Network",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[Infra service] MCIS Cloud Adaptive Network (for developer)"
+                ],
+                "summary": "Inject Cloud Information For Cloud Adaptive Network",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "default": "ns01",
+                        "description": "Namespace ID",
+                        "name": "nsId",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "type": "string",
+                        "default": "mcis01",
+                        "description": "MCIS ID",
+                        "name": "mcisId",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "description": "Details for the network request body",
+                        "name": "networkReq",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/mcis.NetworkReq"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/mcis.AgentInstallContentWrapper"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    }
+                }
+            },
             "post": {
                 "description": "Configure Cloud Adaptive Network (cb-network agent) to MCIS",
                 "consumes": [

diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json
@@ -2264,6 +2264,66 @@
             }
         },
         "/ns/{nsId}/network/mcis/{mcisId}": {
+            "put": {
+                "description": "Inject Cloud Information For Cloud Adaptive Network",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[Infra service] MCIS Cloud Adaptive Network (for developer)"
+                ],
+                "summary": "Inject Cloud Information For Cloud Adaptive Network",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "default": "ns01",
+                        "description": "Namespace ID",
+                        "name": "nsId",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "type": "string",
+                        "default": "mcis01",
+                        "description": "MCIS ID",
+                        "name": "mcisId",
+                        "in": "path",
+                        "required": true
+                    },
+                    {
+                        "description": "Details for the network request body",
+                        "name": "networkReq",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/mcis.NetworkReq"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/mcis.AgentInstallContentWrapper"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    }
+                }
+            },
             "post": {
                 "description": "Configure Cloud Adaptive Network (cb-network agent) to MCIS",
                 "consumes": [

diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml
@@ -3437,6 +3437,47 @@ paths:
       summary: Configure Cloud Adaptive Network (cb-network agent) to MCIS
       tags:
       - '[Infra service] MCIS Cloud Adaptive Network (for developer)'
+    put:
+      consumes:
+      - application/json
+      description: Inject Cloud Information For Cloud Adaptive Network
+      parameters:
+      - default: ns01
+        description: Namespace ID
+        in: path
+        name: nsId
+        required: true
+        type: string
+      - default: mcis01
+        description: MCIS ID
+        in: path
+        name: mcisId
+        required: true
+        type: string
+      - description: Details for the network request body
+        in: body
+        name: networkReq
+        required: true
+        schema:
+          $ref: '#/definitions/mcis.NetworkReq'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/mcis.AgentInstallContentWrapper'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/common.SimpleMsg'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/common.SimpleMsg'
+      summary: Inject Cloud Information For Cloud Adaptive Network
+      tags:
+      - '[Infra service] MCIS Cloud Adaptive Network (for developer)'
   /ns/{nsId}/policy/mcis:
     delete:
       consumes: