Skip to content

Add Wave 4: Studio-local API plan#4

Merged
kylaalsbury-nealy merged 1 commit into
mainfrom
docs/studio-api-plan
May 14, 2026
Merged

Add Wave 4: Studio-local API plan#4
kylaalsbury-nealy merged 1 commit into
mainfrom
docs/studio-api-plan

Conversation

@kylaalsbury-nealy

Copy link
Copy Markdown
Contributor

Documents and roadmap entries for the localhost HTTP API approach to JSON-to-GLB conversion. Studio hosts an HttpListener bound to 127.0.0.1 and writes a discovery file; Unity reads the discovery file and makes ordinary HTTP calls. Decouples the two consumers without the cost of either a shared multi-targeted library or a hosted cloud service.

Contents:

  • docs/studio-api-contract.md: cross-cutting contract — discovery file schema, OS-conventional paths, endpoint inventory (GET /v1/health, POST /v1/convert), error response shapes, versioning policy, security model. Source of truth for both repos.
  • docs/decisions.md: ADR-0007 records the choice and the rejected alternatives (shared library, cloud API) with reasoning.
  • docs/tasks/K-studio-api-server.md: brief for the openapparatus-studio side — HttpListener, request dispatch, discovery file atomic write, settings UI.
  • docs/tasks/L-studio-api-client.md: brief for this repo — Editor/Api/ StudioDiscovery + StudioApi client, Export GLB via Studio button on MultiRoomEnvironmentAsset inspector, stale-file detection, error UX.
  • docs/roadmap.md: Wave 4 added to the wave-structure diagram, status table, parallelisation guidance, definition of done, and effort table.

Both Wave 4 tasks depend only on the contract doc being merged and run as parallel agents in their respective repos. End-to-end verification needs both halves; unit-level work doesn't.

Documents and roadmap entries for the localhost HTTP API approach to
JSON-to-GLB conversion. Studio hosts an HttpListener bound to 127.0.0.1
and writes a discovery file; Unity reads the discovery file and makes
ordinary HTTP calls. Decouples the two consumers without the cost of
either a shared multi-targeted library or a hosted cloud service.

Contents:
- docs/studio-api-contract.md: cross-cutting contract — discovery file
  schema, OS-conventional paths, endpoint inventory (GET /v1/health,
  POST /v1/convert), error response shapes, versioning policy, security
  model. Source of truth for both repos.
- docs/decisions.md: ADR-0007 records the choice and the rejected
  alternatives (shared library, cloud API) with reasoning.
- docs/tasks/K-studio-api-server.md: brief for the openapparatus-studio
  side — HttpListener, request dispatch, discovery file atomic write,
  settings UI.
- docs/tasks/L-studio-api-client.md: brief for this repo — Editor/Api/
  StudioDiscovery + StudioApi client, Export GLB via Studio button on
  MultiRoomEnvironmentAsset inspector, stale-file detection, error UX.
- docs/roadmap.md: Wave 4 added to the wave-structure diagram, status
  table, parallelisation guidance, definition of done, and effort
  table.

Both Wave 4 tasks depend only on the contract doc being merged and run
as parallel agents in their respective repos. End-to-end verification
needs both halves; unit-level work doesn't.
@kylaalsbury-nealy kylaalsbury-nealy merged commit 31f655e into main May 14, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant