Skip to content
Skills Library
Programming · Review & audit

openapi-hub

/openapi-hub

OpenAPI spec versioning, breaking change detection, and SDK publishing. Tracks spec versions, blocks PRs that introduce breaking API changes without a major version bump, and auto-publishes updated docs. Use when managing a public API, releasing a new API version, or detecting breaking changes in a PR.

Licence
MIT
Last repository change
16.10.2026

Assessment and security

95/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content30 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
3
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 16.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

OpenAPI spec versioning, breaking change detection, and SDK publishing. Tracks spec versions, blocks PRs that introduce breaking API changes without a major version bump, and auto-publishes updated docs. Use when managing a public API, releasing a new API version, or detecting breaking changes in a PR.

Original author description

OpenAPI spec versioning, breaking change detection, and SDK publishing. Tracks spec versions, blocks PRs that introduce breaking API changes without a major version bump, and auto-publishes updated docs. Use when managing a public API, releasing a new API version, or detecting breaking changes in a PR.

How it works

  1. Commands
  2. Breaking Change Detection
  3. Spec Versioning
  4. CI Gate
Original SKILL.md headings · 56 lines, 226 words
SKILL.md preview
---
name: "openapi-hub"
description: "OpenAPI spec versioning, breaking change detection, and SDK publishing. Tracks spec versions, blocks PRs that introduce breaking API changes without a major version bump, and auto-publishes updated docs. Use when managing a public API, releasing a new API version, or detecting breaking changes in a PR."
---

# OpenAPI Hub Plugin

Spec versioning + breaking change gates + SDK publishing.

## Commands

```
/openapi-hub validate          — validate openapi.yaml against OpenAPI 3.1
/openapi-hub diff v1 v2        — detect breaking changes between versions
/openapi-hub publish           — publish docs to Redoc / GitHub Pages
/openapi-hub sdk ts            — regenerate TypeScript SDK from current spec
/openapi-hub changelog         — auto-generate API changelog from spec diff
/openapi-hub mock-server       — start Prism mock server from spec
```

## Breaking Change Detection

```
BREAKING CHANGES — v3.3.0 → v3.4.0
=====================================
❌ 2 breaking changes detected (requires major version bump)

  [BREAK] GET /products/{id} — removed field 'legacyId' from response
          → Clients depending on legacyId will break silently
          → Add to deprecated fields list and keep for v4.0.0

  [BREAK] POST /orders — 'couponCode' now required (was optional)
          → Clients not sending couponCode will get 422
          → Make it optional again OR bump to v4.0.0

⚠️ 3 non-breaking changes (safe to ship in v3.4.0)
  [ADD] GET /products — new optional query param 'featured'
  [ADD] User schema — new optional field 'avatarUrl'
  [DEP] POST /v1/auth/login — deprecated, use POST /v2/auth/login
```

## Spec Versioning

```
specs/
  openapi.yaml          ← current (auto-symlink to latest)
  openapi-v3.4.0.yaml
  openapi-v3.3.0.yaml
  openapi-v3.2.0.yaml
```

## CI Gate

```yaml
- name: Detect breaking API changes
  run: npx @redocly/cli lint openapi.yaml && npx oasdiff openapi-v3.3.0.yaml openapi.yaml --fail-on-breaking
```

Pairs with `/openapi-generate` skill for spec generation.
Files in this package (3)
  • SKILL.md 2 KB
  • plugin.json 1 KB
  • skills/openapi-hub/SKILL.md 2 KB

Versions

The database has no other skills named openapi-hub.

Identical content appears in 1 other GitHub folders. We show one copy with the highest score.

Database snapshot: 13.11.2026 · package version f913d539009c (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100openapi-breaking-change-report
    Compares two versions of an OpenAPI 3.x spec and reports breaking, risky and safe changes for API consumers, with a semver bump suggestion and migration notes. Use when asked to diff OpenAPI or Swagger specs, check for breaking changes, review an API PR, compare openapi.yaml files, or run oasdiff.
  • 100api-design-reviewer
    Review REST API designs for quality, consistency, and breaking changes. Lints OpenAPI specs, generates scorecards, and detects breaking changes between versions. Use when designing APIs, reviewing contracts, or managing API versioning.
  • 100api-changelog
    Drafts API changelog entries from two versions of an OpenAPI spec. Use when asked to write release notes or a changelog for API changes, compare two OpenAPI files, or find breaking changes between spec versions. Runs oasdiff for the facts, then writes the entries in plain…
  • 100api-design-reviewer
    Review REST API designs for quality, consistency, and breaking changes. Lints OpenAPI specs, generates scorecards, and detects breaking changes between versions. Use when designing APIs, reviewing contracts, or managing API versioning.
  • 100api-versioning
    Version REST and GraphQL APIs. Use when a user asks to version an API, handle breaking changes, implement API deprecation, manage multiple API versions, or design an API evolution strategy.
  • 100testing-api-contracts
    Validates API responses against OpenAPI or JSON Schema, detects breaking changes between spec versions, and builds consumer-driven contract checks. Use when an API has a published spec, when a backend change might break a client, when API tests assert only status codes, or when…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.