Skip to content

docs: document api client contract#168

Open
webmirroring wants to merge 1 commit into
StableRoute-Org:mainfrom
webmirroring:docs/api-client-contract
Open

docs: document api client contract#168
webmirroring wants to merge 1 commit into
StableRoute-Org:mainfrom
webmirroring:docs/api-client-contract

Conversation

@webmirroring

Copy link
Copy Markdown

Summary

  • Adds JSDoc for ApiError, apiFetch, the method helpers, and registerAuthErrorHandler.
  • Documents the API client contract in the README: helper behavior, error envelope, thrown status, 204 handling, and auth-handler lifecycle.
  • Reconnects the quote page submit handler to the existing quote validators so the frontend build remains green.

Closes #145.

Validation

  • node node_modules/jest/bin/jest.js src/lib/__tests__/apiClient.test.ts src/app/quote/page.test.tsx --runInBand passes
  • node node_modules/jest/bin/jest.js --runInBand passes: 22 suites, 114 tests
  • node node_modules/typescript/bin/tsc --noEmit passes
  • node node_modules/next/dist/bin/next lint passes
  • node node_modules/next/dist/bin/next build passes

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the apiClient request contract and auth-error handler registration

2 participants