api-compatibility-check

Name: api-compatibility-check
Availability: InStock
Author: Hopin

Detects breaking changes in SwaggerUnofficial API specifications.

3|2|Updated Jun 25, 2024

Search Tags:#api #compatibility #graphql #diff #breaking-changes #pr-check

Ready to run

npx skills add https://github.com/Hopin-inc/civicship-api --skill api-compatibility-check

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-compatibility-check
Source: https://github.com/Hopin-inc/civicship-api/tree/main/.claude/skills/api-compatibility-check
Command: npx skills add https://github.com/Hopin-inc/civicship-api --skill api-compatibility-check

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about api-compatibility-check

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

FAQPage Schema

How do I detect breaking changes in a GraphQL schema?▼

To detect breaking changes in a GraphQL schema, compare PR diffs or specific schema files to surface backward-incompatible edits like field removals, enum removals, and non-null to nullable changes. This identifies potential issues affecting clients and downstream services.

What is considered a breaking change in GraphQL API evolution?▼

Breaking changes in GraphQL API evolution include field removals, type changes, required argument additions, enum removals, and non-null to nullable modifications. These backward-incompatible edits can disrupt clients and consumers across domains.

How do I check GraphQL PR diffs for backward-incompatible edits across domains?▼

You check GraphQL PR diffs for backward-incompatible edits across domains by comparing schema files against the main branch. This surfaces breaking changes and provides mitigation recommendations to ensure end-to-end compatibility for iOS, Android, and Web clients.

Can I get migration guidance for required argument additions in GraphQL?▼

Yes, you can get migration guidance for required argument additions in GraphQL. The compatibility check provides recommended mitigations like deprecation, new fields, or versioning, and outlines a phased rollout plan for safe transitions.

Does this GraphQL compatibility check work with specific schema files or only PR diffs?▼

This GraphQL compatibility check works with both specific schema files and PR diffs. You can run a CLI command to diff your target GraphQL schema against the main branch or a PR to surface breaking changes and suggested mitigations.

What are the limitations of automated GraphQL schema diffing?▼

Automated GraphQL schema diffing identifies structural breaking changes like field removals and required argument additions, but safe API evolution still requires human oversight to apply mitigation recommendations and manage phased rollout plans across clients.