Skip to content

Ecosystem: Generate and publish a typed client SDK from the OpenAPI spec #806

Description

@joelpeace48-cell

Context

Partners integrate against the REST API by hand. A generated, versioned SDK (TS first) lowers
integration cost and prevents drift.

Scope

  • Maintain an authoritative OpenAPI spec; generate a TypeScript SDK in CI on each release.
  • Typed methods, auth handling, retries/backoff, and pagination helpers.
  • Publish to a registry with semver tied to the API version.

Acceptance criteria

  • A generated, typed SDK is published per release and stays in sync with the spec (CI-checked).

Verification

  • Spec change regenerates the SDK; a drift check fails if the spec and SDK diverge.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: backendBackend API (Node/Express)difficulty: mediumModerate complexitydxDeveloper experiencegrowthDrives user acquisition, retention, or virality

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions