data-api-contract-changer

Design data model and API contract changes with EMC sequencing and rollback migrations.

4|Updated May 16, 2026
One-click install
npx skills add https://github.com/machenjie/rd-skills --skill data-api-contract-changer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: data-api-contract-changer
Source: https://github.com/machenjie/rd-skills/tree/main/src/professional-skills/data-api-contract-changer
Command: npx skills add https://github.com/machenjie/rd-skills --skill data-api-contract-changer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It prevents accidental breaking changes when you redesign database schemas, data models, API contracts, and error semantics that existing clients depend on.

Core Features & Use Cases

  • EMC-compliant change planning: Enforces Expand → Migrate → Contract sequencing for breaking changes and staged rollouts.
  • Compatibility-first migration design: Produces forward and rollback migration steps with compatibility classification, consumer readiness, and rollout/rollback ordering.
  • Machine-readable contract quality gates: Ensures RFC 7807-style validation errors, idempotency requirements, and rollback safety are explicitly included in the change plan.

Quick Start

Use data-api-contract-changer to generate a backward-compatible, idempotent, rollback-safe contract change plan for a database schema and API request/response update that must protect existing consumers.

Frequently Asked Questions about data-api-contract-changer

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

FAQPage Schema
How do I evolve API contracts and database schemas without breaking existing consumers?

To evolve API contracts without breaking consumers, you must enforce Expand → Migrate → Contract sequencing and generate forward and rollback migration steps with explicit compatibility classification to ensure safe rollout and rollback.

What is EMC sequencing for API schema evolution and when is it needed?

EMC sequencing is an Expand → Migrate → Contract pattern required for breaking changes and staged rollouts. It ensures backward compatibility by expanding capabilities first, migrating data, then tightening the API contract.

How do I model validation errors during API contract changes to remain machine-readable?

Model validation errors using RFC 7807-style semantics to maintain machine-readable contract quality gates. This standard ensures clients can reliably parse and handle validation updates during schema evolution.

How do I design idempotent write endpoints for retry-safe API rollouts?

Design idempotent write endpoints by explicitly defining idempotency requirements within your contract change plan. This ensures retry-safe operations for clients during database schema and API request or response updates.

Can I automate rollback safety for database migrations and DTO changes?

Yes, you can automate rollback safety by producing tested rollback migration steps alongside forward migrations. Compatibility classification and consumer readiness checks ensure rollback safety for request and response DTO changes.

What is the best way to plan deprecation across multiple API releases?

The best way to plan deprecation is by applying explicit compatibility classification across releases. This enables structured error-code and versioning planning, protecting existing clients while you modify API contracts.