[OpenSpec] sharing-generated-api-docs

[github-actions]

⚠️ OpenSpec-managed issue — this content is automatically synced
from the openspec/ directory. Manual edits will be overwritten on next sync.

Artifacts

• ✅ Metadata
• ✅ Proposal
• ✅ Specs
• ✅ Design
• ✅ Tasks
• 🔲 Plan
• 🔲 Review

Summary

A developer at a municipality or a supplier reads the catalogue API from generated documentation instead of hand-written pages: the catalogue objects as OpenRegister describes them, and stackiq's own endpoints as the code describes them. Both open from one API documentation page in stackiq, and both download as OpenAPI files. The generated file in the repository stops being empty.

Specs

• 📄 generated-api-docs

Tasks

• Implement
• Test (composer openapi:check exit 0; PHPUnit unchanged)
• Implement
• Test (composer check:strict including openapi:check)
• Implement
• Test (vitest tests/vitest/openApiReader.spec.js; Playwright tests/e2e/workflows/api-docs.spec.ts)
• Implement
• Test (PHPUnit tests/Unit/Controller/AangebodenGebruikControllerTest.php docs case; docs build with a screenshot)

Design

See design.md for technical design details.

---

Synced from openspec/changes/sharing-generated-api-docs by OpenSpec workflow
App: stackiq