# Monitor an OpenAPI spec for breaking changes

**Use case:** 

Compare the public GitHub OpenAPI specification with persistent state. Dry-run performs the diff without billing events or webhook delivery.

## Input

```json
{
  "apis": [
    {
      "name": "github",
      "type": "openapi",
      "url": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json"
    }
  ],
  "githubPath": "leads/api-radar-latest.json",
  "githubBranch": "main",
  "slackChannel": "#general",
  "dryRun": true,
  "maxApis": 1
}
```

## Output

```json
{
  "api": {
    "label": "API",
    "format": "string"
  },
  "detected_at": {
    "label": "Detected at",
    "format": "string"
  },
  "change_class": {
    "label": "Change class",
    "format": "string"
  },
  "severity": {
    "label": "Severity",
    "format": "string"
  },
  "title": {
    "label": "Title",
    "format": "string"
  },
  "summary": {
    "label": "Summary",
    "format": "string"
  },
  "evidence_url": {
    "label": "Evidence URL",
    "format": "string"
  }
}
```

## How it works

### 1. Sign up on Apify or log in

The API Breaking-Change Impact Radar Actor is ready to run with the inputs already set for "Monitor an OpenAPI spec for breaking changes". [Sign up or log in](https://console.apify.com/create-task-from-example/JEV9Jaj5pnxFb1knw) and you'll land in Apify Console with a copy of this exact task.

### 2. Start the "Monitor an OpenAPI spec for breaking changes" task

The API Breaking-Change Impact Radar Actor will start running based on the input automatically. You can also change all the input fields, like APIs to monitor, github file path, and more, to match your specific use case.

### 3. Receive the "Monitor an OpenAPI spec for breaking changes" output

Monitor the progress in real time. You will be notified as soon as your dataset is complete and ready for review. Each result includes data such as API, detected at, change class, and more.

### 4. Integrate into your workflow

The final output is delivered in JSON, CSV, or Excel format, ready to be plugged into your workflow. You can also [run the "Monitor an OpenAPI spec for breaking changes" task via API](https://apify.com/travelmonitorlab/api-breaking-change-radar.md).

## FAQ

### What happens on the first run?

The first run stores a baseline snapshot; later runs compare the same OpenAPI specification and report changes.

### Does dry-run send alerts?

No. Dry-run performs the analysis without event charges or external webhook delivery.

## About this Actor

This example demonstrates how to use [API Breaking-Change Impact Radar](https://apify.com/travelmonitorlab/api-breaking-change-radar.md) with a specific input configuration. Visit the [Actor detail page](https://apify.com/travelmonitorlab/api-breaking-change-radar.md) to learn more, explore other use cases, and run it yourself.


## How to integrate an Actor?

This Task's input is already configured above. Use it as-is rather than inventing a new one.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For full API examples (JavaScript, Python, CLI, MCP, OpenAPI), see this Task's Actor page: https://apify.com/travelmonitorlab/api-breaking-change-radar.md

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).