API Change
Developmentapi-changeAPI Change is an Agent Skill for development published in the software-mansion/smelter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Run the full API change workflow after modifying types in smelter-api. Generates schemas, TypeScript types, and verifies everything is in sync.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/software-mansion/smelter/blob/HEAD/.claude/skills/api-change/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/api-change, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Run the API change workflow. All steps must pass before the change is considered complete.
Steps
-
Register new routes in OpenAPI spec If a new route was added, ensure it is listed in the
#[openapi(paths(...))]macro intools/src/bin/generate_from_types.rs. Each route handler function must be referenced there for it to appear in the generated OpenAPI specification. -
Generate JSON schemas from Rust types Run:
cargo run -p tools --bin generate_from_typesThis generatestools/schemas/scene.schema.jsonandtools/schemas/api_types.schema.json. -
Generate TypeScript types from schemas Run in
./ts:pnpm run generate-typesThis generatests/smelter/src/api.generated.ts. -
Build the TypeScript SDK to verify compatibility Run in
./ts:pnpm i && pnpm build:all -
Show a summary of all generated/changed files so the user can review what was affected.
-
Try to update SDK: Update TypeScript SDK code if the generated types require manual adaptation. In most cases you will need to:
- add/modify type in
ts/smelterpackage e.g.ts/smelter/src/types/input.ts - add/modify mapping in
ts/smelter-corepackage e.g.ts/smelter-core/src/api/input.ts. In most cases it will be just switching snake case to camel case, but consider if there are more idiomatic alternatives. - add/modify type in
ts/smelter-node/src/api.ts. - add/modify type in
ts/smelter-web-client/src/api.ts. Inform user if it's not obvious how the changes should be adapted.
- add/modify type in