Comprobaciones reproducibles
Qué verifica cada comprobación automática del contrato, el inventario, los ejemplos y esta documentación.
| Comando | Qué verifica |
|---|---|
npm run contracts:check | Ambos OpenAPI, los ejemplos JSON y la sincronía de los tipos generados. |
npm run inventory:check | Que el inventario coincide con controladores, permisos, límites y referencias de pruebas. |
npm run test:inventory | Que un cambio incompatible de rutas o permisos, o una evidencia inexistente, hace fallar el inventario. |
npm test | Lógica de dominio, ejemplos y recuperación. |
npm run test:integration | Los recorridos TypeScript y curl sin modificar contra el servicio: respuestas, permisos, aislamiento e idempotencia; también el ejemplo de notas con firma y receptor locales. Requiere la base desechable trifaco_test configurada en TEST_*, las dependencias de firma y OpenSSL. Solo vacía esa base. |
npm run docs:check | Esta documentación (ver abajo). |
contracts:check necesita el entorno Python de .venv-signing (ver README).
Comprobación de la documentación
npm run docs:check ejecuta docs-site/scripts/check-content.mjs y falla si:
- una página no tiene front matter válido (
title,description,audience); - una página no figura en el
meta.jsonde su carpeta, o unmeta.jsonnombra una página inexistente; - un enlace relativo no resuelve a un archivo del repositorio o a una página del sitio;
- un enlace a la referencia (
/docs/referencia/…) apunta a una operación que no está publicada, es decir, pendiente o inexistente; - un ejemplo contiene algo con forma de credencial (
tf_…).
Después, npm run docs:build compila el sitio estático: el build también valida el front matter y genera la referencia desde api/openapi.yaml y api/operations.json.
Política de cambios
- Para actualizar el inventario, edita
api/operations-policy.jsony ejecutanpm run inventory:generate. Una ruta conectada aparece automáticamente en la referencia. - Cada operación pendiente conserva su card; cada operación conectada declara ambiente, alcance y evidencia.
- Estos controles no sustituyen la revisión semántica: un cambio de significado puede mantener el mismo esquema. Ver la política de compatibilidad.
Recuperar la credencial inicial
Procedimiento del operador para emitir una credencial sustituta cuando el propietario perdió la inicial y no tiene otra clave con keys:write.
Consultar empresa propia GET
**Estado:** implementada. **Ambientes:** simulation, qualification. **Permisos:** `company:read`. **Alcance:** Perfil y estado actuales; updated_at refleja cambios de perfil, versión o estado. Consultar empresa propia