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

[Workflow] Update Swagger REST API doc
cloud-barista · Oct 10, 2023 · a27e41a · a27e41a
2 parents 723708b + 436ad11
commit a27e41a
Show file tree

Hide file tree

Showing 3 changed files with 246 additions and 38 deletions.
diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go
@@ -1,5 +1,4 @@
-// Package docs GENERATED BY SWAG; DO NOT EDIT
-// This file was generated by swaggo/swag
+// Package docs Code generated by swaggo/swag. DO NOT EDIT
 package docs
 
 import "github.com/swaggo/swag"
@@ -7430,6 +7429,34 @@ const docTemplate = `{
                 }
             }
         },
+        "mcir.CustomImageStatus": {
+            "type": "string",
+            "enum": [
+                "Available",
+                "Unavailable"
+            ],
+            "x-enum-varnames": [
+                "MyImageAvailable",
+                "MyImageUnavailable"
+            ]
+        },
+        "mcir.DiskStatus": {
+            "type": "string",
+            "enum": [
+                "Creating",
+                "Available",
+                "Attached",
+                "Deleting",
+                "Error"
+            ],
+            "x-enum-varnames": [
+                "DiskCreating",
+                "DiskAvailable",
+                "DiskAttached",
+                "DiskDeleting",
+                "DiskError"
+            ]
+        },
         "mcir.FilterSpecsByRangeRequest": {
             "type": "object",
             "properties": {
@@ -7695,7 +7722,11 @@ const docTemplate = `{
                 },
                 "iid": {
                     "description": "Fields for response",
-                    "$ref": "#/definitions/common.IID"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/common.IID"
+                        }
+                    ]
                 },
                 "keyValueList": {
                     "type": "array",
@@ -7846,7 +7877,11 @@ const docTemplate = `{
                     "example": "aws-ap-southeast-1-1"
                 },
                 "status": {
-                    "type": "string",
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/mcir.CustomImageStatus"
+                        }
+                    ],
                     "example": "Available"
                 },
                 "systemLabel": {
@@ -7936,7 +7971,11 @@ const docTemplate = `{
                 },
                 "status": {
                     "description": "Available, Unavailable, Attached, ...",
-                    "type": "string",
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/mcir.DiskStatus"
+                        }
+                    ],
                     "example": "Available"
                 },
                 "systemLabel": {
@@ -8643,7 +8682,11 @@ const docTemplate = `{
                 },
                 "postCommand": {
                     "description": "PostCommand is field for providing command to VMs after its creation. example:\"wget https://raw.githubusercontent.com/cloud-barista/cb-tumblebug/main/scripts/setweb.sh -O ~/setweb.sh; chmod +x ~/setweb.sh; sudo ~/setweb.sh\"",
-                    "$ref": "#/definitions/mcis.McisCmdReq"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/mcis.McisCmdReq"
+                        }
+                    ]
                 },
                 "vmDynamicReq": {
                     "$ref": "#/definitions/mcis.TbVmDynamicReq"
@@ -9380,6 +9423,17 @@ const docTemplate = `{
                 }
             }
         },
+        "mcis.SpiderImageType": {
+            "type": "string",
+            "enum": [
+                "PublicImage",
+                "MyImage"
+            ],
+            "x-enum-varnames": [
+                "PublicImage",
+                "MyImage"
+            ]
+        },
         "mcis.SpiderVMInfo": {
             "type": "object",
             "properties": {
@@ -9401,7 +9455,11 @@ const docTemplate = `{
                 },
                 "iid": {
                     "description": "Fields for response",
-                    "$ref": "#/definitions/common.IID"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/common.IID"
+                        }
+                    ]
                 },
                 "imageIId": {
                     "$ref": "#/definitions/common.IID"
@@ -9410,7 +9468,7 @@ const docTemplate = `{
                     "type": "string"
                 },
                 "imageType": {
-                    "type": "string"
+                    "$ref": "#/definitions/mcis.SpiderImageType"
                 },
                 "keyPairIId": {
                     "$ref": "#/definitions/common.IID"
@@ -9446,7 +9504,11 @@ const docTemplate = `{
                 },
                 "region": {
                     "description": "ex) {us-east1, us-east1-c} or {ap-northeast-2}",
-                    "$ref": "#/definitions/mcis.RegionInfo"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/mcis.RegionInfo"
+                        }
+                    ]
                 },
                 "rootDeviceName": {
                     "description": "\"/dev/sda1\", ...",
@@ -9481,7 +9543,11 @@ const docTemplate = `{
                 },
                 "subnetIID": {
                     "description": "AWS, ex) subnet-8c4a53e4",
-                    "$ref": "#/definitions/common.IID"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/common.IID"
+                        }
+                    ]
                 },
                 "subnetName": {
                     "type": "string"
@@ -9964,11 +10030,19 @@ const docTemplate = `{
                 },
                 "healthChecker": {
                     "description": "HealthChecker",
-                    "$ref": "#/definitions/mcis.TbNLBHealthCheckerReq"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/mcis.TbNLBHealthCheckerReq"
+                        }
+                    ]
                 },
                 "listener": {
                     "description": "Frontend",
-                    "$ref": "#/definitions/mcis.NLBListenerReq"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/mcis.NLBListenerReq"
+                        }
+                    ]
                 },
                 "scope": {
                     "description": "REGION(V) | GLOBAL",
@@ -9981,7 +10055,11 @@ const docTemplate = `{
                 },
                 "targetGroup": {
                     "description": "Backend",
-                    "$ref": "#/definitions/mcis.TbNLBTargetGroupReq"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/mcis.TbNLBTargetGroupReq"
+                        }
+                    ]
                 },
                 "type": {
                     "description": "PUBLIC(V) | INTERNAL",
@@ -10180,7 +10258,11 @@ const docTemplate = `{
                 },
                 "region": {
                     "description": "AWS, ex) {us-east1, us-east1-c} or {ap-northeast-2}",
-                    "$ref": "#/definitions/mcis.RegionInfo"
+                    "allOf": [
+                        {
+                            "$ref": "#/definitions/mcis.RegionInfo"
+                        }
+                    ]
                 },
                 "rootDeviceName": {
                     "type": "string"
@@ -10577,6 +10659,8 @@ var SwaggerInfo = &swag.Spec{
 	Description:      "CB-Tumblebug REST API",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
+	LeftDelim:        "{{",
+	RightDelim:       "}}",
 }
 
 func init() {