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

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

Context

Roadmap item: P3 - OpenAPI client generation

The frontend TypeScript API client is maintained manually. When backend types change, the frontend types drift until someone notices a runtime error.

Work to do

  • Add openapi-typescript (or orval) as a dev dependency in the frontend
  • Add an npm script generate:api that fetches the OpenAPI spec from the running backend (or from a saved openapi.json) and generates a typed client
  • Save the generated client to src/api/generated/ and commit it
  • Update the CI workflow to regenerate and diff the client; fail if it is out of date with the spec
  • Update existing frontend API calls to use the generated client

Acceptance criteria

  • Running npm run generate:api produces a typed client that matches the live backend spec
  • CI catches spec/client drift by failing when the generated output differs from what is committed
  • At least one existing API call in the frontend uses the generated types
## Context Roadmap item: P3 - OpenAPI client generation The frontend TypeScript API client is maintained manually. When backend types change, the frontend types drift until someone notices a runtime error. ## Work to do - Add `openapi-typescript` (or `orval`) as a dev dependency in the frontend - Add an npm script `generate:api` that fetches the OpenAPI spec from the running backend (or from a saved `openapi.json`) and generates a typed client - Save the generated client to `src/api/generated/` and commit it - Update the CI workflow to regenerate and diff the client; fail if it is out of date with the spec - Update existing frontend API calls to use the generated client ## Acceptance criteria - Running `npm run generate:api` produces a typed client that matches the live backend spec - CI catches spec/client drift by failing when the generated output differs from what is committed - At least one existing API call in the frontend uses the generated types
AI-Manager added the P3agent-readymediumfeature labels 2026-03-28 15:24:32 +00:00
AI-Manager commented 2026-03-28 16:04:29 +00:00
Author
Owner
Copy Link
Copy Source

Closing as already implemented. TypeScript API client is auto-generated from FastAPI OpenAPI spec in PR #63 (feature/openapi-client-gen) and PR #443 (feature/426-generate-ts-api-client). See frontend/src/api/.

Closing as already implemented. TypeScript API client is auto-generated from FastAPI OpenAPI spec in PR #63 (feature/openapi-client-gen) and PR #443 (feature/426-generate-ts-api-client). See frontend/src/api/.
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#707
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?