Listar índice de Docs
Comprueba el índice localizado de documentación desde la Wiki pública y desde la app con sesión. El índice devuelve versión, idioma normalizado, plataforma solicitada, número de artículos y secciones con resúmenes, sin cargar el detalle completo de cada artículo.
En este artículo
Usa esta guía cuando necesites validar que la documentación embebida está disponible para la landing, la Wiki pública y la pantalla Docs de la app.
El índice es una lectura del bundle local de documentación: no consulta ni modifica datos operativos de restaurante, reservas, TPV, personal, organizaciones o ubicaciones.
Antes de empezar
- El bundle de documentación debe estar desplegado con `articles.json` en el content path configurado.
- Para `/api/public/docs`, `/docs`, `/manual` y `/wiki` no hace falta sesión ni permisos.
- Para `/api/app/docs` y `antylogic://docs` hace falta una sesión válida de Demo Marea.
- Para capturas públicas, el entorno debe exponer `APP_WEB_URL` y una base válida para `PUBLIC_API_BASE_URL`.
Instrucciones
- 1.
Abrir la Wiki pública
Abre `/docs`, `/manual` o `/wiki`. La página debe mostrar Docs con secciones y artículos localizados en español, sin pedir inicio de sesión, organización ni ubicación.
- 2.
Comprobar el contrato público
Consulta `GET /api/public/docs?locale=es&platform=mobile`. La respuesta esperada es `200` con `version`, `locale`, `platform`, `article_count` y `sections`; cada sección contiene resúmenes, no el detalle completo del artículo.
- 3.
Revisar idioma y plataforma
Comprueba que `locale=es-ES` queda como `es`, que `device=iphone` queda como `mobile` y que una plataforma desconocida cae a `web`. `theme` puede enviarse, pero no cambia el índice visible.
- 4.
Interpretar las secciones
Valida que `article_count` coincide con la suma de artículos de `sections`. Cada resumen incluye `id`, `slug`, `section_slug`, `title`, `summary`, `icon_name`, `has_media` y, si existen, `action_id` y `primary_keyword`.
- 5.
Abrir Docs con sesión
Con la sesión de Demo Marea activa, abre `antylogic://docs` o consulta `GET /api/app/docs?locale=es&platform=web`. La ruta autenticada exige token válido, pero no permisos operativos granulares.
- 6.
Separar índice, búsqueda y detalle
Esta acción describe el índice base. Si se envía `q`, el handler filtra por texto; ese caso pertenece a `docs.content.search-index`. El índice base no devuelve `intro`, `prerequisites`, `steps`, `validations`, `result` ni `media`.
Validaciones y límites
- `/api/public/docs` no depende de sesión, permisos, organización ni ubicación.
- `/api/app/docs` requiere autenticación general, no permisos como `user-reports:manage`.
- `platform` se refleja normalizada en la respuesta, pero no filtra artículos del índice.
- `theme` no tiene efecto observable en esta acción.
- Si no hay artículos para el idioma normalizado, la respuesta sigue siendo `200` con `article_count: 0` y `sections: []`.
- Si falta `articles.json`, la API devuelve `503` con `documentacion no configurada`; si falla lectura o decode, devuelve `500` con `documentacion no disponible`.
- Los métodos `POST`, `PUT`, `PATCH` y `DELETE` no forman parte de esta acción.
Resultado esperado
Al terminar, habrás comprobado que el índice de Docs se entrega por la Wiki pública, por la API pública, por la API autenticada y por la pantalla Docs de la app, manteniendo separadas las responsabilidades de índice, búsqueda y detalle.