Update API docs for MCIS control

* Use string type for success responses of - `GET /ns/{nsId}/control/mcis/{mcisId}` - `GET /ns/{nsId}/control/mcis/{mcisId}/vm/{vmId}`
cloud-barista · May 3, 2024 · ef3b720 · ef3b720
1 parent 9d54407
commit ef3b720
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go
@@ -2044,7 +2044,7 @@ const docTemplate = `{
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/common.SimpleMsg"
+                            "type": "string"
                         }
                     },
                     "404": {
@@ -2128,7 +2128,7 @@ const docTemplate = `{
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/common.SimpleMsg"
+                            "type": "string"
                         }
                     },
                     "404": {

diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json
@@ -2037,7 +2037,7 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/common.SimpleMsg"
+                            "type": "string"
                         }
                     },
                     "404": {
@@ -2121,7 +2121,7 @@
                     "200": {
                         "description": "OK",
                         "schema": {
-                            "$ref": "#/definitions/common.SimpleMsg"
+                            "type": "string"
                         }
                     },
                     "404": {

diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml
@@ -4244,7 +4244,7 @@ paths:
         "200":
           description: OK
           schema:
-            $ref: '#/definitions/common.SimpleMsg'
+            type: string
         "404":
           description: Not Found
           schema:
@@ -4303,7 +4303,7 @@ paths:
         "200":
           description: OK
           schema:
-            $ref: '#/definitions/common.SimpleMsg'
+            type: string
         "404":
           description: Not Found
           schema:

diff --git a/src/api/rest/server/mcis/control.go b/src/api/rest/server/mcis/control.go
@@ -33,7 +33,7 @@ import (
 // @Param mcisId path string true "MCIS ID" default(mcis01)
 // @Param action query string true "Action to MCIS" Enums(suspend, resume, reboot, terminate, refine)
 // @Param force query string false "Force control to skip checking controllable status" Enums(false, true)
-// @Success 200 {object} common.SimpleMsg
+// @Success 200 {string} string
 // @Failure 404 {object} common.SimpleMsg
 // @Failure 500 {object} common.SimpleMsg
 // @Router /ns/{nsId}/control/mcis/{mcisId} [get]
@@ -74,7 +74,7 @@ func RestGetControlMcis(c echo.Context) error {
 // @Param vmId path string true "VM ID" default(g1-1)
 // @Param action query string true "Action to MCIS" Enums(suspend, resume, reboot, terminate)
 // @Param force query string false "Force control to skip checking controllable status" Enums(false, true)
-// @Success 200 {object} common.SimpleMsg
+// @Success 200 {string} string
 // @Failure 404 {object} common.SimpleMsg
 // @Failure 500 {object} common.SimpleMsg
 // @Router /ns/{nsId}/control/mcis/{mcisId}/vm/{vmId} [get]