Contexto
Los servicios creados con la plantilla NETCoreMongoGR publican su contrato de
API en una versión anterior del estándar (OpenAPI 3.0, generado con tooling
legado). El estándar vigente es OpenAPI 3.1, alineado completamente con
JSON Schema, y es el formato que esperan el catálogo corporativo de APIs, las
herramientas de validación y los consumidores automatizados y agénticos
de nuestros contratos.
Relacionada con la actualización de la plantilla por obsolescencia (#1).
Historia
Como responsable de Gobierno de APIs del grupo,
quiero que todo microservicio creado con la plantilla publique su contrato
en OpenAPI 3.1 válido,
para que nuestras APIs sean interoperables, validables automáticamente y
consumibles sin ambigüedad por humanos, herramientas y agentes.
Criterios de aceptación
Restricciones (guardrails)
- Retirar o reemplazar el formato de contrato que hoy consumen herramientas
existentes (portal, generadores de clientes, gateway) requiere
aprobación humana.
- No se modifica el comportamiento de los endpoints: esta misión es de
contrato y documentación, no de funcionalidad.
- Dependencias solo del catálogo aprobado.
Definición de done
Spec cumplida, contrato 3.1 validado en el pipeline, documentación accesible,
y traza completa de decisiones disponible para auditoría.
Contexto
Los servicios creados con la plantilla
NETCoreMongoGRpublican su contrato deAPI en una versión anterior del estándar (OpenAPI 3.0, generado con tooling
legado). El estándar vigente es OpenAPI 3.1, alineado completamente con
JSON Schema, y es el formato que esperan el catálogo corporativo de APIs, las
herramientas de validación y los consumidores automatizados y agénticos
de nuestros contratos.
Relacionada con la actualización de la plantilla por obsolescencia (#1).
Historia
Como responsable de Gobierno de APIs del grupo,
quiero que todo microservicio creado con la plantilla publique su contrato
en OpenAPI 3.1 válido,
para que nuestras APIs sean interoperables, validables automáticamente y
consumibles sin ambigüedad por humanos, herramientas y agentes.
Criterios de aceptación
OpenAPI 3.1 y pasa validación automática en el pipeline.
del servicio (nada mantenido a mano que pueda quedar desactualizado).
compatibilidad o publicación dual durante la transición.
cómo se valida.
Restricciones (guardrails)
existentes (portal, generadores de clientes, gateway) requiere
aprobación humana.
contrato y documentación, no de funcionalidad.
Definición de done
Spec cumplida, contrato 3.1 validado en el pipeline, documentación accesible,
y traza completa de decisiones disponible para auditoría.