docs: add missing label to @returns in controllers

c100k · Dec 9, 2024 · 3b2a8ba · 3b2a8ba
1 parent 3a71ac9
commit 3b2a8ba
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ## spec/v0.4.1 (unreleased)
 
+* docs: add missing label to `@returns` in controllers
 * chore: expose types in esm
 * refactor: remove barrel files
 * refactor: simplify read version from package.json

diff --git a/spec/controllers/DashboardsController.ts b/spec/controllers/DashboardsController.ts
@@ -34,7 +34,7 @@ export class DashboardsController extends Controller {
      * List the dashboards with their id, name, etc.
      * @summary List the dashboards
      * @param queryParams
-     * @returns
+     * @returns The list of dashboards
      */
     @Get()
     @OperationId('ListDashboards')

diff --git a/spec/controllers/RunnablesController.ts b/spec/controllers/RunnablesController.ts
@@ -44,7 +44,7 @@ export class RunnablesController extends Controller {
      * List the runnables with their name, status, etc.
      * @summary List the runnables
      * @param queryParams
-     * @returns
+     * @returns The list of runnables
      */
     @Get()
     @OperationId('ListRunnables')
@@ -72,7 +72,7 @@ export class RunnablesController extends Controller {
      * Reboot a runnable
      * @summary Reboot a runnable
      * @param id
-     * @returns
+     * @returns The result of the operation
      */
     @Post('{id}/reboot')
     @SuccessResponse(201)
@@ -94,7 +94,7 @@ export class RunnablesController extends Controller {
      * Stop a runnable
      * @summary Stop a runnable
      * @param id
-     * @returns
+     * @returns The result of the operation
      */
     @Post('{id}/stop')
     @SuccessResponse(201)