Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

List Public Docs Index

Use the public Docs index to confirm that the landing Docs experience can load grouped guide summaries for the resolved locale, with optional server-side filtering for direct API checks.

In this article

This guide covers the public, read-only documentation index used by the landing Docs page and direct JSON consumers through GET /api/public/docs.

The endpoint groups article summaries into documentation sections for the resolved locale. It does not require login, organisation context, location context, role membership, or a request body.

Before you start

  • The public documentation service is registered and the docs content bundle is readable from DOCS_CONTENT_PATH or ./docs-content/articles.json.
  • Use GET for the index request. The action does not read a request body.
  • For the GB English documentation context, use locale=en-GB or locale=en; the response reports locale as en.
  • For captures, use APP_WEB_URL=/docs?lang=en for the landing page and PUBLIC_API_BASE_URL for direct API responses.

Instructions

  1. 1.

    Open the public docs index

    Open /docs?lang=en or call GET /api/public/docs?locale=en&platform=mobile&theme=light. A successful GET returns HTTP 200 with version, locale, platform, article_count, and sections.

  2. 2.

    Review sections and summaries

    Check the sections array. Each section represents a documentation category, and each article summary identifies the guide with id, slug, section_slug, optional action_id, optional primary_keyword, title, summary, icon_name, and has_media.

  3. 3.

    Check optional filtering

    For direct API checks, add q. For example, GET /api/public/docs?locale=en-GB&device=iphone&q=reservations resolves locale to en, device to platform mobile, and returns only matching summaries.

  4. 4.

    Read variants and limits

    Use platform or device only to request the intended content context. Theme is accepted by the shared options parser but is not returned by the index response because media resolution belongs to article detail.

Validations and limits

  • GET returns HTTP 200 when the docs service and content file are available.
  • article_count equals the number of returned article summaries after locale and q filtering.
  • A q value with no matches still returns HTTP 200, article_count: 0, and an empty sections array.
  • The landing Docs search box filters the already loaded summaries client-side; it should not be documented as sending q.
  • Only GET and the sibling HEAD check are accepted. HEAD /api/public/docs does not prove that articles.json can load.

Expected result

The public Docs page and direct API consumers can verify the unauthenticated documentation index, inspect grouped article summaries, and confirm locale, platform, and q normalisation without touching tenant data.

Related articles