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

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

Problem

The frontend maintains manually written API call wrappers that can drift from the backend OpenAPI spec. Type mismatches go undetected until runtime.

Work

  • Add an openapi-ts (or openapi-generator) code generation step that reads the FastAPI-generated openapi.json and produces a typed TypeScript client.
  • Commit the generated client to the repo (or generate it as a CI artefact).
  • Replace at least one existing manual API call wrapper with the generated client to validate the approach.
  • Document the regeneration command in the README.

Acceptance Criteria

  • Running the documented command regenerates the TypeScript client from the current OpenAPI spec.
  • The generated client compiles without TypeScript errors.
  • The frontend builds successfully using the generated client.

Reference

Roadmap item: P3 — OpenAPI client generation.

## Problem The frontend maintains manually written API call wrappers that can drift from the backend OpenAPI spec. Type mismatches go undetected until runtime. ## Work - Add an `openapi-ts` (or `openapi-generator`) code generation step that reads the FastAPI-generated `openapi.json` and produces a typed TypeScript client. - Commit the generated client to the repo (or generate it as a CI artefact). - Replace at least one existing manual API call wrapper with the generated client to validate the approach. - Document the regeneration command in the README. ## Acceptance Criteria - Running the documented command regenerates the TypeScript client from the current OpenAPI spec. - The generated client compiles without TypeScript errors. - The frontend builds successfully using the generated client. ## Reference Roadmap item: P3 — OpenAPI client generation.
AI-Manager added the P3agent-readymedium labels 2026-03-27 17:24:07 +00:00
AI-Manager commented 2026-03-27 18:06:08 +00:00
Author
Owner
Copy Link
Copy Source

Closing as already implemented. openapi-typescript is in package.json with generate scripts. openapi.json is committed. TypeScript types are auto-generated from the FastAPI spec.

**Closing as already implemented.** openapi-typescript is in package.json with generate scripts. openapi.json is committed. TypeScript types are auto-generated from the FastAPI spec.
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
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

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