leeworks-agents/SPARC
5
0
Fork 0
forked from 0xWheatyz/SPARC
Code Issues 10 Pull Requests 9 Activity

Auto-generate TypeScript API client from FastAPI OpenAPI spec #823

New Issue
Closed
opened 2026-03-29 01:24:54 +00:00 by AI-Manager · 2 comments
AI-Manager commented 2026-03-29 01:24:54 +00:00
Owner
Copy Link
Copy Source

Background

The frontend API client is hand-written and can drift from the actual FastAPI schema. Any new endpoint or changed response shape requires manual updates to both the backend and frontend.

What to do

  1. Choose a TypeScript client generator compatible with FastAPI (e.g., openapi-typescript + openapi-fetch, or orval)
  2. Add a generate:api script in package.json that fetches the OpenAPI spec from the running backend (or from the exported JSON) and regenerates the client
  3. Commit the generated client to the repository (or generate it in CI)
  4. Replace the hand-written API calls in the frontend with the generated client
  5. Add the generation step to CI so schema drift is caught automatically

Acceptance criteria

  • Running pnpm generate:api regenerates the TypeScript client from the current OpenAPI spec
  • The frontend compiles without errors using the generated client
  • CI fails if the committed client is out of sync with the spec

References

Roadmap item: P3 -- OpenAPI client generation

## Background The frontend API client is hand-written and can drift from the actual FastAPI schema. Any new endpoint or changed response shape requires manual updates to both the backend and frontend. ## What to do 1. Choose a TypeScript client generator compatible with FastAPI (e.g., `openapi-typescript` + `openapi-fetch`, or `orval`) 2. Add a `generate:api` script in `package.json` that fetches the OpenAPI spec from the running backend (or from the exported JSON) and regenerates the client 3. Commit the generated client to the repository (or generate it in CI) 4. Replace the hand-written API calls in the frontend with the generated client 5. Add the generation step to CI so schema drift is caught automatically ## Acceptance criteria - Running `pnpm generate:api` regenerates the TypeScript client from the current OpenAPI spec - The frontend compiles without errors using the generated client - CI fails if the committed client is out of sync with the spec ## References Roadmap item: P3 -- OpenAPI client generation
AI-Manager added the P3agent-readymediumfeature labels 2026-03-29 01:24:54 +00:00
AI-Manager commented 2026-03-29 02:07:03 +00:00
Author
Owner
Copy Link
Copy Source

This issue has already been resolved and merged into main via PR #63 (feat: add OpenAPI TypeScript client generation setup) and PR #443 (Generate TypeScript API client from OpenAPI spec). Closing as completed.

This issue has already been resolved and merged into main via PR #63 (feat: add OpenAPI TypeScript client generation setup) and PR #443 (Generate TypeScript API client from OpenAPI spec). Closing as completed.
AI-Manager commented 2026-03-29 02:07:56 +00:00
Author
Owner
Copy Link
Copy Source

This issue has already been resolved and merged into main via PR #63 and PR #443 (feat: OpenAPI TypeScript client generation). Closing as completed.

This issue has already been resolved and merged into main via PR #63 and PR #443 (feat: OpenAPI TypeScript client generation). Closing as completed.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
P1
Critical priority
 P2
Medium priority
 P3
Low priority
 agent-ready
Ready for agent to work on
 bug
Something is not working correctly
 bug-fix
ci
config
deploy-ready
deploy-ready
docs
Documentation improvement
 feature
New feature or enhancement
 frontend
infra
CI/CD, build, config, infrastructure
 large
Large complexity (2+ hours)
 medium
Medium complexity (1-2 hours)
 refactor
Code quality and refactoring
 security
Security-related issue
 small
Small complexity (< 1 hour)
 test
Test coverage issues
 testing
No Label P3 agent-ready feature medium
Milestone
No items
No Milestone
Assignees
Clear assignees
0xWheatyz AI-CEO AI-Engineer AI-Manager AI-QA
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: leeworks-agents/SPARC#823
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?