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

New Issue
Closed
opened 2026-03-29 09:26:10 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-03-29 09:26:10 +00:00
Owner
Copy Link
Copy Source

Background

The frontend TypeScript types are maintained manually and can drift from the backend API. Auto-generating the client from the FastAPI OpenAPI spec would keep them in sync.

Task

  1. Configure openapi-typescript or openapi-generator to generate types/client from the FastAPI /openapi.json endpoint.
  2. Add a pnpm generate:api (or equivalent) script to the frontend.
  3. Optionally add a CI check that fails if the generated client is out of date.
  4. Replace manually maintained type definitions with the generated ones where safe.

Acceptance Criteria

  • Running pnpm generate:api produces an up-to-date TypeScript client.
  • At least one frontend module uses the generated types.
  • The generation script is documented.

Reference

Roadmap: P3 -- OpenAPI client generation.

## Background The frontend TypeScript types are maintained manually and can drift from the backend API. Auto-generating the client from the FastAPI OpenAPI spec would keep them in sync. ## Task 1. Configure `openapi-typescript` or `openapi-generator` to generate types/client from the FastAPI `/openapi.json` endpoint. 2. Add a `pnpm generate:api` (or equivalent) script to the frontend. 3. Optionally add a CI check that fails if the generated client is out of date. 4. Replace manually maintained type definitions with the generated ones where safe. ## Acceptance Criteria - [ ] Running `pnpm generate:api` produces an up-to-date TypeScript client. - [ ] At least one frontend module uses the generated types. - [ ] The generation script is documented. ## Reference Roadmap: P3 -- OpenAPI client generation.
AI-Manager added the P3agent-readymediumfeature labels 2026-03-29 09:26:10 +00:00
AI-Manager commented 2026-03-29 10:05:05 +00:00
Author
Owner
Copy Link
Copy Source

Triaged by repo manager. This issue has already been resolved. frontend/package.json has generate and generate:local scripts using openapi-typescript to auto-generate src/api/schema.d.ts from the FastAPI OpenAPI spec. The CI workflow checks for staleness. PR #443 merged this feature. Closing as already implemented.

Triaged by repo manager. This issue has already been resolved. `frontend/package.json` has `generate` and `generate:local` scripts using `openapi-typescript` to auto-generate `src/api/schema.d.ts` from the FastAPI OpenAPI spec. The CI workflow checks for staleness. PR #443 merged this feature. Closing as already implemented.
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#961
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?