Documentar funcionalidad de debug en README y PLAN
All checks were successful
build-and-deploy / build-and-deploy (push) Successful in 16s

- Agregar sección de botones de debug (temporales) en README
- Documentar endpoints /api/debug/reset-database y /api/debug/seed-database
- Incluir advertencias y flujos de uso recomendados
- Marcar claramente como TEMPORALES con instrucciones de no eliminar
- Actualizar PLAN con endpoints de debug en sección Completado
This commit is contained in:
2025-11-21 19:55:26 -06:00
parent a6672cdcd0
commit fdb01ecb0c
2 changed files with 108 additions and 5 deletions

View File

@@ -8,7 +8,7 @@
- [x] Modelo de base de datos (grafo DAG)
- [x] Scripts de inicialización y seed con datos de ejemplo
- [x] API REST completa (11 endpoints)
- [x] API REST completa (11 endpoints + 2 debug temporales)
- [x] Función recursiva de trazabilidad SQL
- [x] Autenticación con Authentik Proxy
- [x] CI/CD con Gitea Actions
@@ -16,6 +16,11 @@
- [x] Persistencia de datos entre deploys
- [x] Configuración automática de autenticación PostgreSQL
- [x] Botones de prueba de API en frontend
- [x] **Botones de debug temporales** para gestión de BD (reset y seed)
- ⚠️ Marcados como TEMPORALES - NO ELIMINAR sin consultar
- `POST /api/debug/reset-database` - DROP de todas las tablas
- `POST /api/debug/seed-database` - Carga datos de ejemplo
- UI con advertencias notorias en rojo
### 🎯 Objetivo Actual: Visualización del Grafo
@@ -84,6 +89,9 @@ El **Sistema de Trazabilidad de Lotes** rastrea el flujo completo del café desd
│ │ │ │ ├── [id].patch.ts
│ │ │ │ ├── [id].delete.ts
│ │ │ │ └── [id]/
│ │ │ ├── debug/ # ⚠️ TEMPORALES
│ │ │ │ ├── reset-database.post.ts
│ │ │ │ └── seed-database.post.ts
│ │ │ │ └── trazabilidad.get.ts
│ │ │ └── operaciones/
│ │ │ ├── index.get.ts
@@ -368,6 +376,61 @@ Content-Type: application/json
}
```
### 4. Endpoints de Debug (⚠️ Temporales)
**⚠️ ADVERTENCIA**: Estos endpoints son temporales y están marcados para no eliminar sin consultar.
#### Reset Database
```bash
POST /api/debug/reset-database
```
**Descripción**: Elimina completamente todas las tablas (DROP TABLE) para reinicializar la BD.
**Respuesta:**
```json
{
"success": true,
"message": "Base de datos reseteada. Tablas eliminadas completamente. El próximo deploy las recreará con datos de ejemplo."
}
```
**Flujo recomendado:**
1. Llamar a este endpoint desde el frontend (botón rojo)
2. Hacer push para triggear workflow
3. El workflow detecta que no hay tablas y las recrea con seed
#### Seed Database
```bash
POST /api/debug/seed-database
```
**Descripción**: Ejecuta el script de seed (`02_seed.sql`) para cargar datos de ejemplo.
**Respuesta:**
```json
{
"success": true,
"message": "Datos de ejemplo cargados: 10 lotes, 7 operaciones, 16 relaciones"
}
```
**Uso típico:**
- Después de resetear la BD manualmente
- Para pruebas de desarrollo
- Para restaurar datos de ejemplo rápidamente
**⚠️ Nota importante**: Estos endpoints incluyen comentarios muy visibles en el código fuente:
```typescript
/**
* ⚠️ ⚠️ ⚠️ ENDPOINT DE DEBUG - TEMPORAL ⚠️ ⚠️ ⚠️
*
* ⚠️ NO ELIMINAR SIN CONSULTAR A DARIO/DRAGANEL/NUCLEO000 ⚠️
*/
```
---
## Componentes Frontend