# API Changelog Generator - Breaking Changes & API Diff Detection (`imapp/api-changelog-generator`) Actor Detect breaking changes in your API automatically. Compare OpenAPI specs or Git commits to generate structured changelogs. Subscribe to webhook notifications for breaking change alerts. - **URL**: https://apify.com/imapp/api-changelog-generator.md - **Developed by:** [INAPP](https://apify.com/imapp) (community) - **Categories:** Developer tools - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 1 bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 api calls This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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 ## API Changelog Generator Detect breaking changes in your API before your users do. API Changelog Generator compares OpenAPI specifications or Git commits to automatically generate structured changelogs with severity levels (major/minor/patch). Subscribe to webhook notifications for breaking change alerts. ### Why use API Changelog Generator? Stop manually tracking API changes. This Actor monitors your API specifications and Git repositories to detect breaking changes automatically — removed endpoints, modified parameters, deprecated features. Get instant notifications via webhook when something breaks. ### What data does API Changelog Generator return? Structured diffs with three severity levels: - **MAJING** — Breaking changes (removed endpoints, removed required parameters) - **MINOR** — Non-breaking modifications (changed descriptions, optional params) - **PATCH** — No significant changes detected Each result includes: - Endpoint path and method - Change type (added / removed / modified) - Breaking status (true/false) - Detailed description - Full change details (added/removed parameters) ### How to use API Changelog Generator #### Compare OpenAPI specs ```bash curl -X POST https://imapp--api-changelog-generator.apify.actor/changelogs/generate/openapi \ -H "Authorization: Bearer YOUR_APIFY_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "base_spec_url": "https://api.example.com/openapi-v1.json", "new_spec": { "openapi": "3.0.0", "info": {"title": "My API", "version": "2.0"}, "paths": { "/users": {"get": {"summary": "List users"}}, "/users/{id}": {"get": {"summary": "Get user"}} } } }' ```` #### Compare Git commits ```bash curl -X POST https://imapp--api-changelog-generator.apify.actor/changelogs/generate/git \ -H "Authorization: Bearer YOUR_APIFY_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "repository_url": "org/api-repo", "base_commit": "v1.0.0", "target_commit": "HEAD" }' ``` #### Subscribe to breaking change notifications ```bash curl -X POST https://imapp--api-changelog-generator.apify.actor/subscriptions \ -H "Authorization: Bearer YOUR_APIFY_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "webhook_url": "https://your-app.com/webhooks/changelog", "event_types": ["breaking_change"] }' ``` #### Manage subscriptions ```bash ## Get subscription details curl -H "Authorization: Bearer YOUR_APIFY_TOKEN" \ https://imapp--api-changelog-generator.apify.actor/subscriptions/{id} ## Delete subscription curl -X DELETE -H "Authorization: Bearer YOUR_APIFY_TOKEN" \ https://imapp--api-changelog-generator.apify.actor/subscriptions/{id} ``` ### How much does it cost? **$3.00 per 1,000 calls** with **100 free calls per month**. Pay only for what you use. No monthly fees, no minimums. ### Input and output #### Input | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `new_spec` | object | Yes (for OpenAPI) | New OpenAPI specification | | `base_spec_url` | string | No | URL to fetch previous spec for diff | | `repository_url` | string | Yes (for Git) | Git repository path | | `base_commit` | string | Yes (for Git) | Starting commit/tag | | `target_commit` | string | No | Ending commit (default: HEAD) | #### Output JSON array of ChangelogEntry objects: ```json [{ "version": "3.0.0", "date": "2026-07-09T16:08:25", "severity_level": "minor", "changes": [ { "endpoint": "GET /users", "change_type": "added", "description": "New endpoint 'GET /users' has been added.", "breaking": false, "details": {} } ], "summary": "Detected 2 changes. Non-breaking." }] ``` ### Features - **Breaking change detection** — Automatically identify removed endpoints and parameters - **OpenAPI spec diffing** — Compare any two OpenAPI 3.0 specifications - **Git commit comparison** — Track changes between repository tags/commits - **Webhook notifications** — Subscribe to breaking change alerts - **Structured severity levels** — MAJOR/MINOR/PATCH classification - **Pay-per-use pricing** — Only pay for what you use - **Standby Mode** — Instant response, no cold starts ### FAQ **Is there a free tier?** Yes, 100 free calls per month. **What OpenAPI versions are supported?** OpenAPI 3.0+ (JSON and YAML formats). **Can I monitor private Git repositories?** Yes, provide a GitHub token via the Authorization header for private repos. **How are breaking changes detected?** Removed endpoints and removed required parameters are flagged as breaking. Added endpoints and optional parameters are non-breaking. **Do I need to host anything?** No. This is a fully managed serverless API on the Apify platform. # Actor input Schema ## `apiKeysJson` (type: `string`): JSON object mapping API keys to tiers or versions ## `logLevel` (type: `string`): Logging verbosity level ## `httpTimeout` (type: `integer`): Maximum time in seconds to wait for HTTP requests ## `defaultRps` (type: `integer`): Rate limiting for API calls per second ## `defaultMonthlyCalls` (type: `integer`): Maximum API calls allowed per month ## `changelogFormat` (type: `string`): Output format for changelog (markdown or json) ## Actor input object example ```json { "apiKeysJson": "{}", "logLevel": "info", "httpTimeout": 30, "defaultRps": 10, "defaultMonthlyCalls": 50000, "changelogFormat": "markdown" } ``` # 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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("imapp/api-changelog-generator").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 = {} # Run the Actor and wait for it to finish run = client.actor("imapp/api-changelog-generator").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 '{}' | apify call imapp/api-changelog-generator --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=imapp/api-changelog-generator", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "API Changelog Generator - Breaking Changes & API Diff Detection", "description": "Detect breaking changes in your API automatically. Compare OpenAPI specs or Git commits to generate structured changelogs. Subscribe to webhook notifications for breaking change alerts.", "version": "0.1", "x-build-id": "KIALWELmteUY4M5Gu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/imapp~api-changelog-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-imapp-api-changelog-generator", "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/imapp~api-changelog-generator/runs": { "post": { "operationId": "runs-sync-imapp-api-changelog-generator", "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/imapp~api-changelog-generator/run-sync": { "post": { "operationId": "run-sync-imapp-api-changelog-generator", "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": [ "apiKeysJson", "logLevel", "httpTimeout", "defaultRps", "defaultMonthlyCalls" ], "properties": { "apiKeysJson": { "title": "API Keys JSON", "type": "string", "description": "JSON object mapping API keys to tiers or versions", "default": "{}" }, "logLevel": { "title": "Log Level", "enum": [ "debug", "info", "warning", "error" ], "type": "string", "description": "Logging verbosity level", "default": "info" }, "httpTimeout": { "title": "HTTP Timeout", "minimum": 1, "maximum": 600, "type": "integer", "description": "Maximum time in seconds to wait for HTTP requests", "default": 30 }, "defaultRps": { "title": "Default Requests Per Second", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Rate limiting for API calls per second", "default": 10 }, "defaultMonthlyCalls": { "title": "Default Monthly Calls", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum API calls allowed per month", "default": 50000 }, "changelogFormat": { "title": "Changelog Format", "enum": [ "markdown", "json" ], "type": "string", "description": "Output format for changelog (markdown or json)", "default": "markdown" } } }, "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 } } } } } } } } } } ```