Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation and help
Device

List Authenticated Docs Index

Loads the signed-in Docs catalogue from GET /api/app/docs and returns grouped article summaries for the resolved locale and platform. It is read-only and does not include full article bodies, media URLs, restaurant records, or location-specific data.

In this article

Use this action when an authenticated app session needs the Docs navigation catalogue. In the GB demo, run it as Harbor Demo User in Harbor Demo Group; English variants such as en-GB are normalised to en in the response.

The endpoint returns compact grouped summaries only. Operators open article detail when they need prerequisites, steps, checks, results, or authenticated media assets.

Before you start

  • The operator is signed in as an active app user.
  • The signed-in account is not pending deletion.
  • The backend Docs content bundle is configured and articles.json is available.
  • Direct API inspection uses an accepted Authorization bearer token or access_token cookie.
  • Use the English GB demo context; en-GB requests return locale en.

Instructions

  1. 1.

    Open the authenticated index

    Open antylogic://docs in the app, or request GET /api/app/docs?locale=en-GB&platform=web&theme=dark from an authenticated session. Authentication and the pending-deletion account gate run before the Docs handler.

  2. 2.

    Check the index header

    Confirm the top-level payload includes version, locale, platform, optional query, article_count, and sections. theme may be sent, but it is not returned in the index body.

  3. 3.

    Review sections and summaries

    Use sections as the grouped navigation catalogue. Each section comes from the article category, and each article summary carries list-rendering fields such as id, slug, section_slug, title, summary, icon_name, has_media, and optional action_id or primary_keyword.

  4. 4.

    Search when needed

    API consumers can pass q to filter the server-side index. In the native Docs screen, Search Docs filters the already-loaded index locally; it does not send q to /api/app/docs.

  5. 5.

    Open detail for full guidance

    When the operator needs intro text, prerequisites, steps, validations, expected result, or media, open GET /api/app/docs/{sectionSlug}/{articleSlug} using the slugs from the index.

  6. 6.

    Use HEAD only for reachability

    HEAD /api/app/docs checks the authenticated route and configured Docs service, then returns 200 OK without loading articles.json or returning article_count or sections.

  7. 7.

    Handle empty or unavailable results

    A query with no matches still returns 200 OK with article_count 0 and an empty sections array. Missing content returns documentacion no configurada, unreadable or invalid content returns documentacion no disponible, and unsupported methods return 405 with metodo no permitido.

Validations and limits

  • /api/app/docs is only available to authenticated app sessions; unauthenticated consumers must use /api/public/docs.
  • Pending-deletion accounts are blocked before Docs dispatch.
  • Only GET and HEAD are supported for the index route.
  • Locale is normalised to en or es; en-GB resolves to en, while unsupported or missing locale falls back to es.
  • Platform is normalised to mobile, tablet, or web; unsupported values default to web.
  • The index does not include generated_at, total_articles, full article text, or media URL lists.
  • The index is ordered by bundled article order and first-seen category order; there is no pagination or explicit sort parameter.
  • has_media only reports whether media exists; media selection and authenticated asset URLs are resolved by the detail endpoint.
  • The bundled articles.json evidence may lag the latest documentation update run and should be regenerated if content freshness matters.

Expected result

The signed-in user receives a grouped Docs index that the app can render as a searchable catalogue, while full article guidance and media remain behind the article detail route.