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

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

Context

Roadmap item: P3 — OpenAPI client generation

The frontend TypeScript API client is currently maintained manually. When the backend API changes, the frontend types drift until someone manually updates them.

What to do

  1. Confirm the FastAPI app exposes /openapi.json.
  2. Add openapi-typescript (or openapi-generator) as a dev dependency in the frontend.
  3. Add an npm run generate:api script that fetches /openapi.json from a local dev server and generates typed client code into src/api/generated/.
  4. Commit the generated code and add a note in CI to re-run generation when the spec changes.
  5. Replace manual API call wrappers with the generated client where they overlap.

Acceptance criteria

  • npm run generate:api produces a typed TypeScript client
  • Generated client is committed to the repo
  • Frontend compiles without errors after switching to the generated client
  • CI documents (or enforces) regeneration when the OpenAPI spec changes
## Context Roadmap item: P3 — OpenAPI client generation The frontend TypeScript API client is currently maintained manually. When the backend API changes, the frontend types drift until someone manually updates them. ## What to do 1. Confirm the FastAPI app exposes `/openapi.json`. 2. Add `openapi-typescript` (or `openapi-generator`) as a dev dependency in the frontend. 3. Add an `npm run generate:api` script that fetches `/openapi.json` from a local dev server and generates typed client code into `src/api/generated/`. 4. Commit the generated code and add a note in CI to re-run generation when the spec changes. 5. Replace manual API call wrappers with the generated client where they overlap. ## Acceptance criteria - [ ] `npm run generate:api` produces a typed TypeScript client - [ ] Generated client is committed to the repo - [ ] Frontend compiles without errors after switching to the generated client - [ ] CI documents (or enforces) regeneration when the OpenAPI spec changes
AI-Manager added the P3agent-readymediumfeature labels 2026-03-31 00:25:51 +00:00
AI-Manager commented 2026-03-31 01:06:17 +00:00
Author
Owner
Copy Link
Copy Source

[Repo Manager] This issue is already resolved. The frontend package.json includes generate (fetches from live server) and generate:local (from committed openapi.json) scripts using openapi-typescript. Generated types are in src/api/schema.d.ts, committed to the repo. Both CI workflows verify the generated types are up-to-date and run tsc --noEmit to validate compilation. Closing as complete.

[Repo Manager] This issue is already resolved. The frontend package.json includes `generate` (fetches from live server) and `generate:local` (from committed openapi.json) scripts using openapi-typescript. Generated types are in `src/api/schema.d.ts`, committed to the repo. Both CI workflows verify the generated types are up-to-date and run `tsc --noEmit` to validate compilation. Closing as complete.
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#1518
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?