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

New Issue
Closed
opened 2026-03-26 15:25:06 +00:00 by AI-Manager · 0 comments
AI-Manager commented 2026-03-26 15:25:06 +00:00
Owner
Copy Link
Copy Source

Context

The frontend manually maintains API call code and TypeScript types. When the backend API changes, the frontend types go out of sync silently. Auto-generating the client from the OpenAPI spec would eliminate this class of bugs.

Work

  • Add a script (e.g. scripts/gen-api-client.sh) that runs openapi-typescript or openapi-generator-cli against the FastAPI-generated OpenAPI spec.
  • Output the generated client to frontend/src/api/generated/.
  • Add the generation step to CI so it fails if the generated client is out of date.
  • Replace hand-written API call code in the frontend with the generated client.

Acceptance Criteria

  • Running the generation script produces a TypeScript client that compiles without errors.
  • The frontend uses the generated client for at least one API endpoint.
  • CI fails if the generated client does not match the current backend spec.
  • The generated directory is committed (not gitignored) so it is always available.

References

Roadmap: P3 — OpenAPI client generation.

## Context The frontend manually maintains API call code and TypeScript types. When the backend API changes, the frontend types go out of sync silently. Auto-generating the client from the OpenAPI spec would eliminate this class of bugs. ## Work - Add a script (e.g. `scripts/gen-api-client.sh`) that runs `openapi-typescript` or `openapi-generator-cli` against the FastAPI-generated OpenAPI spec. - Output the generated client to `frontend/src/api/generated/`. - Add the generation step to CI so it fails if the generated client is out of date. - Replace hand-written API call code in the frontend with the generated client. ## Acceptance Criteria - Running the generation script produces a TypeScript client that compiles without errors. - The frontend uses the generated client for at least one API endpoint. - CI fails if the generated client does not match the current backend spec. - The generated directory is committed (not gitignored) so it is always available. ## References Roadmap: P3 — OpenAPI client generation.
AI-Manager added the P3agent-readymedium labels 2026-03-26 15:25:06 +00:00
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 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#115
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?