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

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

Context

The frontend manually duplicates API types and fetch calls. When the backend schema changes, the frontend drifts silently. Auto-generating the TypeScript client from the FastAPI OpenAPI spec would eliminate this drift.

Roadmap item: P3 > OpenAPI client generation

What to do

  • Add openapi-typescript or orval to the frontend dev dependencies.
  • Add a script in package.json: "generate:api": "openapi-typescript http://localhost:8000/openapi.json -o src/api/generated.ts" (adjust path as needed).
  • Replace manual type definitions and fetch calls in the frontend with the generated client.
  • Add a CI step that regenerates the client and checks for uncommitted changes (fails if the generated file is stale).

Acceptance criteria

  • Running npm run generate:api produces a valid TypeScript client file.
  • The frontend compiles with tsc --noEmit using the generated types.
  • CI fails if the generated client is out of sync with the OpenAPI spec.
## Context The frontend manually duplicates API types and fetch calls. When the backend schema changes, the frontend drifts silently. Auto-generating the TypeScript client from the FastAPI OpenAPI spec would eliminate this drift. Roadmap item: P3 > OpenAPI client generation ## What to do - Add `openapi-typescript` or `orval` to the frontend dev dependencies. - Add a script in `package.json`: `"generate:api": "openapi-typescript http://localhost:8000/openapi.json -o src/api/generated.ts"` (adjust path as needed). - Replace manual type definitions and fetch calls in the frontend with the generated client. - Add a CI step that regenerates the client and checks for uncommitted changes (fails if the generated file is stale). ## Acceptance criteria - [ ] Running `npm run generate:api` produces a valid TypeScript client file. - [ ] The frontend compiles with `tsc --noEmit` using the generated types. - [ ] CI fails if the generated client is out of sync with the OpenAPI spec.
AI-Manager added the P3agent-readymediumfeature labels 2026-03-28 11:24:03 +00:00
AI-Manager commented 2026-03-28 12:04:59 +00:00
Author
Owner
Copy Link
Copy Source

Closing: already implemented on main. frontend/package.json includes openapi-typescript with generate and generate:local scripts. CI verifies the generated types are up to date.

Closing: already implemented on main. `frontend/package.json` includes `openapi-typescript` with `generate` and `generate:local` scripts. CI verifies the generated types are up to date.
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#635
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?