Docs update
Some checks failed
CI / React UI Build (push) Successful in 11s
CI / Native Windows Build And Tests (push) Failing after 2m11s
CI / Windows Release Package (push) Has been skipped

This commit is contained in:
2026-05-21 17:14:29 +10:00
parent 5c46eaf18a
commit 3fc78d5bb8
7 changed files with 204 additions and 559 deletions

View File

@@ -23,7 +23,7 @@ tags:
- name: Layers
description: Layer stack control.
- name: Stack Presets
description: Save and recall layer stack presets.
description: Planned save/recall layer stack presets. The current native host exposes the routes but returns an unimplemented action result.
- name: Runtime
description: Runtime actions.
paths:
@@ -233,7 +233,7 @@ paths:
post:
tags: [Layers]
summary: Move a layer by direction
description: Moves a layer up or down by one or more positions, depending on the signed direction value.
description: Planned relative move route. The current native command path supports `/api/layers/reorder`; this route currently returns an unimplemented action result.
operationId: moveLayer
requestBody:
required: true
@@ -329,7 +329,8 @@ paths:
/api/stack-presets/save:
post:
tags: [Stack Presets]
summary: Save the current layer stack as a preset
summary: Planned preset save route
description: Planned preset route. The current native command path currently returns an unimplemented action result; latest-working-state autosave uses `runtime/runtime_state.json`.
operationId: saveStackPreset
requestBody:
required: true
@@ -345,7 +346,8 @@ paths:
/api/stack-presets/load:
post:
tags: [Stack Presets]
summary: Load a layer stack preset
summary: Planned preset load route
description: Planned preset route. The current native command path currently returns an unimplemented action result; latest-working-state startup restore uses `runtime/runtime_state.json`.
operationId: loadStackPreset
requestBody:
required: true
@@ -362,7 +364,7 @@ paths:
post:
tags: [Runtime]
summary: Reload shaders
description: Rescans the shader library, re-reads manifests, queues shader compilation, and refreshes shader availability/errors. If a changed shader fails, the previous working stack remains active where possible.
description: Rescans the shader library, re-reads manifests, refreshes shader availability/errors, reconciles active layer parameter definitions, and queues recompilation for every catalog-valid layer in the active stack. It does not compile every shader package in the library; packages are compiled when they are active layers. If a rebuild fails, the previous working render stack remains active where possible.
operationId: reloadShaders
requestBody:
required: false
@@ -379,8 +381,8 @@ paths:
/api/screenshot:
post:
tags: [Runtime]
summary: Queue a PNG screenshot of the final output render target
description: Captures the next completed output render target and writes it under `runtime/screenshots/`.
summary: Planned screenshot route
description: Planned screenshot route. The current native command path currently returns an unimplemented action result.
operationId: queueScreenshot
requestBody:
required: false