This repository was archived by the owner on May 13, 2026. It is now read-only.
refactor(api): migrate clean-shape ingestion types to openapi.ts source-of-truth - #793
Merged
Merged
Conversation
…ce-of-truth Phase 4a of gbrain projects/api-typegen-unification. Replaces hand-written TypeScript interfaces in `ingestionClient.ts` with type aliases over `components["schemas"][...]` from `openapi.ts` for the six types where the hand-written shape matches the OpenAPI spec exactly: - `Role` (literal union of 7 strings) - `VisionBackend` (literal union) - `OllamaGenerationParams` (8 number fields, identical layout) - `OllamaConfig` (model/base_url/vision_model?/ocr_model?/generation_params?) - `AnthropicConfig` (api_key/model/base_url) - `IngestionStatus` (enabled/configured/provider/model/auto_execute_mutations) The drift check shipped in #790 now mechanically prevents these from desyncing — a backend change to any of the underlying Rust structs forces a regenerated `openapi.ts`, which immediately propagates to every consumer of the alias. Deferred to follow-up PRs (each requires per-interface analysis): - `IngestionConfig` — the hand-written interface conflates Rust's `IngestionConfig` (no `query`) with `SavedConfig` (has `query`). Naive migration would break runtime behavior; needs a careful split between the request and saved-config shapes. - `UseCaseOverride` — openapi.ts uses `T | null` for skip_serializing_if options; hand-written uses `T?`. Functionally close but TypeScript treats them as distinct (null vs undefined). Needs callsite review. - `MutationResponse`, `QueryResponse`, `ResetDatabaseResponse`, `SystemKeyResponse`, `OrgInviteBundle` — invented or partial shapes that don't yet match openapi.ts (Phase 1 fixed the most egregious; remaining ones get migrated as openapi.ts coverage expands via Phase 3 cross-repo work). Verification: `npm run typecheck` clean, 655 vitest tests pass, lint unchanged from main.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Phase 4a of gbrain `projects/api-typegen-unification`. Six hand-written TypeScript interfaces in `ingestionClient.ts` collapse into one-line aliases over `openapi.ts`:
```ts
export type Role = components["schemas"]["Role"];
export type VisionBackend = components["schemas"]["VisionBackend"];
export type OllamaGenerationParams = components["schemas"]["OllamaGenerationParams"];
export type OllamaConfig = components["schemas"]["OllamaConfig"];
export type AnthropicConfig = components["schemas"]["AnthropicConfig"];
export type IngestionStatus = components["schemas"]["IngestionStatus"];
```
The drift check from #790 now mechanically prevents these from desyncing.
Scope
Bounded to types where the hand-written shape exactly matches the OpenAPI spec (verified line-by-line). Three classes of types stay hand-written for follow-up PRs:
Test plan
🤖 Generated with Claude Code