Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocs API
Device

Get Public Docs Article

Retrieve one public documentation article by section and article slug. The endpoint is public, read-only and returns the article detail used by the landing Docs reader, including the resolved locale, platform, theme, section, article content and media references.

In this article

Use this guide when you need to confirm that a single Docs article can be read publicly without an authenticated app role or restaurant setup.

The GB example requests `access/en-access-users-create-location-internal` with `locale=en`, `platform=web` and `theme=light`, then opens the matching landing Docs page.

Before you start

  • The public documentation route is available at `/api/public/docs`.
  • The documentation content bundle exists and can be loaded by the backend.
  • The requested article exists for the resolved locale when using `/api/public/docs/{sectionSlug}/{articleSlug}`.

Instructions

  1. 1.

    Request the public article

    Call `GET /api/public/docs/access/en-access-users-create-location-internal?locale=en&platform=web&theme=light`. This does not require the Harbor Demo User session or Harbor Demo Group permissions.

  2. 2.

    Confirm language and display options

    Use `locale=en` for the English example. `en-GB` can resolve to `en`, but sending the locale explicitly keeps the capture deterministic. Use `platform=web` and `theme=light` for the landing Docs context.

  3. 3.

    Review the article payload

    A successful response is an article detail response, not the Docs index. Confirm it includes `version`, `locale`, `platform`, `theme`, `section` and one `article` object.

  4. 4.

    Open the rendered article

    Open `/docs/access/en-access-users-create-location-internal?lang=en` to show the public reader view that consumes the same article detail response.

  5. 5.

    Recognise error outcomes

    Missing articles return `404 Not Found`. A missing docs service or content file can return `503 Service Unavailable`, and an undecodable content bundle can return `500 Internal Server Error`. `HEAD` checks endpoint availability only and must not be used to prove article existence.

Validations and limits

  • Only `GET` returns article JSON; methods other than `GET` and `HEAD` return `405 Method Not Allowed`.
  • The canonical detail route validates the section slug against the article category and resolves the article by slugified `id`, `sourceGuideId` or `title`.
  • The response locale is `en`, platform is `web` and theme is `light` for the GB manual example.
  • The article detail contains one section reference and one article object; related articles are computed by the client from the index.
  • Any usable media `src` is emitted as `/api/public/docs/assets/{path}`; invalid or empty media sources do not become unsafe URLs.

Expected result

The public endpoint returns the English article detail payload, and the landing Docs reader renders the same article without requiring authenticated restaurant data.

Related articles