chore: ui dev handler swagger

Author: MarcStdt

docs/docs.go

@@ -167,6 +167,16 @@ const docTemplate = `{
                     "daemon"
                 ],
                 "operationId": "enableDev",
+                "parameters": [
+                    {
+                        "description": "Optional commands to run on file changes",
+                        "name": "body",
+                        "in": "body",
+                        "schema": {
+                            "$ref": "#/definitions/handler.DevModeBody"
+                        }
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -1076,7 +1086,9 @@ const docTemplate = `{
             ],
             "x-enum-comments": {
                 "RunModeAlways": "default",
-                "RunModePersistent": "restarts on failure and on program restart"
+                "RunModeOnce": "runs only once",
+                "RunModePersistent": "restarts on failure and on program restart",
+                "RunModeRestart": "restarts on failure"
             },
             "x-enum-varnames": [
                 "RunModeAlways",
@@ -1100,6 +1112,17 @@ const docTemplate = `{
                 "ScrollLockStatusWaiting"
             ]
         },
+        "handler.DevModeBody": {
+            "type": "object",
+            "properties": {
+                "commands": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "$ref": "#/definitions/CommandInstructionSet"
+                    }
+                }
+            }
+        },
         "handler.HealhResponse": {
             "type": "object",
             "properties": {

docs/swagger.json

@@ -159,6 +159,16 @@
                     "daemon"
                 ],
                 "operationId": "enableDev",
+                "parameters": [
+                    {
+                        "description": "Optional commands to run on file changes",
+                        "name": "body",
+                        "in": "body",
+                        "schema": {
+                            "$ref": "#/definitions/handler.DevModeBody"
+                        }
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -1068,7 +1078,9 @@
             ],
             "x-enum-comments": {
                 "RunModeAlways": "default",
-                "RunModePersistent": "restarts on failure and on program restart"
+                "RunModeOnce": "runs only once",
+                "RunModePersistent": "restarts on failure and on program restart",
+                "RunModeRestart": "restarts on failure"
             },
             "x-enum-varnames": [
                 "RunModeAlways",
@@ -1092,6 +1104,17 @@
                 "ScrollLockStatusWaiting"
             ]
         },
+        "handler.DevModeBody": {
+            "type": "object",
+            "properties": {
+                "commands": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "$ref": "#/definitions/CommandInstructionSet"
+                    }
+                }
+            }
+        },
         "handler.HealhResponse": {
             "type": "object",
             "properties": {

docs/swagger.yaml

@@ -285,7 +285,9 @@ definitions:
     type: string
     x-enum-comments:
       RunModeAlways: default
+      RunModeOnce: runs only once
       RunModePersistent: restarts on failure and on program restart
+      RunModeRestart: restarts on failure
     x-enum-varnames:
     - RunModeAlways
     - RunModeOnce
@@ -303,6 +305,13 @@ definitions:
     - ScrollLockStatusDone
     - ScrollLockStatusError
     - ScrollLockStatusWaiting
+  handler.DevModeBody:
+    properties:
+      commands:
+        additionalProperties:
+          $ref: '#/definitions/CommandInstructionSet'
+        type: object
+    type: object
   handler.HealhResponse:
     properties:
       mode:
@@ -442,6 +451,12 @@ paths:
       consumes:
       - application/json
       operationId: enableDev
+      parameters:
+      - description: Optional commands to run on file changes
+        in: body
+        name: body
+        schema:
+          $ref: '#/definitions/handler.DevModeBody'
       produces:
       - application/json
       responses:

internal/handler/ui_dev_handler.go

@@ -50,6 +50,7 @@ func NewUiDevHandler(uiDevService ports.UiDevServiceInterface, scrollService por
 // @Tags ui, dev, druid, daemon
 // @Accept json
 // @Produce json
+// @Param body body DevModeBody false "Optional commands to run on file changes"
 // @Success 200 {object} DevModeResponse
 // @Failure 500 {object} ErrorResponse
 // @Router /api/v1/dev/enable [post]