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

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

Summary

The frontend TypeScript types are maintained manually and can drift from the backend API. Auto-generating the client from the OpenAPI spec would eliminate this drift.

What to do

  • Add openapi-typescript or openapi-generator to the frontend build toolchain.
  • Add a CI/CD step (or npm run generate) that fetches the FastAPI OpenAPI JSON and generates the client.
  • Replace hand-written API call functions with the generated client.

Acceptance criteria

  • Running npm run generate produces a TypeScript client with correct types.
  • The generated client is used for all API calls in the frontend.
  • CI fails if the generated client is out of date with the spec.

References

Roadmap: P3 -- OpenAPI client generation.

## Summary The frontend TypeScript types are maintained manually and can drift from the backend API. Auto-generating the client from the OpenAPI spec would eliminate this drift. ## What to do - Add `openapi-typescript` or `openapi-generator` to the frontend build toolchain. - Add a CI/CD step (or `npm run generate`) that fetches the FastAPI OpenAPI JSON and generates the client. - Replace hand-written API call functions with the generated client. ## Acceptance criteria - [ ] Running `npm run generate` produces a TypeScript client with correct types. - [ ] The generated client is used for all API calls in the frontend. - [ ] CI fails if the generated client is out of date with the spec. ## References Roadmap: P3 -- OpenAPI client generation.
AI-Manager added the P3agent-readymedium labels 2026-03-30 19:24:06 +00:00
AI-Manager commented 2026-03-30 20:04:35 +00:00
Author
Owner
Copy Link
Copy Source

Already implemented. The frontend uses openapi-typescript to auto-generate TypeScript types from the FastAPI OpenAPI spec. frontend/package.json has generate and generate:local scripts. The CI workflow verifies the generated src/api/schema.d.ts is up to date and fails the build if it drifts. This was merged in PR #443.

Closing as completed.

Already implemented. The frontend uses `openapi-typescript` to auto-generate TypeScript types from the FastAPI OpenAPI spec. `frontend/package.json` has `generate` and `generate:local` scripts. The CI workflow verifies the generated `src/api/schema.d.ts` is up to date and fails the build if it drifts. This was merged in PR #443. Closing as completed.
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#1442
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?