fix: Fixed runComponent swagger definition

bahattincinic · May 20, 2024 · 3090f15 · 3090f15
1 parent 2d86a06
commit 3090f15
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/api/dashboard.go b/api/dashboard.go
@@ -288,7 +288,7 @@ func (a *API) deleteComponent(c echo.Context) error {
 //	@Tags		dashboard
 //	@Accept		json
 //	@Produce	json
-//	@Success	204
+//	@Success	200	{object}	queue.TaskResult
 //	@Router		/dashboards/{id}/components/{cpid}/run [post]
 func (a *API) runComponent(c echo.Context) error {
 	component := c.Get(componentContextKey).(*models.Component)

diff --git a/api/docs/docs.go b/api/docs/docs.go
@@ -582,8 +582,11 @@ const docTemplate = `{
                 ],
                 "summary": "Run Dashboard Component",
                 "responses": {
-                    "204": {
-                        "description": "No Content"
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/queue.TaskResult"
+                        }
                     }
                 }
             }

diff --git a/api/docs/swagger.json b/api/docs/swagger.json
@@ -571,8 +571,11 @@
                 ],
                 "summary": "Run Dashboard Component",
                 "responses": {
-                    "204": {
-                        "description": "No Content"
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/queue.TaskResult"
+                        }
                     }
                 }
             }

diff --git a/api/docs/swagger.yaml b/api/docs/swagger.yaml
@@ -751,8 +751,10 @@ paths:
       produces:
       - application/json
       responses:
-        "204":
-          description: No Content
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/queue.TaskResult'
       summary: Run Dashboard Component
       tags:
       - dashboard