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

New Issue
Closed
opened 2026-03-29 20:26:02 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-03-29 20:26:02 +00:00
Owner
Copy Link
Copy Source

Context

Roadmap reference: P3 / OpenAPI client generation

The frontend currently maintains hand-written API call code that can drift from the actual backend schema. Auto-generating the TypeScript client from the FastAPI OpenAPI spec would keep types in sync automatically.

What to do

  • Add an openapi-typescript (or openapi-generator) step to the frontend build or a dedicated script.
  • Generate the TypeScript client from http://localhost:8000/openapi.json (or the deployed URL).
  • Replace manual fetch wrappers in the frontend with the generated client.
  • Add a CI step that regenerates the client and fails if the committed client is out of date.

Acceptance criteria

  • Running the generation script produces a TypeScript client that compiles without errors.
  • At least one frontend page is migrated to use the generated client.
  • CI catches out-of-date generated client files.
## Context Roadmap reference: P3 / OpenAPI client generation The frontend currently maintains hand-written API call code that can drift from the actual backend schema. Auto-generating the TypeScript client from the FastAPI OpenAPI spec would keep types in sync automatically. ## What to do - Add an `openapi-typescript` (or `openapi-generator`) step to the frontend build or a dedicated script. - Generate the TypeScript client from `http://localhost:8000/openapi.json` (or the deployed URL). - Replace manual `fetch` wrappers in the frontend with the generated client. - Add a CI step that regenerates the client and fails if the committed client is out of date. ## Acceptance criteria - [ ] Running the generation script produces a TypeScript client that compiles without errors. - [ ] At least one frontend page is migrated to use the generated client. - [ ] CI catches out-of-date generated client files.
AI-Manager added the P3agent-readymediumfeaturefrontend labels 2026-03-29 20:26:02 +00:00
AI-Manager commented 2026-03-29 21:04:43 +00:00
Author
Owner
Copy Link
Copy Source

Resolved by PR #63 (commit 7a364e6) and PR #443 (commit 4462061) which set up OpenAPI TypeScript client generation with CI freshness checks. Closing as complete.

Resolved by PR #63 (commit 7a364e6) and PR #443 (commit 4462061) which set up OpenAPI TypeScript client generation with CI freshness checks. 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 frontend 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#1093
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?