Overview

OpenAPI breaking change detection

Full OpenAPI support#

  • Swagger 2.0 — Full support for legacy Swagger/OpenAPI 2.0 specifications.
  • OpenAPI 3.0 — Complete support for OpenAPI 3.0.x with all schema features.
  • OpenAPI 3.1 — Full JSON Schema compatibility with OpenAPI 3.1.x support.

10 breaking change types detected#

  • Endpoint removal — DELETE /api/users was removed
  • Required field added — new required field email in POST /users request body
  • Response field removal — field name removed from GET /users response
  • Type change — field age changed from integer to string
  • Auth scheme change — security scheme changed from API key to OAuth2
  • Enum value removal — value admin removed from role enum
  • Path parameter change — parameter userId renamed to id
  • Response code removal — HTTP 201 response removed from POST /orders
  • Constraint tightening — maxLength reduced from 255 to 100
  • Content type change — media type changed from JSON to XML

How it works#

  1. Install the GitHub App. One click. Select repositories. No YAML, no CI changes, no tokens.
  2. Open a pull request. CodeRifts auto-discovers OpenAPI specs and compares base vs. head.
  3. Review the report. Get a detailed PR comment with breaking changes, risk score, and migration guidance.

Supported file formats#

CodeRifts auto-discovers spec files by content, not just file extension.

Format Extensions Status
YAML .yaml .yml Supported
JSON .json Supported
Bundled / Multi-file $ref resolution Supported

Why CodeRifts for OpenAPI?#

Feature CodeRifts oasdiff CLI Optic (archived)
Zero config
GitHub-native (no CI changes)
Auto-discovery of specs
Risk scoring
Policy engine
Actively maintained Archived

Optic was archived on January 12, 2026. See CodeRifts vs Optic.

See also: OpenAPI Diff Tool, Breaking Changes taxonomy, Swagger migration.

Updated

Was this page helpful?