end point adjsutments

docs/openapi.yaml

@@ -6,17 +6,20 @@ info:
     REST API exposed by the local Video Shader Toys control server.
 
     The API is intended for local control tools and the bundled React UI. All mutating
-    endpoints return a small action result object. Successful mutating requests also
-    broadcast the latest runtime state over the `/ws` WebSocket.
+    endpoints return a small action result object.
 
-    WebSocket state streaming is not described by OpenAPI; connect to `ws://127.0.0.1:{port}/ws`
-    to receive full runtime state JSON messages whenever state changes.
+    WebSocket state streaming is planned for the control UI but is not currently served
+    by RenderCadenceCompositor. Clients should poll `/api/state` until `/ws` is implemented.
 servers:
   - url: http://127.0.0.1:8080
     description: Default local control server
 tags:
   - name: State
     description: Runtime state and status.
+  - name: Static
+    description: Bundled control UI and static assets served by the local host.
+  - name: Docs
+    description: OpenAPI and Swagger UI documentation served by the local host.
   - name: Layers
     description: Layer stack control.
   - name: Stack Presets
@@ -24,6 +27,146 @@ tags:
   - name: Runtime
     description: Runtime actions.
 paths:
+  /:
+    get:
+      tags: [Static]
+      summary: Serve the bundled control UI
+      description: Returns the built React control UI `index.html` from `ui/dist`.
+      operationId: getControlUiRoot
+      responses:
+        "200":
+          description: Control UI HTML.
+          content:
+            text/html:
+              schema:
+                type: string
+        "404":
+          description: UI bundle was not found.
+          content:
+            text/plain:
+              schema:
+                type: string
+  /index.html:
+    get:
+      tags: [Static]
+      summary: Serve the bundled control UI index file
+      description: Returns the built React control UI `index.html` from `ui/dist`.
+      operationId: getControlUiIndex
+      responses:
+        "200":
+          description: Control UI HTML.
+          content:
+            text/html:
+              schema:
+                type: string
+        "404":
+          description: UI bundle was not found.
+          content:
+            text/plain:
+              schema:
+                type: string
+  /assets/{assetPath}:
+    get:
+      tags: [Static]
+      summary: Serve a bundled control UI asset
+      description: Serves files from `ui/dist/assets`. The server rejects unsafe relative paths and guesses the content type from the file extension.
+      operationId: getControlUiAsset
+      parameters:
+        - name: assetPath
+          in: path
+          required: true
+          description: Relative asset path below `ui/dist/assets`.
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Static asset.
+          content:
+            text/javascript:
+              schema:
+                type: string
+            text/css:
+              schema:
+                type: string
+            image/svg+xml:
+              schema:
+                type: string
+            image/png:
+              schema:
+                type: string
+                format: binary
+            text/plain:
+              schema:
+                type: string
+        "404":
+          description: Asset was not found or the path was unsafe.
+          content:
+            text/plain:
+              schema:
+                type: string
+  /docs:
+    get:
+      tags: [Docs]
+      summary: Serve Swagger UI
+      description: Returns a small Swagger UI page pointed at `/docs/openapi.yaml`.
+      operationId: getSwaggerUi
+      responses:
+        "200":
+          description: Swagger UI HTML.
+          content:
+            text/html:
+              schema:
+                type: string
+  /docs/:
+    get:
+      tags: [Docs]
+      summary: Serve Swagger UI
+      description: Alias for `/docs`.
+      operationId: getSwaggerUiWithTrailingSlash
+      responses:
+        "200":
+          description: Swagger UI HTML.
+          content:
+            text/html:
+              schema:
+                type: string
+  /docs/openapi.yaml:
+    get:
+      tags: [Docs]
+      summary: Serve the OpenAPI document
+      operationId: getOpenApiDocumentFromDocs
+      responses:
+        "200":
+          description: OpenAPI YAML document.
+          content:
+            application/yaml:
+              schema:
+                type: string
+        "404":
+          description: OpenAPI document was not found.
+          content:
+            text/plain:
+              schema:
+                type: string
+  /openapi.yaml:
+    get:
+      tags: [Docs]
+      summary: Serve the OpenAPI document
+      description: Alias for `/docs/openapi.yaml`.
+      operationId: getOpenApiDocument
+      responses:
+        "200":
+          description: OpenAPI YAML document.
+          content:
+            application/yaml:
+              schema:
+                type: string
+        "404":
+          description: OpenAPI document was not found.
+          content:
+            text/plain:
+              schema:
+                type: string
   /api/state:
     get:
       tags: [State]