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

[Workflow] Update Swagger REST API doc
cloud-barista · May 7, 2022 · 59dc654 · 59dc654
2 parents 4f5d44f + 9b0af30
commit 59dc654
Show file tree

Hide file tree

Showing 3 changed files with 262 additions and 0 deletions.
diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go
@@ -376,6 +376,41 @@ const docTemplate = `{
                 }
             }
         },
+        "/inspectResourcesOverview": {
+            "get": {
+                "description": "Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[Admin] System management"
+                ],
+                "summary": "Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/mcis.InspectResourceAllResult"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    }
+                }
+            }
+        },
         "/loadCommonResource": {
             "get": {
                 "description": "Load Common Resources from internal asset files (Spec, Image)",
@@ -6400,6 +6435,52 @@ const docTemplate = `{
                 }
             }
         },
+        "mcis.InspectResourceAllResult": {
+            "type": "object",
+            "properties": {
+                "availableConnection": {
+                    "type": "integer"
+                },
+                "cspTotalOverview": {
+                    "$ref": "#/definitions/mcis.inspectOverview"
+                },
+                "elapsedTime": {
+                    "type": "integer"
+                },
+                "inspectResult": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/mcis.InspectResourceResult"
+                    }
+                },
+                "registeredConnection": {
+                    "type": "integer"
+                },
+                "tumblebugOverview": {
+                    "$ref": "#/definitions/mcis.inspectOverview"
+                }
+            }
+        },
+        "mcis.InspectResourceResult": {
+            "type": "object",
+            "properties": {
+                "connectionName": {
+                    "type": "string"
+                },
+                "cspTotalOverview": {
+                    "$ref": "#/definitions/mcis.inspectOverview"
+                },
+                "elapsedTime": {
+                    "type": "integer"
+                },
+                "systemMessage": {
+                    "type": "string"
+                },
+                "tumblebugOverview": {
+                    "$ref": "#/definitions/mcis.inspectOverview"
+                }
+            }
+        },
         "mcis.JSONResult": {
             "type": "object"
         },
@@ -7433,6 +7514,23 @@ const docTemplate = `{
                 }
             }
         },
+        "mcis.inspectOverview": {
+            "type": "object",
+            "properties": {
+                "securityGroup": {
+                    "type": "integer"
+                },
+                "sshKey": {
+                    "type": "integer"
+                },
+                "vNet": {
+                    "type": "integer"
+                },
+                "vm": {
+                    "type": "integer"
+                }
+            }
+        },
         "mcis.registerationOverview": {
             "type": "object",
             "properties": {

diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json
@@ -368,6 +368,41 @@
                 }
             }
         },
+        "/inspectResourcesOverview": {
+            "get": {
+                "description": "Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "[Admin] System management"
+                ],
+                "summary": "Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug and CSP for all connections",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/mcis.InspectResourceAllResult"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/common.SimpleMsg"
+                        }
+                    }
+                }
+            }
+        },
         "/loadCommonResource": {
             "get": {
                 "description": "Load Common Resources from internal asset files (Spec, Image)",
@@ -6392,6 +6427,52 @@
                 }
             }
         },
+        "mcis.InspectResourceAllResult": {
+            "type": "object",
+            "properties": {
+                "availableConnection": {
+                    "type": "integer"
+                },
+                "cspTotalOverview": {
+                    "$ref": "#/definitions/mcis.inspectOverview"
+                },
+                "elapsedTime": {
+                    "type": "integer"
+                },
+                "inspectResult": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/mcis.InspectResourceResult"
+                    }
+                },
+                "registeredConnection": {
+                    "type": "integer"
+                },
+                "tumblebugOverview": {
+                    "$ref": "#/definitions/mcis.inspectOverview"
+                }
+            }
+        },
+        "mcis.InspectResourceResult": {
+            "type": "object",
+            "properties": {
+                "connectionName": {
+                    "type": "string"
+                },
+                "cspTotalOverview": {
+                    "$ref": "#/definitions/mcis.inspectOverview"
+                },
+                "elapsedTime": {
+                    "type": "integer"
+                },
+                "systemMessage": {
+                    "type": "string"
+                },
+                "tumblebugOverview": {
+                    "$ref": "#/definitions/mcis.inspectOverview"
+                }
+            }
+        },
         "mcis.JSONResult": {
             "type": "object"
         },
@@ -7425,6 +7506,23 @@
                 }
             }
         },
+        "mcis.inspectOverview": {
+            "type": "object",
+            "properties": {
+                "securityGroup": {
+                    "type": "integer"
+                },
+                "sshKey": {
+                    "type": "integer"
+                },
+                "vNet": {
+                    "type": "integer"
+                },
+                "vm": {
+                    "type": "integer"
+                }
+            }
+        },
         "mcis.registerationOverview": {
             "type": "object",
             "properties": {

diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml
@@ -950,6 +950,36 @@ definitions:
       systemMessage:
         type: string
     type: object
+  mcis.InspectResourceAllResult:
+    properties:
+      availableConnection:
+        type: integer
+      cspTotalOverview:
+        $ref: '#/definitions/mcis.inspectOverview'
+      elapsedTime:
+        type: integer
+      inspectResult:
+        items:
+          $ref: '#/definitions/mcis.InspectResourceResult'
+        type: array
+      registeredConnection:
+        type: integer
+      tumblebugOverview:
+        $ref: '#/definitions/mcis.inspectOverview'
+    type: object
+  mcis.InspectResourceResult:
+    properties:
+      connectionName:
+        type: string
+      cspTotalOverview:
+        $ref: '#/definitions/mcis.inspectOverview'
+      elapsedTime:
+        type: integer
+      systemMessage:
+        type: string
+      tumblebugOverview:
+        $ref: '#/definitions/mcis.inspectOverview'
+    type: object
   mcis.JSONResult:
     type: object
   mcis.McisCmdReq:
@@ -1700,6 +1730,17 @@ definitions:
       targetStatus:
         type: string
     type: object
+  mcis.inspectOverview:
+    properties:
+      securityGroup:
+        type: integer
+      sshKey:
+        type: integer
+      vNet:
+        type: integer
+      vm:
+        type: integer
+    type: object
   mcis.registerationOverview:
     properties:
       failed:
@@ -2071,6 +2112,31 @@ paths:
         CB-Spider, CSP
       tags:
       - '[Admin] System management'
+  /inspectResourcesOverview:
+    get:
+      consumes:
+      - application/json
+      description: Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered
+        in CB-Tumblebug and CSP for all connections
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/mcis.InspectResourceAllResult'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/common.SimpleMsg'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/common.SimpleMsg'
+      summary: Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered
+        in CB-Tumblebug and CSP for all connections
+      tags:
+      - '[Admin] System management'
   /loadCommonResource:
     get:
       consumes: