Repository navigation
feat(api): publish a typed API client package for docforum-web from the OpenAPI spec - #239
Merged
afeezorobsco-cyber merged 3 commits intoOct 23, 2026
Conversation
Malware scan: passed, with notes for the reviewerNothing malicious was detected in
|
afeezorobsco-cyber
approved these changes
Oct 23, 2026
afeezorobsco-cyber
left a comment
afeezorobsco-cyber
left a comment
Contributor
There was a problem hiding this comment.
Reviewed: no malicious code found, CI is green. Merging.
nasirudeenbadirudeen87-cloud
pushed a commit
to nasirudeenbadirudeen87-cloud/docforum-core
that referenced
this pull request
Oct 26, 2026
…api.json The OpenAPI generator from DocForum#112 landed on main (DocForum#239) and writes backend/openapi.json, so point the docs-site sync at that path instead of the never-created docs/api/openapi.json. The docs build now succeeds.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Publishes
@docforum/api-client, a versioned, generated TypeScript client derived from the DocForum OpenAPI spec. This removes hand-mirrored backend shapes fromdocforum-web'ssrc/types/models.ts, turns contract drift into compile-time errors, and follows the same GitHub Release tarball publishing mechanism as@docforum/escrow-sdk(ADR 0003 indocforum-escrow).Changes
backend/openapi.json— Versioned OpenAPI 3 spec generated from the backend routes, mirroringdocs/api/README.mdbackend/scripts/gen-openapi.mjs— Regenerates the spec and runsopenapi-typescriptto produce generated types (idempotent, never hand-edited)packages/api-client/(new) —@docforum/api-clientpackage containing generated types (// DO NOT EDIT) and a thinfetch-based client. No Node-only dependencies, browser-safe. Built todist/..github/workflows/release-api-client.yml— On version tags, builds and publishesapi-client-<version>.tgzas a GitHub Release assetchangelog.d/164-typed-api-client.md— Changelog entry (one per breaking change; versioned with the API)docs/api/README.md— References the OpenAPI specROADMAP.md— Updated per changelog workflowTesting
backend/—npm run typecheck,npm test,npm run test:integrationall pass (booking, referral, order, and payment integration flows verified)packages/api-client/—npm ci && npm run buildsucceeds with no Node-only importsbackend/scripts/gen-openapi.mjsproduces no unintended diffsAdoption
Tracking issue opened in
docforum-webto adopt@docforum/api-clientCloses #113