From ac9273ce30db3f6058f4b600ded524bf7dbbcc36 Mon Sep 17 00:00:00 2001 From: seokho-son Date: Tue, 21 Feb 2023 02:43:58 +0000 Subject: [PATCH] Update Swagger REST API doc --- src/api/rest/docs/docs.go | 5 +++++ src/api/rest/docs/swagger.json | 5 +++++ src/api/rest/docs/swagger.yaml | 4 ++++ 3 files changed, 14 insertions(+) diff --git a/src/api/rest/docs/docs.go b/src/api/rest/docs/docs.go index acc7314d0..78b3de4ba 100644 --- a/src/api/rest/docs/docs.go +++ b/src/api/rest/docs/docs.go @@ -7880,6 +7880,11 @@ const docTemplate = `{ "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.json b/src/api/rest/docs/swagger.json index 28edf8b24..5f96085bf 100644 --- 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 index aecd5a6e1..d1bc890c1 100644 --- 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: