OpenParable
Skip to content
← Back to skills

SDK Update

Development
sdk-update

SDK 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.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. 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:

  1. Regenerate OpenAPI spec — the spec is auto-generated; verify it reflects the changes
  2. Java SDK (java-sdk/, java-sdk-v2/, java-sdk-common/) — update models and client methods
  3. Go SDK (go-sdk/) — regenerate from OpenAPI spec
  4. Python SDK (python-sdk/) — regenerate from OpenAPI spec using Kiota
  5. TypeScript SDK (typescript-sdk/) — regenerate from OpenAPI spec
  6. Update integration tests that use SDK clients
  7. Check backward compatibility — new fields should be optional, removed fields need migration