# Find newly required API parameters before release

**Use case:** 

Compare two synthetic OpenAPI JSON specs for an inventory API. Find two potential breaking changes: an optional warehouse query parameter becomes required, and a new required X-Client-Version header is added. Inspect locations and suggested actions in HTML, CSV or JSON. No API calls. Selected checks only, not a full compatibility guarantee. Displayed Actor pricing applies.

## Input

```json
{
  "previousSpec": "{\n  \"openapi\": \"3.1.2\",\n  \"info\": {\n    \"title\": \"Synthetic Inventory API\",\n    \"version\": \"1.0.0\"\n  },\n  \"paths\": {\n    \"/inventory\": {\n      \"get\": {\n        \"parameters\": [\n          {\n            \"name\": \"warehouse\",\n            \"in\": \"query\",\n            \"required\": false,\n            \"schema\": {\n              \"type\": \"string\"\n            }\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Inventory count\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"type\": \"integer\"\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}",
  "currentSpec": "{\n  \"openapi\": \"3.1.2\",\n  \"info\": {\n    \"title\": \"Synthetic Inventory API\",\n    \"version\": \"2.0.0\"\n  },\n  \"paths\": {\n    \"/inventory\": {\n      \"get\": {\n        \"parameters\": [\n          {\n            \"name\": \"warehouse\",\n            \"in\": \"query\",\n            \"required\": true,\n            \"schema\": {\n              \"type\": \"string\"\n            }\n          },\n          {\n            \"name\": \"X-Client-Version\",\n            \"in\": \"header\",\n            \"required\": true,\n            \"schema\": {\n              \"type\": \"string\"\n            }\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Inventory 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`).