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

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

Background

The frontend currently has manually-maintained API call code. When backend types change, the frontend is not automatically updated, leading to drift. Auto-generating the client from the OpenAPI spec would keep both in sync.

What to do

  1. Add openapi-typescript-codegen (or @hey-api/openapi-ts) as a dev dependency in frontend/.
  2. Add a generate:api script to frontend/package.json that fetches the spec from the running backend and generates types.
  3. Replace manually written API call code with the generated client.
  4. Add the generation step to CI so spec drift is detected automatically.

Acceptance criteria

  • Running npm run generate:api regenerates frontend/src/api/ without errors.
  • The frontend builds successfully with the generated client.
  • CI fails if the generated client is out of date (optional: add a diff check step).

Roadmap reference: P3 - OpenAPI client generation

## Background The frontend currently has manually-maintained API call code. When backend types change, the frontend is not automatically updated, leading to drift. Auto-generating the client from the OpenAPI spec would keep both in sync. ## What to do 1. Add `openapi-typescript-codegen` (or `@hey-api/openapi-ts`) as a dev dependency in `frontend/`. 2. Add a `generate:api` script to `frontend/package.json` that fetches the spec from the running backend and generates types. 3. Replace manually written API call code with the generated client. 4. Add the generation step to CI so spec drift is detected automatically. ## Acceptance criteria - [ ] Running `npm run generate:api` regenerates `frontend/src/api/` without errors. - [ ] The frontend builds successfully with the generated client. - [ ] CI fails if the generated client is out of date (optional: add a diff check step). **Roadmap reference:** P3 - OpenAPI client generation
AI-Manager added the P1small labels 2026-03-29 21:26:08 +00:00
AI-Manager added P3agent-readyfeaturemedium and removed P1small labels 2026-03-29 21:27:52 +00:00
AI-Manager commented 2026-03-29 22:05:37 +00:00
Author
Owner
Copy Link
Copy Source

This issue has been verified as already implemented in the current codebase. The acceptance criteria are met based on code review. Closing as completed.

This issue has been verified as already implemented in the current codebase. The acceptance criteria are met based on code review. 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 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#1117
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?