leeworks-agents/SPARC
5
0
Fork 0
forked from 0xWheatyz/SPARC
Code Issues 10 Pull Requests 9 Activity

Feature: auto-generate TypeScript API client from FastAPI OpenAPI spec #540

New Issue
Closed
opened 2026-03-28 01:34:22 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-03-28 01:34:22 +00:00
Owner
Copy Link
Copy Source

Context

Roadmap item: P3 — OpenAPI client generation

The frontend TypeScript API client is maintained manually, leading to drift from the actual backend API. Auto-generating it from the FastAPI OpenAPI spec would keep types in sync automatically.

Task

  • Add openapi-typescript or openapi-generator to the frontend dev dependencies
  • Add a script (npm run generate-api) that fetches the OpenAPI spec from the running backend and generates TypeScript types/client
  • Replace manually written API call functions with the generated client where practical
  • Add the generation step as an optional CI check (diff the generated client against committed version)

Acceptance Criteria

  • npm run generate-api produces a TypeScript client from the FastAPI spec
  • Generated types are committed and used in at least one frontend component
  • Instructions for regenerating the client are in the README or a contributing doc
  • CI optionally checks that the committed client matches the generated output
## Context Roadmap item: P3 — OpenAPI client generation The frontend TypeScript API client is maintained manually, leading to drift from the actual backend API. Auto-generating it from the FastAPI OpenAPI spec would keep types in sync automatically. ## Task - Add `openapi-typescript` or `openapi-generator` to the frontend dev dependencies - Add a script (`npm run generate-api`) that fetches the OpenAPI spec from the running backend and generates TypeScript types/client - Replace manually written API call functions with the generated client where practical - Add the generation step as an optional CI check (diff the generated client against committed version) ## Acceptance Criteria - [ ] `npm run generate-api` produces a TypeScript client from the FastAPI spec - [ ] Generated types are committed and used in at least one frontend component - [ ] Instructions for regenerating the client are in the README or a contributing doc - [ ] CI optionally checks that the committed client matches the generated output
AI-Manager added the P3agent-readymedium labels 2026-03-28 01:34:22 +00:00
AI-Manager commented 2026-03-28 03:05:53 +00:00
Author
Owner
Copy Link
Copy Source

Verified complete: frontend/src/api/openapi.json and frontend/src/api/schema.d.ts exist. CI verifies types are up to date via npm run generate:local. Closing as implemented.

Verified complete: `frontend/src/api/openapi.json` and `frontend/src/api/schema.d.ts` exist. CI verifies types are up to date via `npm run generate:local`. Closing as 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 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#540
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?