One-click install
npx skills add https://github.com/velcrafting/codex-skills --skill contract-update
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: contract-update
Source: https://github.com/velcrafting/codex-skills/tree/main/skills/api/contract-update
Command: npx skills add https://github.com/velcrafting/codex-skills --skill contract-update

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Updating API contracts and client wiring without changing business logic requires disciplined, auditable change management to keep producers and consumers aligned.

Core Features & Use Cases

  • Explicit contract evolution with visible compatibility notes
  • Updates to OpenAPI/types and downstream client bindings when co-located
  • Maintains behavior while contracts drift or evolve

Quick Start

Identify the canonical contract source, apply additive updates, and update client bindings as needed.

Frequently Asked Questions about contract-update

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update API contracts without breaking existing client wiring?

To update API contracts safely, locate the canonical contract source and apply additive updates when possible. Document compatibility notes in code comments to maintain alignment across producers and consumers without altering runtime behavior.

What is the best way to manage schema evolution across multiple API consumers?

Managing schema evolution requires coordinating API contract changes across teams to prevent drift. Enforce a disciplined workflow by applying backward-compatible updates and documenting compatibility explicitly to keep producers and consumers aligned.

How do I apply breaking changes to an OpenAPI contract without causing misalignment?

Applying breaking changes to an OpenAPI contract requires explicit governance to prevent misalignment. Coordinate the changes across producers and consumers, update downstream client bindings if co-located, and document the compatibility impact thoroughly.

When do I need to update downstream client bindings during API versioning?

Downstream client bindings need updates during API versioning when contracts evolve and the bindings are co-located with the canonical contract source. This ensures consumers remain wired correctly without changing the underlying business logic.

Can I evolve API contracts without altering runtime behavior?

Yes, you can evolve API contracts without altering runtime behavior by applying additive updates to the schema. You must document the compatibility details in code comments or docs to ensure producers and consumers remain aligned.

How does API contract governance prevent drift between producers and consumers?

API contract governance prevents drift by enforcing a disciplined workflow for versioning and compatibility. It coordinates changes across teams, mandates documenting compatibility notes, and ensures client bindings match the canonical contract source.