# OpenAPI Change Monitor (`prophed/openapi-change-monitor`) Actor Monitor OpenAPI JSON/YAML specifications and output structured breaking/non-breaking API change records. - **URL**: https://apify.com/prophed/openapi-change-monitor.md - **Developed by:** [Prophed Com](https://apify.com/prophed) (community) - **Categories:** Developer tools - **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 Change Monitor Monitor public OpenAPI JSON/YAML specifications and receive structured change records in an Apify dataset. ### Why use it API consumers, integration teams, developer-tool vendors, and automation teams need early warning when an API surface changes. This Actor turns OpenAPI specs into scheduled, dataset-friendly change records that can feed alerts, QA checks, dashboards, and integration maintenance workflows. ### What it detects - Added operations - Removed operations - Changed operations - Added required parameters - Removed response codes - Request content-type changes - Fetch and parse errors - Optional unchanged/baseline rows ### Input ```json { "specs": [ { "name": "APIs.guru", "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json" } ], "includeUnchanged": false, "storeBaseline": true, "compareKeyPrefix": "openapi-change-monitor", "maxSpecs": 25 } ```` ### Output Each dataset item is one finding: ```json { "specName": "Example API", "specUrl": "https://example.com/openapi.json", "changeType": "changed", "severity": "breaking", "method": "GET", "path": "/users", "operationId": "listUsers", "details": { "addedRequiredParameters": ["query:tenant"], "removedResponses": ["200"], "requestContentTypesChanged": false }, "detectedAt": "2026-07-05T00:00:00.000Z" } ``` ### Typical workflows - Schedule a daily run for public partner APIs. - Send breaking-change rows to Slack, email, Zapier, Make, or a webhook. - Keep a baseline in the Actor key-value store and compare each new run against it. - Monitor multiple specs in one batch while keeping `maxSpecs` capped for cost control. ### Notes This Actor only processes spec URLs supplied by the user. Users are responsible for permission to monitor any private or non-public specification URL they provide. # Actor input Schema ## `specs` (type: `array`): Public OpenAPI JSON/YAML URLs to monitor. ## `compareKeyPrefix` (type: `string`): Prefix used for persistent baseline storage in the Actor key-value store. ## `includeUnchanged` (type: `boolean`): Emit one dataset row for specs that did not change. ## `storeBaseline` (type: `boolean`): Persist the latest operation fingerprint baseline after each successful fetch. ## `maxSpecs` (type: `integer`): Hard cap to control runtime cost. ## Actor input object example ```json { "specs": [ { "name": "Example API", "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json" } ], "compareKeyPrefix": "openapi-change-monitor", "includeUnchanged": false, "storeBaseline": true, "maxSpecs": 25 } ``` # Actor output Schema ## `results` (type: `string`): No description ## `summary` (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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "specs": [ { "name": "Example API", "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("prophed/openapi-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": [{ "name": "Example API", "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json", }] } # Run the Actor and wait for it to finish run = client.actor("prophed/openapi-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": [ { "name": "Example API", "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json" } ] }' | apify call prophed/openapi-change-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=prophed/openapi-change-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OpenAPI Change Monitor", "description": "Monitor OpenAPI JSON/YAML specifications and output structured breaking/non-breaking API change records.", "version": "0.1", "x-build-id": "S4G0fHj3OB49uXDi1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/prophed~openapi-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-prophed-openapi-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/prophed~openapi-change-monitor/runs": { "post": { "operationId": "runs-sync-prophed-openapi-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/prophed~openapi-change-monitor/run-sync": { "post": { "operationId": "run-sync-prophed-openapi-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/YAML URLs to monitor." }, "compareKeyPrefix": { "title": "Baseline key prefix", "type": "string", "description": "Prefix used for persistent baseline storage in the Actor key-value store.", "default": "openapi-change-monitor" }, "includeUnchanged": { "title": "Include unchanged specs", "type": "boolean", "description": "Emit one dataset row for specs that did not change.", "default": false }, "storeBaseline": { "title": "Store baseline", "type": "boolean", "description": "Persist the latest operation fingerprint baseline after each successful fetch.", "default": true }, "maxSpecs": { "title": "Max specs", "minimum": 1, "maximum": 250, "type": "integer", "description": "Hard cap to control runtime cost.", "default": 25 } } }, "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 } } } } } } } } } } ```