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

[Workflow] Update Swagger REST API doc
cloud-barista · Feb 21, 2023 · 637e789 · 637e789
2 parents 888598d + ac9273c
commit 637e789
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go
diff --git a/src/api/rest/docs/swagger.json b/src/api/rest/docs/swagger.json
@@ -7873,6 +7873,11 @@
                     "description": "SystemLabel is for describing the MCIR in a keyword (any string can be used) for special System purpose",
                     "type": "string",
                     "example": "Managed by CB-Tumblebug"
+                },
+                "systemMessage": {
+                    "description": "Latest system message such as error message",
+                    "type": "string",
+                    "example": "Failed because ..."
                 }
             }
         },

diff --git a/src/api/rest/docs/swagger.yaml b/src/api/rest/docs/swagger.yaml
@@ -558,6 +558,10 @@ definitions:
           can be used) for special System purpose
         example: Managed by CB-Tumblebug
         type: string
+      systemMessage:
+        description: Latest system message such as error message
+        example: Failed because ...
+        type: string
     type: object
   mcir.TbDataDiskReq:
     properties: