Referencia — Operator
Cuadrante 03_REFERENCE — datos exactos, auto-generados. No editar a mano.
La referencia técnica del BFF vive junto al código que la genera, en
backend/docs/03_REFERENCE/:
| Documento | Se genera de | Con |
|---|---|---|
| openapi.json | la app FastAPI | scripts/export_openapi.py |
| environment.md | app/core/config.py + docker-compose.yml |
scripts/generate_env_docs.py |
| error-codes.md | las clases OperatorError |
scripts/generate_error_codes_docs.py |
| schema.md | los modelos SQLAlchemy | scripts/generate_schema_docs.py |
El CI los regenera y bloquea el merge si hay drift (operator-backend-ci.yml), así que un
doc desactualizado no puede llegar a main. El tipado del frontend sale del mismo openapi.json
vía npm run generate:api, con su propio gate.
Este directorio queda para referencia transversal de la vertical que no sea ni backend ni frontend. Hoy no hay ninguna.