aws-samples / aws-samples/sample-autonomous-cloud-coding-agents

Docs: publish OpenAPI/JSON Schema and integration index

Aperta
#453 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation enhancement
Lingua principale
TypeScript
Stelle
143
Fork
46
Merge medio
3g 10h
PR unite (30g)
24

Descrizione

**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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da docs/design/API_CONTRACT.md, docs/guides/DEVELOPER_GUIDE.md e dai tipi in cdk/src/handlers/shared/types.ts e cli/src/types.ts; esamina gli handler REST e il controllo types-sync esistente. Il lavoro è completato quando sono disponibili artefatti OpenAPI e JSON Schema pubblicati, un indice dei punti di estensione, link stabili all’architettura e un controllo del drift in CI, e il riferimento API di Starlight è stato aggiornato dopo mise //docs:sync.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
openapi, typescript
Ambito
api, ci-cd, documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.