# Find removed API endpoints before a release

**Use case:** 

Compare two synthetic Orders API specifications before a release. This example flags a removed endpoint, a newly required query parameter and a narrowed enum. It returns three potential-breaking findings in HTML, CSV and JSON. Selected checks only; compatibility is not established.

## Input

```json
{
  "previousSpec": "{\n  \"openapi\": \"3.1.2\",\n  \"info\": {\n    \"title\": \"Synthetic Orders API\",\n    \"version\": \"1.0\"\n  },\n  \"paths\": {\n    \"/orders\": {\n      \"get\": {\n        \"parameters\": [\n          {\n            \"name\": \"state\",\n            \"in\": \"query\",\n            \"required\": false,\n            \"schema\": {\n              \"type\": \"string\",\n              \"enum\": [\n                \"open\",\n                \"closed\"\n              ]\n            }\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Order count\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"type\": \"integer\"\n                }\n              }\n            }\n          }\n        }\n      }\n    },\n    \"/legacy\": {\n      \"get\": {\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Legacy\"\n          }\n        }\n      }\n    }\n  }\n}",
  "currentSpec": "{\n  \"openapi\": \"3.1.2\",\n  \"info\": {\n    \"title\": \"Synthetic Orders API\",\n    \"version\": \"2.0\"\n  },\n  \"paths\": {\n    \"/orders\": {\n      \"get\": {\n        \"parameters\": [\n          {\n            \"name\": \"state\",\n            \"in\": \"query\",\n            \"required\": true,\n            \"schema\": {\n              \"type\": \"string\",\n              \"enum\": [\n                \"open\"\n              ]\n            }\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Order count\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"type\": \"integer\"\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}"
}
```

## Output

```json
{
  "status": {
    "label": "Review status",
    "format": "string"
  },
  "findingsTotal": {
    "label": "Findings",
    "format": "integer"
  },
  "previousOperations": {
    "label": "Previous operations",
    "format": "integer"
  },
  "currentOperations": {
    "label": "Current operations",
    "format": "integer"
  },
  "findingsTruncated": {
    "label": "Details truncated",
    "format": "boolean"
  },
  "compatibilityEstablished": {
    "label": "Compatibility established",
    "format": "boolean"
  }
}
```

## About this Actor

This example demonstrates how to use [OpenAPI JSON Diff & Breaking Change Checker](https://apify.com/fluffy_ingot/openapi-change-preflight.md) with a specific input configuration. Visit the [Actor detail page](https://apify.com/fluffy_ingot/openapi-change-preflight.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/fluffy_ingot/openapi-change-preflight.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`).
