Skip to main content
OpenAPI 2.0 · 3.0 · 3.1

OpenAPI: detection, decision, and the grant that follows

Detection is where this starts, not where it ends. CodeRifts reads an OpenAPI change on every pull request, turns it into a signed decision, and only a granted change ships. GitHub-native. Zero configuration. Analysis is free.

OpenAPI version support

Swagger 2.0

Full support for legacy Swagger/OpenAPI 2.0 specifications.

OpenAPI 3.0

Diffed by the openapi-diff package after local refs are inlined.

OpenAPI 3.1

A 3.1 spec is diffed as written, the 3.0.3 conversion runs only when oasdiff did not answer, and dependentRequired is REQUIRE_APPROVAL with one breaking change.

An OpenAPI 3.1 webhook is diffed in the inverted direction, so authorize returns ANALYSIS_FAILED and STOP with the gap named. A changed or removed callback, or a switched or removed external or remote $ref, is the same decision. A 3.1 spec is diffed as written, the 3.0.3 conversion runs only when oasdiff did not answer, and dependentRequired is REQUIRE_APPROVAL with one breaking change.

Format coverage, read 2026-10-04, is the table on the documentation page. An incomplete analysis in authorize mode is ANALYSIS_FAILED and STOP, with the gap named.

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, by direction

The gate judges an enum change by direction (ruleset enum-direction/2026-10-03): a request value removed is breaking, a request value added is not breaking, a response value removed is INFO, and a response value added is breaking and the decision is REQUIRE_APPROVAL, not BLOCK.

⚠

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. Read our migration guide

Start detecting OpenAPI breaking changes today.

Install in 30 seconds. No YAML. No CI changes. No tokens.

During the public beta every organization gets Team features at $0 with a self-serve key, public and private repositories alike, no separate Team key to request, and each key allows 1,000 requests a month: after that, /preflight authorize returns BETA_LIMIT_REACHED while its analysis keeps working; other API routes return 429.