agentleFS
Sign inStart free
open-edge-platformopen-edge-platform/training_extensions/skills/application/geti-openapi-sync/SKILL.md

geti-openapi-sync

Skill1.4k starsChanged 17 days agoApache-2.0View on GitHub

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.

1 other project uses a version of this.

Trending

More talk lately.about the whole repository

Dec 2025: 1 mentionJan 2026: 4 mentionsFeb 2026: 2 mentionsMar 2026: 2 mentionsApr 2026: 7 mentionsMay 2026: 2 mentionsJun 2026: 3 mentionsJul 2026: 2 mentionsAug 2026: 3 mentionsSep 2026: 4 mentionsOct 2026: 9 mentionsNov 2026: 5 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the open-edge-platform/training_extensions repository that our weekly crawl found. There is no adoption data for this file yet.

Most recently taken up by

Who's talking about open-edge-platform/training_extensions

The biggest 5 of 50 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 50

Talked about on GitHub (50 times).

On GitHub · 50

45 more on GitHub

The file

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. About 0 are common, 3 are distinctive, and 10 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 10

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

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

    line 10
  2. Very specific:

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

    line 11
  3. Very specific:

    If the backend is not already running, generate the spec from application/backend/ with just gen-api-spec --output-path …

    line 15
  4. Very specific:

    If the backend is already running on https://localhost:7860, work from application/ui/ and run npm run update-spec (it fetches over TLS …

    line 16
  5. Very specific:

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

    line 17
  6. Very specific:

    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.

    line 18
  7. Distinctive:

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

    line 22
  8. Very specific:

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

    line 23
  9. Very specific:

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

    line 24
  10. Very specific:

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

    line 25
  11. Very specific:

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

    line 29
  12. Very specific:

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

    line 30
  13. Distinctive:

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

    line 31

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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

  1. 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.
  2. If the backend is already running on https://localhost:7860, work from application/ui/ and run npm run update-spec (it fetches over TLS with --insecure, since the backend serves a self-signed certificate).
  3. If only the JSON spec changed locally, run npm run build:api from application/ui/ to regenerate src/api/openapi-spec.d.ts.
  4. 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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free