skills.rest
superluminar-io
superluminar-ioOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-change-guardian

Detect API contract changes against a published registry spec and classify version bumps.

10|Updated Jun 1, 2026
Search Tags:#automation#versioning#registry#software-engineering#api-change#contract-guardrail
One-click install
npx skills add https://github.com/superluminar-io/pinky-promise --skill api-change-guardian
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-change-guardian
Source: https://github.com/superluminar-io/pinky-promise/tree/main/skills/api-change-guardian
Command: npx skills add https://github.com/superluminar-io/pinky-promise --skill api-change-guardian

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Detects changes to a published API and forces a conscious versioning decision, preventing accidental breaking changes.

Core Features & Use Cases

  • Registry-sourced change detection: compares proposed changes against the official published spec from the registry.
  • Versioning governance: classifies changes into major, minor, or patch and guides next steps.
  • Workflow integration: applicable at brainstorming, planning, implementation, or review stages to ensure API stability.

Quick Start

Run api-change-guardian after proposing an API change to determine the required version bump.

Frequently Asked Questions about api-change-guardian

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

FAQPage Schema
How do I prevent accidental breaking API contract changes during development?▼

To prevent accidental breaking API contract changes, validate proposed modifications against the published registry spec to classify version impacts. This governance enforces conscious major, minor, or patch version bumps before integration.

What is the best way to enforce semantic versioning rules for API updates?▼

Enforcing semantic versioning for API updates requires comparing new changes against the official registry spec to guide classification. This process validates modifications and prompts a conscious decision to proceed or defer.

Can I check API version compatibility during the brainstorming or planning stages?▼

Yes, you can check API version compatibility during brainstorming, planning, implementation, or review stages. The registry acts as the source of truth to validate proposed changes early in the software engineering workflow.

How do I validate proposed API changes against a published spec?▼

Validating proposed API changes against a published spec involves using the registry as the source of truth. The system detects deviations and guides major, minor, or patch version classification to ensure stability.

Why do I need to classify API changes as major, minor, or patch versions?▼

Classifying API changes as major, minor, or patch versions enforces conscious versioning decisions and prevents accidental breaking changes. This governance ensures API stability by validating modifications against the registry.

Related Skills

Explore More Software Engineering Skills→
OMIXECOMIXEC
1

openapi-spec-generation

Generate and validate OpenAPI 3.1 specifications from code and design sources.

Community
Advanced
openperimetryopenperimetry

update-ovfx

Bump OVFX spec versions and update schema, examples, tests, and changelog.

Official
Advanced
resultakakresultakak

data-contracts

Enforce consumer-producer data contracts across REST, GraphQL, gRPC, and streaming protocols.

Community
Advanced
viditparashar96viditparashar96

eng-api-design

Review REST, GraphQL, and gRPC API designs and generate OpenAPI specifications.

Community
Advanced