From 9b0af30d3842902e84589197ce887d0ad5903d1c Mon Sep 17 00:00:00 2001 From: seokho-son Date: Sat, 7 May 2022 05:17:18 +0000 Subject: [PATCH] Update Swagger REST API doc --- src/api/rest/docs/docs.go | 98 ++++++++++++++++++++++++++++++++++ src/api/rest/docs/swagger.json | 98 ++++++++++++++++++++++++++++++++++ src/api/rest/docs/swagger.yaml | 66 +++++++++++++++++++++++ 3 files changed, 262 insertions(+) diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go index ed89234de..19f2287ae 100644 --- 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 index 7d6116578..b7776084b 100644 --- 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 index 51cfe2730..63f0dd1e4 100644 --- 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: