Skip to content

PoC specification

This directory holds the detailed PoC contracts produced during 02 - PoC specification, and the accepted operator-experience specification and client contracts for 04 - Operator experience, which are not PoC contracts. This index itself contains no implementation contracts and does not establish specification approval or implementation readiness.

Contract artifact Work item
docs/spec/compilation.md Secret ingress and compilation
docs/spec/persistence-api.md Persistence and API contracts
api/openapi.yaml, the OpenAPI 3.1 description of the API that persistence and API §9 defines, checked against the route table by internal/api/openapi_test.go and against the server's answers and accepted requests by internal/api/openapi_response_test.go Describe API v1 in OpenAPI and test the description against the route table
docs/spec/execution-recovery.md Execution and recovery
docs/spec/acceptance-plan.md Review and finalize the PoC specification
docs/spec/dependency-monitor.md Implement dependency retention checks, the monitor section the specification review required before implementation
docs/spec/operator-experience.md and its wireframes Design the operator journeys for bronzewardctl and the web UI, the post-PoC journeys for 04 - Operator experience; accepted for implementation on 25 October 2026, with the client contracts of #253
docs/spec/client-contracts.md Specify client authentication, API behavior and compatibility, accepted on 25 October 2026 for 04 - Operator experience: CLI and web UI; a client contract added after the milestone-02 specification, on the existing API

Add links here when those files land. Keep detailed contracts in these artifacts, with links to the current design, experimental evidence and relevant profile/policy decisions. Accepted design changes also update the design; the specification does not silently override it. If a contract needs subdivision, update this index and its issue's deliverables together.

For the PoC contracts, the specification review owns acceptance and refinement requirements. The operator-experience specification and the client contracts were reviewed under their own work items, #252 and #253, and do not change the PoC contracts. Issue state and landed review evidence establish completion; this index is not a status checklist.