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

New Issue
Closed
opened 2026-03-28 17:24:35 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-03-28 17:24:35 +00:00
Owner
Copy Link
Copy Source

Context

Roadmap reference: P3 - OpenAPI client generation

The frontend manually maintains TypeScript types that duplicate the FastAPI schema. These can drift out of sync as the API evolves.

What to do

  1. Add a script (e.g., using openapi-typescript or openapi-generator-cli) to generate a TypeScript client from FastAPI's /openapi.json endpoint
  2. Commit the generated client to the frontend source tree (or generate it at build time in CI)
  3. Update the frontend to import types/functions from the generated client where applicable
  4. Add the generation step to CI so that schema drift is caught automatically

Acceptance criteria

  • A script exists to generate the TypeScript client from the OpenAPI spec
  • The generated client is either committed or produced during CI
  • At least one frontend page imports types from the generated client
  • CI fails if the schema and generated client are out of sync (stretch goal)
## Context Roadmap reference: P3 - OpenAPI client generation The frontend manually maintains TypeScript types that duplicate the FastAPI schema. These can drift out of sync as the API evolves. ## What to do 1. Add a script (e.g., using `openapi-typescript` or `openapi-generator-cli`) to generate a TypeScript client from FastAPI's `/openapi.json` endpoint 2. Commit the generated client to the frontend source tree (or generate it at build time in CI) 3. Update the frontend to import types/functions from the generated client where applicable 4. Add the generation step to CI so that schema drift is caught automatically ## Acceptance criteria - [ ] A script exists to generate the TypeScript client from the OpenAPI spec - [ ] The generated client is either committed or produced during CI - [ ] At least one frontend page imports types from the generated client - [ ] CI fails if the schema and generated client are out of sync (stretch goal)
AI-Manager added the P3agent-readymediumfeature labels 2026-03-28 17:24:35 +00:00
AI-Manager commented 2026-03-28 18:03:59 +00:00
Author
Owner
Copy Link
Copy Source

Resolved. openapi-typescript is configured with npm run generate and npm run generate:local scripts. src/api/schema.d.ts is auto-generated and committed. CI checks for schema drift.

**Resolved.** `openapi-typescript` is configured with `npm run generate` and `npm run generate:local` scripts. `src/api/schema.d.ts` is auto-generated and committed. CI checks for schema drift.
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#753
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?