# OpenAPI Breaking Change Detector (`bmiller1009/openapi-breaking-change-detector`) Actor

Compare two OpenAPI/Swagger specs and identify breaking and non-breaking API contract changes between them.

- **URL**: https://apify.com/bmiller1009/openapi-breaking-change-detector.md
- **Developed by:** [Sentinel Signal](https://apify.com/bmiller1009) (community)
- **Categories:** Developer tools, AI
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $120.00 / 1,000 openapi breaking change detectors

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## OpenAPI Breaking Change Detector

Compare two OpenAPI/Swagger documents and identify breaking and non-breaking API contract changes between them.

### What it checks

- Removed or renamed endpoints and operations
- Parameter, request-body, and response schema changes (type changes, new required fields, removed fields)
- Authentication/security scheme changes
- Non-breaking additions (new optional fields, new endpoints)

The Actor performs a live comparison through Sentinel Verify.

### Pricing

**This is a paid, pay-per-event Actor: $0.12 per completed comparison.**

Exactly one `openapi-diff` event is charged per run, only after a real result exists (`success` or a useful `partial`). There is no charge for invalid input, a URL blocked by the public-network policy, or a run that fails before a result is produced.

### Input

- `beforeUrl` (required): HTTPS URL of the earlier OpenAPI/Swagger document.
- `afterUrl` (required): HTTPS URL of the newer OpenAPI/Swagger document.

Example input:

```json
{
  "beforeUrl": "https://example.com/openapi-v1.json",
  "afterUrl": "https://example.com/openapi-v2.json"
}
```

### Output

The default dataset receives one result envelope per comparison; `RUN_SUMMARY` in the default key-value store records processing, delivery, billing, and dependency totals.

Representative abbreviated output:

```json
{
  "status": "success",
  "result": {
    "breakingCount": 2,
    "nonBreakingCount": 5,
    "changes": [
      {"severity": "breaking", "type": "API_PARAMETER_REQUIRED_CHANGED", "path": "/v1/orders", "method": "POST"}
    ]
  }
}
```

`restricted` means one of the URLs was rejected locally before calling Verify — `beforeUrl` is checked first, so if it fails the result names `beforeUrl`; otherwise `afterUrl` is checked next. `unreachable` means a URL's hostname could not be resolved. `dependency_unavailable` means Verify was temporarily unavailable.

### How it works

This Actor is a thin wrapper around Sentinel Verify's `POST /v1/utilities/api-schema-diff` endpoint. Each URL is checked locally against API-IFY's public-network policy, `beforeUrl` first and then `afterUrl`, before either is sent to Verify.

### Limitations

- Public HTTPS URLs only, port 443, no embedded credentials; private, loopback, link-local, metadata, reserved, and CGNAT targets are rejected.
- Comparison availability depends on Sentinel Verify.

### Privacy and security

Both URLs are sent to Sentinel's live Utility API (`/v1/utilities/api-schema-diff`) for analysis after local public-network validation. Results are stored in the customer's Apify run dataset and summary store. `VERIFY_API_KEY` is an operator-managed Actor secret — a scoped `utilities:read` Intelligence API key sent as a bearer token on every request, the same credential mechanism used by any other Utility API consumer; `VERIFY_BASE_URL` is an operator setting, not an Actor input.

### Support

For a reproducible support request, provide the Apify run ID, result `itemId`, and status. Contact Sentinel Signal Systems through the support link on the Actor page.

# Actor input Schema

## `beforeUrl` (type: `string`):

HTTPS URL of the earlier OpenAPI/Swagger document, e.g. https://example.com/openapi-v1.json.

## `afterUrl` (type: `string`):

HTTPS URL of the newer OpenAPI/Swagger document, e.g. https://example.com/openapi-v2.json.

## Actor input object example

```json
{}
```

# Actor output Schema

## `results` (type: `string`):

No description

## `runSummary` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("bmiller1009/openapi-breaking-change-detector").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("bmiller1009/openapi-breaking-change-detector").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call bmiller1009/openapi-breaking-change-detector --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,bmiller1009/openapi-breaking-change-detector"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/2d0xIXJqyuIe5LGET/builds/ozCVZALxrTDsNrLwI/openapi.json