Cargar el índice público de Docs
Abre la pantalla pública de Docs o llama a la API de índice de Docs sin autenticación para recuperar resúmenes de artículo agrupados para navegación y búsqueda. El índice se acota por locale de documentación, plataforma seleccionada y tema, con filtrado opcional por q en el servidor para consumidores directos de la API.
En este artículo
Usa esta guía cuando los operadores de soporte, los consultores de implantación o los mantenedores de documentación necesiten confirmar que el índice público de Docs está disponible sin inicio de sesión en Antylogic.
La pantalla de Docs de la landing carga el índice desde /api/public/docs y después filtra localmente la lista visible. Los consumidores directos de la API pueden añadir q a la petición cuando necesiten filtrado en el servidor.
Para el destino de documentación de ES, usa /docs?lang=es o pasa locale=es para que la documentación generada en español se solicite explícitamente.
Antes de empezar
- Abre la ruta de documentación de la landing mediante /docs, /manual o /wiki.
- Usa la documentación en español para es-ES abriendo la página con lang=es, o llamando a la API con locale=es.
- El navegador o el cliente de API puede alcanzar PUBLIC_API_BASE_URL. Las ejecuciones locales de la landing usan normalmente http://localhost:8081 salvo que se configure otra cosa.
- El backend tiene un bundle de contenido de docs legible, normalmente backend/docs-content/articles.json o la ruta configurada mediante DOCS_CONTENT_PATH.
- No se requiere inicio de sesión en Grupo Marea Demo, pertenencia a organización, rol de ubicación ni sesión demo para este índice público.
Instrucciones
- 1.
Abre la pantalla pública de Docs
Abre /docs?lang=es en el sitio de la landing. /manual y /wiki llegan a la misma pantalla de Docs. Mantener el idioma en español hace que la pantalla de la landing solicite locale=es al servicio público de docs.
- 2.
Deja que la petición de índice se resuelva
La pantalla resuelve el locale de documentación, la plataforma seleccionada y el tema activo, y después solicita /api/public/docs con locale, platform y theme. El fetch del navegador puede incluir cookies según su configuración, pero el endpoint no requiere autenticación.
- 3.
Revisa el índice agrupado
Cuando la petición tenga éxito, revisa las secciones y los resúmenes de artículo devueltos. El índice es solo de resúmenes: los cuerpos de artículo, los pasos, las validaciones, los prerrequisitos y las URLs de media los cargan las acciones de detalle de artículo.
- 4.
Usa q solo para el filtrado directo de la API
Al llamar a la API directamente, añade q para devolver los resúmenes de artículo coincidentes, por ejemplo /api/public/docs?locale=es&platform=mobile&theme=light&q=reservas. La entrada de búsqueda de Docs de la landing filtra localmente sobre el índice ya cargado y no envía q.
- 5.
Confirma los fallbacks y los estados de error
Los valores de plataforma no soportados se normalizan a web, los alias de teléfono a mobile, ipad a tablet, y los temas ausentes o distintos de oscuro a light. Las capturas directas de ES deben pasar locale=es porque el fallback de locale del backend usa es cuando el locale de la petición falta o no está soportado.
Validaciones y límites
- La pantalla de Docs carga sin pedir inicio de sesión en Grupo Marea Demo.
- La petición pública incluye locale=es, un valor de plataforma y el tema resuelto.
- El contador visible de guías coincide con article_count del índice devuelto.
- Los artículos se agrupan en secciones derivadas de su categoría, y los resúmenes exponen solo campos de índice como id, slug, section_slug, title, summary, icon_name y has_media.
- Una petición directa con q devuelve la consulta normalizada y sigue devolviendo 200 con article_count: 0 y sections: [] cuando no hay coincidencias.
- Solo se aceptan GET y HEAD en /api/public/docs; el resto de métodos devuelven 405.
- HEAD /api/public/docs solo demuestra alcanzabilidad superficial de la ruta y no debe usarse como evidencia de que exista un artículo concreto o el bundle actual.
Resultado esperado
El índice público de Docs se carga como navegación por secciones agrupadas para la pantalla de Docs de la landing o se devuelve como JSON sin autenticación para consumidores directos, con el filtrado por q documentado solo para llamadas directas a la API.