fix(api): clarify OpenAPI discovery guidance
This commit is contained in:
parent
f765332b2e
commit
953ff25c4e
4 changed files with 9 additions and 3 deletions
|
|
@ -22,6 +22,8 @@ https://rag.por-correo.com
|
|||
| Contrato OpenAPI | `GET /openapi.json` | Esquemas, parametros, respuestas y errores |
|
||||
| Playground | `GET /playground` | Pruebas manuales desde navegador |
|
||||
|
||||
`GET /help` indica expresamente que debe consultarse `/openapi.json` para obtener los parametros, cuerpos, respuestas, errores y ejemplos completos de cada endpoint.
|
||||
|
||||
La API no requiere autenticacion actualmente. No debe asumirse que esta situacion es definitiva: la autenticacion y la proteccion de operaciones sensibles forman parte del pendiente 5.
|
||||
|
||||
## Elegir la operacion correcta
|
||||
|
|
|
|||
|
|
@ -85,8 +85,9 @@ Dar continuidad al RAG en `RAG/` a partir del estado actual documentado.
|
|||
- Ajuste por el usuario de `Ruta de compilacion` a `/` y despliegue satisfactorio del commit `f1cd87c`.
|
||||
- Validacion en produccion de health, Qdrant, playground, sources, `/help` y `/openapi.json`.
|
||||
- Regresion satisfactoria de retrieval sobre FacturaTech: 6 resultados, cero fugas de scope y coincidencias `504` en los primeros resultados.
|
||||
- Deteccion posterior de que `/help` enlazaba OpenAPI pero no explicaba para que debia consultarse.
|
||||
- Incorporacion de una instruccion explicita en `/help` sobre parametros, cuerpos, respuestas, errores y ejemplos disponibles en `/openapi.json`.
|
||||
|
||||
**Estado final:**
|
||||
- Pendiente 1 completado y validado en `https://rag.por-correo.com`.
|
||||
- Ajuste final del pendiente 1 implementado y pendiente de revalidacion en `https://rag.por-correo.com`.
|
||||
- La API dispone de descubrimiento rapido y contrato OpenAPI para sus 16 operaciones.
|
||||
- Siguiente prioridad: ciclo de vida del conocimiento.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Este documento es la fuente canonica del orden de trabajo pendiente del modulo R
|
|||
|
||||
## 1. Documentacion y descubrimiento de la API
|
||||
|
||||
**Estado:** Completado y validado en produccion el 2026-09-08.
|
||||
**Estado:** Ajuste final implementado; pendiente de publicacion y revalidacion en produccion.
|
||||
|
||||
- Implementar `/help` o una especificacion OpenAPI consultable.
|
||||
- Actualizar documentos desfasados que todavia muestran como pendientes funciones ya desplegadas, como playground, logs y cleanup.
|
||||
|
|
|
|||
|
|
@ -618,8 +618,10 @@ export const openApiDocument = {
|
|||
description: { type: "string" },
|
||||
documentation: {
|
||||
type: "object",
|
||||
required: ["openapi", "openapiPurpose", "playground"],
|
||||
properties: {
|
||||
openapi: { type: "string" },
|
||||
openapiPurpose: { type: "string" },
|
||||
playground: { type: "string" }
|
||||
}
|
||||
},
|
||||
|
|
@ -655,6 +657,7 @@ export function buildApiHelp() {
|
|||
description: openApiDocument.info.description,
|
||||
documentation: {
|
||||
openapi: "/openapi.json",
|
||||
openapiPurpose: "Consult this contract for complete parameters, request bodies, responses, errors, and examples for every endpoint.",
|
||||
playground: "/playground"
|
||||
},
|
||||
authentication: "None. The current API is publicly accessible; authentication is planned separately.",
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue