server: api: Update swagger doc

cloud-barista · Aug 29, 2024 · 70e9553 · 70e9553
1 parent 46f7367
commit 70e9553
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/server/pkg/api/rest/docs/docs.go b/server/pkg/api/rest/docs/docs.go
@@ -61,7 +61,7 @@ const docTemplate = `{
         },
         "/honeybee/bench/{connId}/run": {
             "get": {
-                "description": "Run the benchmark information of the connection information.",
+                "description": "Run the benchmark information of the connection information. If no Benchmark Agent is present on the connected server, it will be automatically installed, and the benchmark will be executed.",
                 "consumes": [
                     "application/json"
                 ],
@@ -467,7 +467,7 @@ const docTemplate = `{
         },
         "/honeybee/source_group/{sgId}/agent_check": {
             "get": {
-                "description": "Check Agent in source group. Show each status by returning agent info list.",
+                "description": "Check Agent in source group. Show each status by returning agent info list. If no Agent is present on the connected server, the Agent will be automatically installed.",
                 "consumes": [
                     "application/json"
                 ],

diff --git a/server/pkg/api/rest/docs/swagger.json b/server/pkg/api/rest/docs/swagger.json
@@ -50,7 +50,7 @@
         },
         "/honeybee/bench/{connId}/run": {
             "get": {
-                "description": "Run the benchmark information of the connection information.",
+                "description": "Run the benchmark information of the connection information. If no Benchmark Agent is present on the connected server, it will be automatically installed, and the benchmark will be executed.",
                 "consumes": [
                     "application/json"
                 ],
@@ -456,7 +456,7 @@
         },
         "/honeybee/source_group/{sgId}/agent_check": {
             "get": {
-                "description": "Check Agent in source group. Show each status by returning agent info list.",
+                "description": "Check Agent in source group. Show each status by returning agent info list. If no Agent is present on the connected server, the Agent will be automatically installed.",
                 "consumes": [
                     "application/json"
                 ],

diff --git a/server/pkg/api/rest/docs/swagger.yaml b/server/pkg/api/rest/docs/swagger.yaml
@@ -916,7 +916,9 @@ paths:
     get:
       consumes:
       - application/json
-      description: Run the benchmark information of the connection information.
+      description: Run the benchmark information of the connection information. If
+        no Benchmark Agent is present on the connected server, it will be automatically
+        installed, and the benchmark will be executed.
       parameters:
       - description: ID of the connection info
         in: path
@@ -1185,7 +1187,8 @@ paths:
       consumes:
       - application/json
       description: Check Agent in source group. Show each status by returning agent
-        info list.
+        info list. If no Agent is present on the connected server, the Agent will
+        be automatically installed.
       parameters:
       - description: ID of the SourceGroup
         in: path