Skip to content

Publish an adopter-first tutorial for connecting an existing HTTP API #519

Description

@jeremi

User outcome

A new adopter can connect one small existing JSON/HTTP API to Registry Stack, normalize the response, and expose the result through the supported local workflow without checking out this repository or learning maintainer tooling.

Scope

  • Use a stable, public, non-sensitive demonstration API with a tiny response contract and deterministic offline fixtures.
  • Start from an installed registryctl release and an adopter-owned project directory.
  • Teach one bounded request, field mapping, fixture-backed testing, local start, a successful request, and one intentional negative control.
  • Explain the trust boundary for reviewed Rhai/configuration in adopter language.
  • Link forward to domain-specific OpenCRVS, DHIS2, and FHIR work rather than embedding those larger integrations here.

Acceptance criteria

  • The tutorial can be completed from a clean temporary directory using released artifacts only.
  • The live demonstration does not require credentials, personal data, or an account.
  • Tests use committed deterministic fixtures and do not depend on the demo service being online.
  • Every command and expected result is verified by an exact tutorial execution test or retained reader run packet.
  • Failure and cleanup steps are included.
  • The page is linked from the adopter-facing Connect your data path.

Related work

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions