From 84e7ecefd71a04a7c92e6667a5c0f8995721c64c Mon Sep 17 00:00:00 2001 From: seokho-son Date: Tue, 10 May 2022 07:30:31 +0000 Subject: [PATCH] Update Swagger REST API doc --- src/api/rest/docs/docs.go | 60 ++++++++++++++++++++++++++++++++++ src/api/rest/docs/swagger.json | 60 ++++++++++++++++++++++++++++++++++ src/api/rest/docs/swagger.yaml | 41 +++++++++++++++++++++++ 3 files changed, 161 insertions(+) diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go index d371d9fb..b7499912 100644 --- 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 index 63bad025..c8f3cde3 100644 --- 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 index 5525c016..ee79a6ac 100644 --- 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: