# OpenAPI Breaking Change Monitor (`silicon1235/openapi-breaking-change-monitor`) Actor Monitor public OpenAPI specs for removed paths, operations, operation IDs, and security schemes. - **URL**: https://apify.com/silicon1235/openapi-breaking-change-monitor.md - **Developed by:** [X L](https://apify.com/silicon1235) (community) - **Categories:** Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 Monitor Monitor public OpenAPI JSON or YAML specs for removed paths, removed operations, removed operation IDs, removed security schemes, and high-risk schema-surface drift. This Actor is intentionally narrow. It is for developer-platform, API, SDK, customer-success, and agency teams that need scheduled breaking-change alerts for public API specs without building their own OpenAPI diff watcher. Breaking rows include `breakingSeverity`, `breakingTypes`, `breakingRiskScore`, and `changeSummary`, so users can quickly see whether the alert is about removed paths, methods, operation IDs, security schemes, or multiple breaking surfaces. ### Quick-start presets Copy one of these small first-run inputs from `examples/presets/`: - `single-api-baseline-watch.json`: create the first scheduled baseline for one public OpenAPI spec. - `competitor-api-drift-watch.json`: monitor a small set of competitor or partner API specs for removed public surfaces. - `stripe-style-api-watch.json`: monitor a vendor API compatibility surface before SDK, integration, or customer-success impact. Each preset keeps `maxSpecs` at 3 or less and saves a snapshot so the next scheduled run can detect breaking drift without large first-run cost. See `MARKET_POSITIONING_2026-07-03.md` for the current Store-research rationale: lead with low-support B2B API compatibility alerts rather than generic Swagger scraping. ### Output - Dataset rows: one row per checked OpenAPI spec. - `SUMMARY`: checked specs, errors, alerts, severity counts, breaking alerts, and paid-event candidates. - `ALERTS`: baseline and breaking rows. - `SURFACES`: normalized current surface snapshots for future scheduled diffs. - `REPORT`: Markdown digest focused on removed OpenAPI surfaces. ### Monetization Notes Keep the first release free or usage-cost-only. If organic scheduled usage appears, the cleanest PPE candidate is `openapi-breaking-change-diff`: charge only when a prior snapshot exists and the run detects removed paths, operations, operation IDs, or security schemes with buyer-visible severity and summary metadata. Never charge for the first baseline snapshot, unchanged specs, invalid URLs, fetch errors, cosmetic metadata changes, or report generation alone. # Actor input Schema ## `specs` (type: `array`): Public OpenAPI JSON or YAML specs to monitor. ## `previousSurfaces` (type: `array`): Optional prior OpenAPI surface snapshots for local diff testing. ## `snapshotKey` (type: `string`): Key-value-store record used to load and save previous surfaces between scheduled runs. ## `saveSnapshot` (type: `boolean`): Save current surfaces to the key-value store for the next scheduled run. ## `maxSpecs` (type: `integer`): Maximum number of spec URLs to check. ## `timeoutMs` (type: `integer`): Timeout for each spec request. ## Actor input object example ```json { "specs": [ { "url": "https://petstore3.swagger.io/api/v3/openapi.json", "label": "Swagger Petstore" } ], "previousSurfaces": [], "snapshotKey": "OPENAPI_BREAKING_CHANGE_SNAPSHOT", "saveSnapshot": true, "maxSpecs": 5, "timeoutMs": 20000 } ```` # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "specs": [ { "url": "https://petstore3.swagger.io/api/v3/openapi.json", "label": "Swagger Petstore" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("silicon1235/openapi-breaking-change-monitor").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "specs": [{ "url": "https://petstore3.swagger.io/api/v3/openapi.json", "label": "Swagger Petstore", }] } # Run the Actor and wait for it to finish run = client.actor("silicon1235/openapi-breaking-change-monitor").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "specs": [ { "url": "https://petstore3.swagger.io/api/v3/openapi.json", "label": "Swagger Petstore" } ] }' | apify call silicon1235/openapi-breaking-change-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=silicon1235/openapi-breaking-change-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OpenAPI Breaking Change Monitor", "description": "Monitor public OpenAPI specs for removed paths, operations, operation IDs, and security schemes.", "version": "0.1", "x-build-id": "ScyDJPgEjaLYzF8n7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/silicon1235~openapi-breaking-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-silicon1235-openapi-breaking-change-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/silicon1235~openapi-breaking-change-monitor/runs": { "post": { "operationId": "runs-sync-silicon1235-openapi-breaking-change-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/silicon1235~openapi-breaking-change-monitor/run-sync": { "post": { "operationId": "run-sync-silicon1235-openapi-breaking-change-monitor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "specs" ], "properties": { "specs": { "title": "OpenAPI specs", "type": "array", "description": "Public OpenAPI JSON or YAML specs to monitor.", "default": [ { "url": "https://petstore3.swagger.io/api/v3/openapi.json", "label": "Swagger Petstore" } ] }, "previousSurfaces": { "title": "Previous surfaces", "type": "array", "description": "Optional prior OpenAPI surface snapshots for local diff testing.", "default": [] }, "snapshotKey": { "title": "Snapshot key", "type": "string", "description": "Key-value-store record used to load and save previous surfaces between scheduled runs.", "default": "OPENAPI_BREAKING_CHANGE_SNAPSHOT" }, "saveSnapshot": { "title": "Save snapshot", "type": "boolean", "description": "Save current surfaces to the key-value store for the next scheduled run.", "default": true }, "maxSpecs": { "title": "Maximum specs", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of spec URLs to check.", "default": 5 }, "timeoutMs": { "title": "Request timeout", "minimum": 5000, "maximum": 60000, "type": "integer", "description": "Timeout for each spec request.", "default": 20000 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```