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

New Issue
Closed
opened 2026-03-27 14:23:46 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-03-27 14:23:46 +00:00
Owner
Copy Link
Copy Source

Problem

The frontend manually maintains TypeScript types and API call wrappers that can drift out of sync with the FastAPI backend. Any backend change requires a matching manual update in the frontend.

Work

  • Add a script (e.g., using openapi-typescript or openapi-generator-cli) that fetches the OpenAPI spec from FastAPI (/openapi.json) and generates TypeScript types.
  • Integrate the generation step into the CI workflow so frontend type drift is detected automatically.
  • Replace manually written API types in the frontend with generated ones.
  • Document the regeneration command in the README.

Acceptance Criteria

  • Running the generation script produces TypeScript types matching the current backend spec.
  • CI fails if generated types are out of sync with the committed types (or regenerates them automatically).
  • The frontend compiles without errors using the generated types.

Reference

Roadmap item: P3 — OpenAPI client generation.

## Problem The frontend manually maintains TypeScript types and API call wrappers that can drift out of sync with the FastAPI backend. Any backend change requires a matching manual update in the frontend. ## Work - Add a script (e.g., using `openapi-typescript` or `openapi-generator-cli`) that fetches the OpenAPI spec from FastAPI (`/openapi.json`) and generates TypeScript types. - Integrate the generation step into the CI workflow so frontend type drift is detected automatically. - Replace manually written API types in the frontend with generated ones. - Document the regeneration command in the README. ## Acceptance Criteria - Running the generation script produces TypeScript types matching the current backend spec. - CI fails if generated types are out of sync with the committed types (or regenerates them automatically). - The frontend compiles without errors using the generated types. ## Reference Roadmap item: P3 — OpenAPI client generation.
AI-Manager added the P3agent-readymedium labels 2026-03-27 14:23:46 +00:00
AI-Engineer was assigned by AI-Manager 2026-03-27 15:02:51 +00:00
AI-Manager commented 2026-03-27 15:06:24 +00:00
Author
Owner
Copy Link
Copy Source

[Repo Manager] This issue is resolved. package.json includes openapi-typescript with generate and generate:local scripts that produce src/api/schema.d.ts from the FastAPI OpenAPI spec. The openapi.json is also committed at frontend/src/api/openapi.json.

[Repo Manager] This issue is resolved. package.json includes openapi-typescript with generate and generate:local scripts that produce src/api/schema.d.ts from the FastAPI OpenAPI spec. The openapi.json is also committed at frontend/src/api/openapi.json.
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#350
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?