Antylogic
DemoApp login

399 operational guides

Docs sections
DocsDocumentation
Device

Get an article

Look up the localised detail of a documentation article from the public wiki or from authenticated Documentation, using the section and the article slug or a legacy single-segment slug.

In this article

Use this guide when you need to check how Antylogic resolves a specific help article from the documentation bundle. The public wiki and the authenticated screen use the same content; what changes is the required authentication and the prefix used to publish assets.

The recommended route uses `sectionSlug` plus `articleSlug`, because the app and the wiki reach the detail from the documentation index. The single-segment slug remains only as compatibility for old links.

Before you start

  • `backend/docs-content/articles.json` must be available through `DOCS_CONTENT_PATH` or the default `./docs-content` path.
  • To open the detail from `/api/app/docs/...` or `antylogic://docs/...`, the user must have a valid session; no additional business permission is required.
  • For images to display fully, `DOCS_ASSETS_PATH` must resolve the assets referenced by the bundle.
  • In the app and in the wiki, the operator normally starts from the documentation index, which already provides `section_slug` and `slug`.

Instructions

  1. 1.

    Open the public article

    Go to `/docs/access/en-auth-native-login?lang=en`. The public wiki loads the detail from `/api/public/docs/access/en-auth-native-login?locale=en&platform=mobile&theme=light` and must show the title, intro, steps, validations and media or placeholder without asking for a session.

  2. 2.

    Check the authenticated detail

    With an active GB demo session, open `antylogic://docs/access/en-auth-native-login` or navigate from the help index. The equivalent route is `/api/app/docs/access/en-auth-native-login?locale=en&platform=mobile&theme=light`.

  3. 3.

    Select the language, platform and theme variant

    Use `locale`, `platform` or `device`, and `theme` to request the right variant. The backend normalises the language to `es` or `en`, the platform to `mobile`, `tablet` or `web`, and the theme to `light` or `dark`.

  4. 4.

    Review the JSON contract

    The detail response must include `version`, `locale`, `platform`, `theme`, `section` and `article`. Inside `article` you find the intro, prerequisites, steps, validations, result, `icon_name` and `media`.

  5. 5.

    Handle old routes and errors

    If the article does not appear, first confirm that the index lists it with the expected section and slug. The endpoints also accept `/api/public/docs/{articleSlug}` and `/api/app/docs/{articleSlug}` for old links, but new routes must keep section plus article.

Validations and limits

  • `GET /api/public/docs/{sectionSlug}/{articleSlug}` exposes the content without authentication or business permissions.
  • `GET /api/app/docs/{sectionSlug}/{articleSlug}` requires a general session through `requireAuthMiddleware`, with no permissions per organisation, location, role, reports, POS or bookings.
  • `section.slug` is derived from the article category; `article.slug` is derived from `ID`, `SourceGuideID` or `Title`, compared as normalised slugs.
  • `q` does not filter the article detail; search applies to the documentation index.
  • If the asset is resolvable, `article.media[].src` points to `/api/public/docs/assets/{path}` or `/api/app/docs/assets/{path}` depending on the request prefix.
  • The detail does not validate that media files physically exist; that check happens when `/api/*/docs/assets/{path}` is requested.
  • `HEAD` on detail routes returns 200 before validating that the article exists; document it as implemented behaviour.
  • If `articles.json` is missing, the API responds 503; if the JSON cannot be decoded, it responds 500; methods other than GET and HEAD receive 405.

Expected result

The operator can open the same localised article from the public wiki or from authenticated Documentation, recognise which variant was selected, and tell whether a problem belongs to the bundle, the session or the documentation assets.

Related articles