aws-samples / aws-samples/sample-autonomous-cloud-coding-agents
Docs: publish OpenAPI/JSON Schema and integration index
- Vorherrschende Sprache
- TypeScript
- Sterne
- 143
- Forks
- 46
- Ø Merge
- 3 T. 10 Std.
- Gemergte PRs (30 T.)
- 24
Beschreibung
**Context:** ROADMAP.md → Exposed project specifications
---
## Doc area
Design / architecture (`docs/design/`)
## Describe the issue
ABCA lacks published **machine-readable API specs** and a single **integration/extension index**. Contributors and operators must reverse-engineer handlers and design docs to extend or fork the platform.
## Affected docs
- `docs/design/API_CONTRACT.md`
- `docs/guides/DEVELOPER_GUIDE.md`
- New: generated OpenAPI/JSON Schema artifact (location TBD, e.g. `docs/spec/` or release asset)
- Starlight site API reference page (after `mise //docs:sync`)
## Suggested change
1. Generate OpenAPI 3.x from REST handlers or maintain hand-authored spec with CI drift check.
2. Publish JSON Schema for key request/response types (sync with `cdk/src/handlers/shared/types.ts` / `cli/src/types.ts`).
3. Add **extension-point index**: webhooks, channels, workflows, Blueprint hooks, Cedar actions.
4. Stable permalinks from spec to architecture contracts listed at end of former ROADMAP.md.
5. CI gate: spec matches implementation (similar to types-sync check).
## Other information
- Complements **CDK constructs library** draft for external consumers.
- Does not replace narrative design docs.
Beitragsleitfaden
Rechercherichtung
Beginne mit docs/design/API_CONTRACT.md, docs/guides/DEVELOPER_GUIDE.md und den Typen in cdk/src/handlers/shared/types.ts und cli/src/types.ts; prüfe die REST-Handler und den vorhandenen types-sync-Check. Die Arbeit ist abgeschlossen, wenn veröffentlichte OpenAPI- und JSON-Schema-Artefakte, ein Index der Erweiterungspunkte, stabile Architektur-Links und ein CI-Drift-Check verfügbar sind und die Starlight-API-Referenz nach mise //docs:sync aktualisiert wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- openapi, typescript
- Bereich
- api, ci-cd, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100