Listar el índice de Docs autenticado
Carga el catálogo de Docs con sesión iniciada desde GET /api/app/docs y devuelve resúmenes de artículo agrupados para el locale y la plataforma resueltos. Es de solo lectura y no incluye cuerpos completos de artículo, URLs de media, registros de restaurante ni datos específicos de ubicación.
En este artículo
Usa esta acción cuando una sesión autenticada de la app necesite el catálogo de navegación de Docs. En la demo de ES, ejecútala como usuario demo en Grupo Marea Demo; las variantes en español como es-ES se normalizan a es en la respuesta.
El endpoint devuelve solo resúmenes agrupados compactos. Los operadores abren el detalle del artículo cuando necesitan prerrequisitos, pasos, comprobaciones, resultados o assets de media autenticados.
Antes de empezar
- El operador ha iniciado sesión como usuario activo de la app.
- La cuenta con sesión iniciada no está pendiente de eliminación.
- El bundle de contenido de Docs del backend está configurado y articles.json está disponible.
- La inspección directa de la API usa un Authorization bearer token aceptado o una cookie access_token.
- Usa el contexto demo de ES en español; las peticiones es-ES devuelven locale es.
Instrucciones
- 1.
Abre el índice autenticado
Abre antylogic://docs en la app, o solicita GET /api/app/docs?locale=es-ES&platform=web&theme=dark desde una sesión autenticada. La autenticación y la puerta de cuentas pendientes de eliminación se ejecutan antes del handler de Docs.
- 2.
Comprueba la cabecera del índice
Confirma que el payload de nivel superior incluye version, locale, platform, query opcional, article_count y sections. theme puede enviarse, pero no se devuelve en el cuerpo del índice.
- 3.
Revisa las secciones y los resúmenes
Usa sections como catálogo de navegación agrupado. Cada sección procede de la categoría del artículo, y cada resumen de artículo lleva campos de renderizado de lista como id, slug, section_slug, title, summary, icon_name, has_media y, opcionalmente, action_id o primary_keyword.
- 4.
Busca cuando haga falta
Los consumidores de la API pueden pasar q para filtrar el índice en el servidor. En la pantalla nativa de Docs, Buscar en Docs filtra localmente el índice ya cargado; no envía q a /api/app/docs.
- 5.
Abre el detalle para la guía completa
Cuando el operador necesite el texto de introducción, los prerrequisitos, los pasos, las validaciones, el resultado esperado o la media, abre GET /api/app/docs/{sectionSlug}/{articleSlug} usando los slugs del índice.
- 6.
Usa HEAD solo para alcanzabilidad
HEAD /api/app/docs comprueba la ruta autenticada y el servicio de Docs configurado, y devuelve 200 OK sin cargar articles.json ni devolver article_count o sections.
- 7.
Gestiona los resultados vacíos o no disponibles
Una consulta sin coincidencias sigue devolviendo 200 OK con article_count 0 y un array sections vacío. El contenido ausente devuelve documentacion no configurada, el contenido ilegible o inválido devuelve documentacion no disponible, y los métodos no soportados devuelven 405 con metodo no permitido.
Validaciones y límites
- /api/app/docs solo está disponible para sesiones autenticadas de la app; los consumidores no autenticados deben usar /api/public/docs.
- Las cuentas pendientes de eliminación se bloquean antes del despacho de Docs.
- Solo se soportan GET y HEAD para la ruta de índice.
- El locale se normaliza a en o es; es-ES resuelve a es, mientras que un locale no soportado o ausente cae a es.
- La plataforma se normaliza a mobile, tablet o web; los valores no soportados caen por defecto a web.
- El índice no incluye generated_at, total_articles, el texto completo de los artículos ni listas de URLs de media.
- El índice se ordena por el orden de los artículos empaquetados y por el orden de primera aparición de la categoría; no hay paginación ni parámetro de ordenación explícito.
- has_media solo indica si existe media; la selección de media y las URLs autenticadas de assets las resuelve el endpoint de detalle.
- La evidencia articles.json empaquetada puede ir por detrás del último run de actualización de documentación y debe regenerarse si la frescura del contenido importa.
Resultado esperado
El usuario con sesión iniciada recibe un índice de Docs agrupado que la app puede mostrar como catálogo con búsqueda, mientras la guía completa del artículo y la media permanecen detrás de la ruta de detalle del artículo.