geti-openapi-sync

Regenerate and validate the OpenAPI contract between `application/backend/` and `application/ui/`. Use when backend endpoints, schemas, request or response models, or API surface change, or when `application/ui/src/api/openapi-spec.json` or `openapi-spec.d.ts` is stale. Handles backend spec generation, UI spec placement, TypeScript type regeneration, and the smallest backend and UI checks needed to confirm the contract still matches.

Jump to install

Repository: open-edge-platform/geti
Last source activity: July 7, 2026 at 08:28
Detected SKILL.md language: English
Stars: 1,303
Forks: 473

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/open-edge-platform/geti --skill geti-openapi-sync

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer

2 files

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

geti-ui-dev

Develop and validate changes in `application/ui/` for the React and TypeScript frontend. Use when touching `application/ui/src/**`, frontend tests, RSBuild or Vitest config, Playwright setup, package scripts, or generated API typings under `src/api`. Helps with Node and npm requirements, install and build commands, lint, typecheck, test workflows, and coordination with backend OpenAPI changes.

2026-08-11

geti-backend-dev

Develop and validate changes in `application/backend/` for the FastAPI `geti` service. Use when touching `application/backend/app/**`, backend tests, backend packaging, backend configuration, API routers, schemas, services, repositories, or database code, or when the UI contract depends on a backend API change. Helps with `uv` and `just` setup, targeted pytest or behave runs, OpenAPI generation, and local server workflows.

2026-07-07

geti-docs-update

Update documentation (README, CHANGELOG, Sphinx docs, or inline docstrings) to reflect changes, fixes, or new features. Use when a PR modifies behavior that should be documented for users or developers.

2026-07-07

View all from this repository

Geti OpenAPI Sync

Goal

Keep backend OpenAPI output and UI generated API types in sync.

Prefer regeneration over manual edits to generated JSON or .d.ts files.

Preferred Workflow

If the backend is not already running, generate the spec from application/backend/ with just gen-api-spec --output-path ../ui/src/api/openapi-spec.json on Unix-like shells, or just gen-api-spec --output-path ..\\ui\\src\\api\\openapi-spec.json on Windows.

If the backend is already running on http://localhost:7860, work from application/ui/ and run npm run update-spec.

If only the JSON spec changed locally, run npm run build:api from application/ui/ to regenerate src/api/openapi-spec.d.ts.

Run npm run format:check and npm run type-check in application/ui/, then the narrowest backend or UI tests affected by the contract change.

When to Use Each Path

Use direct backend generation when working offline, in CI-like flows, or before the server is runnable.

Use npm run update-spec when actively iterating with a local backend server.

Use $geti-backend-dev for backend fixes if generation exposes schema problems.

Use $geti-ui-dev for UI changes that consume the regenerated types.

Guardrails

Commit the generated spec and .d.ts together when the contract change is intentional.

Do not manually edit application/ui/src/api/openapi-spec.d.ts.

If generation fails, fix the backend route or schema definitions instead of patching the generated output.

name

geti-openapi-sync

description