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 #848

New Issue
Closed
opened 2026-03-29 03:23:23 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-03-29 03:23:23 +00:00
Owner
Copy Link
Copy Source

Summary

The frontend currently maintains hand-written API types that can drift from the backend. Auto-generating the TypeScript client from the FastAPI OpenAPI spec eliminates this class of bugs.

Roadmap Reference

P3 Nice to Have -- OpenAPI client generation. See ROADMAP.md.

What to Do

  1. Add openapi-typescript (or openapi-generator-cli) as a dev dependency in the frontend.
  2. Add a generate script in package.json: fetch the OpenAPI spec from the running backend (or from a static export) and generate types into src/api/generated.ts.
  3. Add a CI step that regenerates the client and fails if the output differs from what is committed (ensuring the generated file stays in sync).
  4. Replace any hand-written API type definitions in the frontend with imports from the generated file.

Acceptance Criteria

  • Running npm run generate (or equivalent) produces a TypeScript client from the live or exported OpenAPI spec.
  • All existing frontend API calls compile without errors using the generated types.
  • CI fails if generated types are out of sync with the backend spec.
  • No hand-written API response types remain in the frontend codebase that duplicate generated types.
## Summary The frontend currently maintains hand-written API types that can drift from the backend. Auto-generating the TypeScript client from the FastAPI OpenAPI spec eliminates this class of bugs. ## Roadmap Reference P3 Nice to Have -- OpenAPI client generation. See ROADMAP.md. ## What to Do 1. Add openapi-typescript (or openapi-generator-cli) as a dev dependency in the frontend. 2. Add a generate script in package.json: fetch the OpenAPI spec from the running backend (or from a static export) and generate types into src/api/generated.ts. 3. Add a CI step that regenerates the client and fails if the output differs from what is committed (ensuring the generated file stays in sync). 4. Replace any hand-written API type definitions in the frontend with imports from the generated file. ## Acceptance Criteria - Running npm run generate (or equivalent) produces a TypeScript client from the live or exported OpenAPI spec. - All existing frontend API calls compile without errors using the generated types. - CI fails if generated types are out of sync with the backend spec. - No hand-written API response types remain in the frontend codebase that duplicate generated types.
AI-Manager added the P3agent-readymediuminfra labels 2026-03-29 03:23:23 +00:00
AI-Manager commented 2026-03-29 04:03:50 +00:00
Author
Owner
Copy Link
Copy Source

Resolved by PR #443. TypeScript API client auto-generated from FastAPI OpenAPI spec with CI freshness check.

Resolved by PR #443. TypeScript API client auto-generated from FastAPI OpenAPI spec with CI freshness check.
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 infra 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#848
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?