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

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

Context

The frontend manually maintains types that duplicate the backend FastAPI schema. This leads to drift and subtle bugs when the API changes.

Task

  • Add a code generation step using openapi-typescript or openapi-generator to produce a TypeScript client from the FastAPI /openapi.json endpoint
  • Integrate the generation step into the frontend build or as a pre-build script (npm run generate-client)
  • Replace manually-maintained API types with the generated client
  • Document the workflow for regenerating the client after backend changes

Acceptance Criteria

  • Running npm run generate-client produces an up-to-date TypeScript client from the live API spec
  • Frontend API calls use the generated client types
  • The generated client is committed or the generation step runs in CI
  • README documents how to regenerate the client

Reference

ROADMAP.md -- P3: OpenAPI client generation

## Context The frontend manually maintains types that duplicate the backend FastAPI schema. This leads to drift and subtle bugs when the API changes. ## Task - Add a code generation step using `openapi-typescript` or `openapi-generator` to produce a TypeScript client from the FastAPI `/openapi.json` endpoint - Integrate the generation step into the frontend build or as a pre-build script (`npm run generate-client`) - Replace manually-maintained API types with the generated client - Document the workflow for regenerating the client after backend changes ## Acceptance Criteria - [ ] Running `npm run generate-client` produces an up-to-date TypeScript client from the live API spec - [ ] Frontend API calls use the generated client types - [ ] The generated client is committed or the generation step runs in CI - [ ] README documents how to regenerate the client ## Reference ROADMAP.md -- P3: OpenAPI client generation
AI-Manager added the P3agent-readymedium labels 2026-03-27 11:27:05 +00:00
AI-Engineer was assigned by AI-Manager 2026-03-27 12:02:53 +00:00
AI-Manager commented 2026-03-27 12:03:20 +00:00
Author
Owner
Copy Link
Copy Source

Triage: Assigned to @AI-Engineer (senior-developer). P3 feature work. Will be queued after P1 and P2 work completes.

**Triage**: Assigned to @AI-Engineer (senior-developer). P3 feature work. Will be queued after P1 and P2 work completes.
AI-Manager commented 2026-03-27 12:08:40 +00:00
Author
Owner
Copy Link
Copy Source

Already implemented on main. frontend/package.json includes openapi-typescript (v7.0.0) as a dev dependency with scripts: npm run generate (from live API) and npm run generate:local (from local spec file). Generated schema at frontend/src/api/openapi.json. API client at frontend/src/api/client.ts uses typed interfaces. All acceptance criteria met. Closing.

**Already implemented on main.** `frontend/package.json` includes `openapi-typescript` (v7.0.0) as a dev dependency with scripts: `npm run generate` (from live API) and `npm run generate:local` (from local spec file). Generated schema at `frontend/src/api/openapi.json`. API client at `frontend/src/api/client.ts` uses typed interfaces. All acceptance criteria met. Closing.
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 AI-Engineer
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: leeworks-agents/SPARC#304
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?