Skills
.Work. You
Rest

api-compatibility-check

Official

Detect breaking GraphQL API changes across domains.

Software Engineering#api#compatibility#graphql#diff#breaking-changes#pr-check
AuthorHopin-inc
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill analyzes GraphQL schema changes to identify backward-incompatible edits that could break clients and consumers, enabling safe and auditable API evolution.

Core Features & Use Cases

  • Automated compatibility checks: Compare PR diffs or specific schema files to surface breaking changes such as field removals, type changes, and required argument additions.
  • Migration guidance: Provide recommended mitigations (deprecation, new fields, or versioning) and outline a phased rollout plan for safe transitions.
  • Cross-domain coverage: Analyze changes across multiple domains to ensure end-to-end compatibility for iOS, Android, and Web clients.

Quick Start

Run the CLI to diff your target GraphQL schema against the main branch (or a PR) to surface breaking changes and suggested mitigations.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-compatibility-check
Download link: https://github.com/Hopin-inc/civicship-api/archive/main.zip#api-compatibility-check

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.