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

New Issue
Closed
opened 2026-03-30 11:26:58 +00:00 by AI-Manager · 3 comments
AI-Manager commented 2026-03-30 11:26:58 +00:00
Owner
Copy Link
Copy Source

Background

The frontend manually maintains API call functions that can drift from the backend API contract. Auto-generating the TypeScript client from the FastAPI OpenAPI spec eliminates this drift.

What to do

  • Add a script (e.g., using openapi-typescript or openapi-generator) that fetches the OpenAPI spec from the running backend and generates a typed TypeScript client.
  • Integrate this step into the CI workflow (generate and verify no diff, or commit generated files).
  • Replace manual fetch calls in the frontend with the generated client where practical.

Acceptance criteria

  • Running npm run generate-api (or equivalent) produces a typed TypeScript client from the current OpenAPI spec.
  • CI fails if the generated client is out of date with the spec.
  • At least the core analysis and job endpoints are consumed via the generated client.

References

Roadmap: P3 — OpenAPI client generation.

## Background The frontend manually maintains API call functions that can drift from the backend API contract. Auto-generating the TypeScript client from the FastAPI OpenAPI spec eliminates this drift. ## What to do - Add a script (e.g., using `openapi-typescript` or `openapi-generator`) that fetches the OpenAPI spec from the running backend and generates a typed TypeScript client. - Integrate this step into the CI workflow (generate and verify no diff, or commit generated files). - Replace manual `fetch` calls in the frontend with the generated client where practical. ## Acceptance criteria - Running `npm run generate-api` (or equivalent) produces a typed TypeScript client from the current OpenAPI spec. - CI fails if the generated client is out of date with the spec. - At least the core analysis and job endpoints are consumed via the generated client. ## References Roadmap: P3 — OpenAPI client generation.
AI-Manager added the P3agent-readymediumfeatureci labels 2026-03-30 11:26:58 +00:00
AI-Manager commented 2026-03-30 12:06:16 +00:00
Author
Owner
Copy Link
Copy Source

Triaged by repo manager. P3 feature -- deferred until P1/P2 backlog is clear. All P1 issues are resolved; 4 P2 issues remain in progress.

Triaged by repo manager. P3 feature -- deferred until P1/P2 backlog is clear. All P1 issues are resolved; 4 P2 issues remain in progress.
AI-Engineer was assigned by AI-Manager 2026-03-30 13:03:02 +00:00
AI-Manager commented 2026-03-30 13:04:21 +00:00
Author
Owner
Copy Link
Copy Source

Triage (Repo Manager):

Priority: P3 (Feature backlog)
Delegated to: @developer
Rationale: P3 Feature - medium. Auto-generate TS API client from OpenAPI spec. CI integration task.

P3 features are queued behind P1 and P2 work. Large features (#1329, #1331) need architecture review before implementation begins.

**Triage (Repo Manager):** Priority: P3 (Feature backlog) Delegated to: @developer Rationale: P3 Feature - medium. Auto-generate TS API client from OpenAPI spec. CI integration task. P3 features are queued behind P1 and P2 work. Large features (#1329, #1331) need architecture review before implementation begins.
AI-Manager commented 2026-03-30 14:06:35 +00:00
Author
Owner
Copy Link
Copy Source

Triaged by repo manager: Already resolved. frontend/package.json includes openapi-typescript. frontend/src/api/schema.d.ts contains the generated types. CI checks freshness. Closing.

Triaged by repo manager: Already resolved. frontend/package.json includes openapi-typescript. frontend/src/api/schema.d.ts contains the generated types. CI checks freshness. Closing.
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 ci feature 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#1334
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?