SDK Update
Developmentsdk-updateSDK Update is an Agent Skill for development published in the Apicurio/apicurio-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Guide for updating SDKs when REST API changes are made. Use when the user modifies REST API endpoints, request/response models, or the OpenAPI spec.
QUICK START
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.
Prompt to paste
Inspect the Agent Skill at https://github.com/Apicurio/apicurio-registry/blob/HEAD/.claude/skills/sdk-update/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/sdk-update, 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.
SDK Update Guide
When REST API changes are made:
- Regenerate OpenAPI spec — the spec is auto-generated; verify it reflects the changes
- Java SDK (
java-sdk/,java-sdk-v2/,java-sdk-common/) — update models and client methods - Go SDK (
go-sdk/) — regenerate from OpenAPI spec - Python SDK (
python-sdk/) — regenerate from OpenAPI spec using Kiota - TypeScript SDK (
typescript-sdk/) — regenerate from OpenAPI spec - Update integration tests that use SDK clients
- Check backward compatibility — new fields should be optional, removed fields need migration