Cargar el índice de Docs autenticado
Abre la pantalla de Docs con sesión iniciada y carga `/api/app/docs` para el idioma, el ancho de dispositivo y el tema actuales. En la demo de ES, el usuario demo puede ver secciones de guías agrupadas y resúmenes de artículo sin seleccionar una organización o ubicación concreta.
En este artículo
Usa esta guía para validar la primera carga de Docs para un operador autenticado. La pantalla solicita un índice al endpoint de docs de la app y después muestra las secciones y resúmenes disponibles en la barra lateral de Docs.
Esta acción se limita al índice. Abrir una guía, cargar el cuerpo de un artículo, resolver enlaces de artículos heredados y escribir en la búsqueda local son flujos independientes.
Antes de empezar
- El usuario demo ha iniciado sesión y no está bloqueado por la puerta de pendiente de eliminación.
- La pantalla de Docs se abre desde el menú de usuario, `/docs` o `antylogic://docs`.
- El bundle de contenido de docs está configurado e incluye al menos un artículo en español.
- Para capturas, usa la sesión demo autenticada de ES y mantén sin cambios los IDs y rutas implementados como `docs.app.load-index`, `/api/app/docs`, `locale=es`, `platform=web` y `theme=light`.
Instrucciones
- 1.
Abre Docs con sesión iniciada
Abre Docs desde el menú de usuario o usa `/docs` / `antylogic://docs`. La ruta no requiere que Grupo Marea Demo o Marea Gran Via estén seleccionados, pero sigue usando la sesión autenticada activa de la app.
- 2.
Deja que la petición de índice termine
Al montarse, la pantalla resuelve el español a `locale=es`, detecta `mobile`, `tablet` o `web` a partir del ancho de la ventana, añade el tema actual y llama a `GET /api/app/docs`. Mientras la petición se carga, la interfaz en español muestra `Cargando documentación...`.
- 3.
Comprueba las secciones cargadas
Cuando el índice se haya cargado, confirma que la pantalla de Docs muestra `Docs`, `Buscar en Docs`, el contador de guías, las cabeceras de sección, los enlaces de artículo y los resúmenes. Si la ruta no nombraba ningún artículo, el primer resumen disponible se selecciona automáticamente.
- 4.
Mantente en la carga del índice
Usa la lista de secciones cargada para entender qué guías están disponibles. El campo de búsqueda visible filtra localmente el índice ya cargado; no envía `q` durante esta acción inicial. Los campos de detalle de artículo y la media no forman parte de esta respuesta de índice.
- 5.
Gestiona los estados vacíos o fallidos
Si la petición falla, la interfaz en español muestra `No se pudo cargar la documentación.` Si el índice está vacío para el idioma y el dispositivo actuales, muestra `No hay artículos disponibles para este idioma y dispositivo.` `HEAD /api/app/docs` es solo una comprobación del servicio, no una búsqueda de contenido.
Validaciones y límites
- La petición de índice se autentica a través de `/api/app/docs`; un `401` puede disparar la renovación de sesión y un reintento antes de mostrar un error.
- La respuesta de índice incluye `version`, `locale`, `platform`, `article_count` y `sections` agrupadas.
- Cada sección incluye `slug`, `title` y `articles`; cada resumen de artículo puede incluir `id`, `slug`, `section_slug`, `action_id`, `primary_keyword`, `title`, `summary`, `icon_name` y `has_media`.
- La construcción actual del índice filtra por locale y por `q` opcional del servidor; `platform` se devuelve tal cual y `theme` lo envía el cliente pero no filtra los artículos del índice.
- Solo `GET` y `HEAD` son métodos válidos de docs. La configuración de docs ausente puede devolver `503 documentacion no configurada`; otros fallos de contenido pueden devolver `500 documentacion no disponible`.
Resultado esperado
El índice autenticado de Docs se carga y se muestra como secciones de guías agrupadas y resúmenes de artículo, sin abrir el detalle de artículo ni usar la búsqueda local.