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

Docs: publish OpenAPI/JSON Schema and integration index

Abierto
#453 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation enhancement
Lenguaje dominante
TypeScript
Estrellas
146
Forks
46
Merge medio
3 d 10 h
PR fusionados (30 d)
24

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con docs/design/API_CONTRACT.md, docs/guides/DEVELOPER_GUIDE.md y los tipos de cdk/src/handlers/shared/types.ts y cli/src/types.ts; revisa los handlers REST y la comprobación types-sync existente. El trabajo estará terminado cuando estén disponibles artefactos publicados de OpenAPI y JSON Schema, un índice de puntos de extensión, enlaces estables a la arquitectura y una comprobación de deriva en CI, y la referencia de API de Starlight se haya actualizado después de mise //docs:sync.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
openapi, typescript
Área
api, ci-cd, documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
42/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.