Skip to content
cccskills
FreePublished on GitHub

generate-api-client

Regenerate the frontend TypeScript API client from backend OpenAPI spec. Use after changing backend controller signatures or related data types. Triggers on: generateTypeScript, API regeneration, controller signature changed, OpenAPI lint failure, generated API code.

The English summary is being prepared. Showing the original description.

nerds-odd-e/doughnut50 stars(GitHub 50 + cccskills 0)

Run score Not tested

See how to install

Files included (1)

  • SKILL.md3.2 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

<objective> Regenerate the frontend TypeScript API client from the backend OpenAPI spec and fix any broken frontend usage.

Purpose: Keep packages/generated/donut-backend-api in sync with Java controllers — never hand-edit generated output.

Output: Regenerated client + green frontend tests + summary ending with ## API CLIENT GENERATED. </objective>

<context> The frontend API client at `packages/generated/donut-backend-api` is auto-generated from the backend OpenAPI spec.

Never edit generated code directly. This includes whitespace-only cleanup in sdk.gen.ts, types.gen.ts, and open_api_docs.yaml; if generated output changes, accept it or fix the generator path.

Git does not use the Nix prefix. All other repo tooling does: CURSOR_DEV=true nix develop -c …

Do not run raw git diff --check as a generated-client cleanup gate. Use scripts/check_diff_whitespace.sh, which excludes generated API artifacts from manual whitespace fixes.

Regenerate when:

  • A backend controller signature changed
  • A backend data type used by any controller signature changed
  • pnpm openapi:lint or pnpm format:all fails with OpenAPI validation errors

Regenerate in the same change as the controller edit: the backend test RobotsTests.openApiDocsMatchCommittedYaml fails until open_api_docs.yaml matches, so a signature change cannot be committed on its own while CI stays green. </context>

<process> <step name="fix_java_controllers"> Fix the **Java controllers** (not the generated files). </step> <step name="regenerate"> ```bash CURSOR_DEV=true nix develop -c pnpm generateTypeScript ``` </step> <step name="verify_frontend"> Check if the change affected frontend usage — run frontend tests: 
CURSOR_DEV=true nix develop -c pnpm frontend:test

Fix any broken frontend code that used the old API signatures. </step>

<step name="openapi_lint_failures"> If `pnpm openapi:lint` fails: **do not** edit `open_api_docs.yaml` (it is generated). Fix Java controllers, regenerate, then re-lint. Playbook details: `.agents/skills/linting_formating/SKILL.md` → **OpenAPI Linting**. </step> </process>

<success_criteria>

  • Java controllers fixed at source (not generated files)
  • pnpm generateTypeScript run with Nix prefix
  • Frontend tests pass after signature changes
  • OpenAPI lint passes (fix controllers + regenerate, never hand-edit YAML)
  • Final output includes ## API CLIENT GENERATED </success_criteria>
<output> Report a short summary to the caller, then the completion marker:
  1. What triggered regeneration (controller/DTO change, lint failure, etc.).
  2. Whether frontend call sites needed updates.
  3. Tests run and confirmed passing.
## API CLIENT GENERATED
</output>

<out_of_scope>

  • Do not hand-edit sdk.gen.ts, types.gen.ts, or open_api_docs.yaml.
  • Do not use raw git diff --check for generated-client whitespace gates. </out_of_scope>

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

backend

Free

Backend Java — Spring Boot controllers/services, JUnit controller tests, MakeMe. Read this first for any backend work. Use when working on the Java Spring backend.

The English summary is being prepared. Showing the original description.

nerds-odd-e/doughnut50Updated Oct 26, 2026

backend-code

Free

Backend Java production code, Spring Boot controllers/services/repositories, controller return values, imports, schema ERD pointer. Use when editing backend production Java.

The English summary is being prepared. Showing the original description.

nerds-odd-e/doughnut50Updated Oct 26, 2026

backend-testing

Free

Backend Java tests, controller-level stable-boundary tests, JUnit, @Nested, MakeMe builders, @Transactional, parameterized tests. Use when writing or changing backend JUnit tests.

The English summary is being prepared. Showing the original description.

nerds-odd-e/doughnut50Updated Oct 26, 2026

cli

Free

related to donut CLI. Use when working on donut-cli.

The English summary is being prepared. Showing the original description.

nerds-odd-e/doughnut50Updated Oct 26, 2026

cloud-vm-setup

Free

Set up and run the Donut dev environment on Cursor Cloud VM (no Nix). Use when working on Cloud VM, running tests on Cloud VM, or encountering command errors related to missing nix. Triggers on: cloud VM, cloud agent, no nix available, /workspace path.

The English summary is being prepared. Showing the original description.

nerds-odd-e/doughnut50Updated Oct 26, 2026

database-erd

Free

Regenerate docs/database-erd.md from MySQL information_schema (Mermaid ERD: foreign keys and key columns). Use after Flyway schema changes, new migrations, or when the diagram is stale. Triggers on: database ERD, database-erd.md, export_database_erd, schema diagram, ER diagram after migration.

The English summary is being prepared. Showing the original description.

nerds-odd-e/doughnut50Updated Oct 26, 2026

See all skills by nerds-odd-e

Report a problem with this skill