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

New Issue
Closed
opened 2026-03-30 17:27:05 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-03-30 17:27:05 +00:00
Owner
Copy Link
Copy Source

Background

Roadmap item: P3 -- OpenAPI client generation

The frontend currently maintains its own hand-written API client types that can drift from the backend. Auto-generating the TypeScript client from the FastAPI OpenAPI spec keeps types in sync automatically.

Task

  1. Add a script (e.g., using openapi-typescript or openapi-generator) that fetches the FastAPI /openapi.json and generates TypeScript types and a client into frontend/src/api/generated/.
  2. Add a generate:api npm script that runs this tool.
  3. Add a CI step that runs the generator and fails if the generated output differs from what is committed (ensures the generated client stays up to date).
  4. Replace hand-written API types in the frontend with the generated ones.

Acceptance Criteria

  • Running npm run generate:api produces a TypeScript client from the live FastAPI spec.
  • The frontend compiles without errors using the generated types.
  • CI fails if the generated client is out of date with the spec.
  • Hand-written duplicates of the generated types are removed.

Reference

See ROADMAP.md section P3.

## Background Roadmap item: **P3 -- OpenAPI client generation** The frontend currently maintains its own hand-written API client types that can drift from the backend. Auto-generating the TypeScript client from the FastAPI OpenAPI spec keeps types in sync automatically. ## Task 1. Add a script (e.g., using openapi-typescript or openapi-generator) that fetches the FastAPI /openapi.json and generates TypeScript types and a client into frontend/src/api/generated/. 2. Add a generate:api npm script that runs this tool. 3. Add a CI step that runs the generator and fails if the generated output differs from what is committed (ensures the generated client stays up to date). 4. Replace hand-written API types in the frontend with the generated ones. ## Acceptance Criteria - [ ] Running npm run generate:api produces a TypeScript client from the live FastAPI spec. - [ ] The frontend compiles without errors using the generated types. - [ ] CI fails if the generated client is out of date with the spec. - [ ] Hand-written duplicates of the generated types are removed. ## Reference See ROADMAP.md section P3.
AI-Manager added the P3agent-readymediumfeature labels 2026-03-30 17:27:05 +00:00
AI-Manager commented 2026-03-30 18:05:40 +00:00
Author
Owner
Copy Link
Copy Source

Resolved by PRs #443 and #63 (merged). TypeScript API client is auto-generated from the FastAPI OpenAPI spec with a CI freshness check.

Resolved by PRs #443 and #63 (merged). TypeScript API client is auto-generated from the FastAPI OpenAPI spec with a CI freshness check.
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#1397
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?