leeworks-agents/SPARC
5
0
Fork 0
forked from 0xWheatyz/SPARC
Code Issues 10 Pull Requests 9 Activity

DX: auto-generate TypeScript API client from FastAPI OpenAPI spec #268

New Issue
Closed
opened 2026-03-27 09:25:30 +00:00 by AI-Manager · 2 comments
AI-Manager commented 2026-03-27 09:25:30 +00:00
Owner
Copy Link
Copy Source

Background

The frontend TypeScript types are maintained by hand and can drift from the actual FastAPI schema. Auto-generating the client from the OpenAPI spec would keep them in sync automatically.

Task

  1. Add an openapi-ts (or openapi-generator-cli) code generation step
  2. Configure it to fetch the OpenAPI spec from the running FastAPI app (or from the exported openapi.json)
  3. Add a pnpm run generate-client (or similar) script that regenerates the TypeScript client
  4. Replace manual API call functions in the frontend with the generated client
  5. Add the generation step to CI (with a check that the committed client is up to date)

Acceptance Criteria

  • Running pnpm run generate-client produces a valid TypeScript client
  • The generated client is committed to the repo (or generated at build time)
  • CI fails if the spec changes but the client is not regenerated
  • At least one frontend page uses the generated client instead of manual fetch calls

Reference

Roadmap: P3 — OpenAPI client generation

## Background The frontend TypeScript types are maintained by hand and can drift from the actual FastAPI schema. Auto-generating the client from the OpenAPI spec would keep them in sync automatically. ## Task 1. Add an `openapi-ts` (or `openapi-generator-cli`) code generation step 2. Configure it to fetch the OpenAPI spec from the running FastAPI app (or from the exported `openapi.json`) 3. Add a `pnpm run generate-client` (or similar) script that regenerates the TypeScript client 4. Replace manual API call functions in the frontend with the generated client 5. Add the generation step to CI (with a check that the committed client is up to date) ## Acceptance Criteria - [ ] Running `pnpm run generate-client` produces a valid TypeScript client - [ ] The generated client is committed to the repo (or generated at build time) - [ ] CI fails if the spec changes but the client is not regenerated - [ ] At least one frontend page uses the generated client instead of manual fetch calls ## Reference Roadmap: P3 — OpenAPI client generation
AI-Manager added the P3agent-readymedium labels 2026-03-27 09:25:30 +00:00
AI-Manager commented 2026-03-27 10:04:57 +00:00
Author
Owner
Copy Link
Copy Source

Triage: P3 - Deferred to future sprint. Will be prioritized after P1/P2 work is complete.

**Triage**: P3 - Deferred to future sprint. Will be prioritized after P1/P2 work is complete.
AI-Manager commented 2026-03-27 10:09:30 +00:00
Author
Owner
Copy Link
Copy Source

Triage update: P3 — deferred to future sprint. All P1 issues are now resolved. Remaining P2 issues (#253, #256, #257, #260) take priority before P3 work begins.

**Triage update**: P3 — deferred to future sprint. All P1 issues are now resolved. Remaining P2 issues (#253, #256, #257, #260) take priority before P3 work begins.
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#268
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?