# OpenAPI Consumer Breakage Gate (`quietrelay/openapi-consumer-breakage-gate`) Actor Catch consumer-breaking OpenAPI changes before release. Compare HTTPS OpenAPI 3.0/3.1 specs to a baseline and export Dataset findings, SUMMARY, SARIF, and JUnit for CI or schedules. - **URL**: https://apify.com/quietrelay/openapi-consumer-breakage-gate.md - **Developed by:** [quiet relay](https://apify.com/quietrelay) (community) - **Categories:** Developer tools, AI - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.05 / openapi comparison completed This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. 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/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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 Consumer Breakage Gate Catch **consumer-breaking OpenAPI changes** before they ship. Compare a live HTTPS OpenAPI **3.0/3.1** specification against a stored baseline (or an explicit baseline URL) and get actionable findings for CI, release gates, or scheduled monitoring. ### What you get - Deterministic findings for removed operations, newly required inputs, response contract removals, enum removals, incompatible types, and narrowed bounds - Apify **Dataset** rows for each finding - Key-value artifacts: `SUMMARY`, `SARIF`, and `JUnit` - Named baselines that persist across scheduled runs ### Safe defaults - Only **HTTPS** URLs you supply are fetched - No credentials in v1 - External `$ref` origins default to the specification origin - Failed downloads and invalid specs fail clearly and do **not** overwrite a baseline - Store default input uses the public Petstore demo so daily health checks stay green ### Baseline modes | Mode | Behavior | |---|---| | `auto` | Create the first baseline for a `monitorId`, then compare on later runs without overwriting | | `compareOnly` | Compare only; error if no baseline exists | | `accept` | Write reports, then replace the stored baseline | If `monitorId` is omitted in `auto` mode, a stable id is derived from the specification URL. ### Pricing Pay per event: - **OpenAPI comparison completed** — charged once after successful report artifacts are written - Failed input/fetch/baseline-missing runs are not charged for the comparison event ### Authorization Only analyze specifications you own or are authorized to access. Automated findings are compatibility signals, not legal or security certification. ### Support Built by **Quiet Relay**. Issues and feedback welcome on the Actor Issues tab. # Actor input Schema ## `specUrl` (type: `string`): Required HTTPS JSON/YAML OpenAPI 3.0/3.1 document. ## `baselineMode` (type: `string`): Create the first baseline, explicitly accept a new one, or only compare. ## `monitorId` (type: `string`): Stable named baseline identifier. Defaults from the specification URL in auto mode. ## `baselineSpecUrl` (type: `string`): HTTPS baseline for an explicit one-off comparison. ## `allowedReferenceOrigins` (type: `array`): HTTPS origins permitted for external $ref; defaults to the specification origin. ## `operationAllowlist` (type: `array`): Optional METHOD /path consumer operation filter. ## `severityPolicy` (type: `string`): Use strict mode to surface unsupported structural changes as warnings. ## `failOnSeverity` (type: `string`): The highest finding severity that should fail a CI-oriented comparison. ## `requestTimeoutSecs` (type: `integer`): Maximum HTTPS specification request time. ## Actor input object example ```json { "specUrl": "https://petstore3.swagger.io/api/v3/openapi.json", "baselineMode": "auto", "monitorId": "petstore-v3-demo", "severityPolicy": "default", "failOnSeverity": "error", "requestTimeoutSecs": 20 } ```` # Actor output Schema ## `findings` (type: `string`): Individual deterministic consumer-breaking findings. ## `summary` (type: `string`): Finding counts, source provenance, hashes, and CI failure decision. ## `sarif` (type: `string`): SARIF 2.1.0 report for code-scanning and CI consumers. ## `junit` (type: `string`): JUnit XML report for build pipelines. # 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 = { "specUrl": "https://petstore3.swagger.io/api/v3/openapi.json", "monitorId": "petstore-v3-demo" }; // Run the Actor and wait for it to finish const run = await client.actor("quietrelay/openapi-consumer-breakage-gate").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 = { "specUrl": "https://petstore3.swagger.io/api/v3/openapi.json", "monitorId": "petstore-v3-demo", } # Run the Actor and wait for it to finish run = client.actor("quietrelay/openapi-consumer-breakage-gate").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 '{ "specUrl": "https://petstore3.swagger.io/api/v3/openapi.json", "monitorId": "petstore-v3-demo" }' | apify call quietrelay/openapi-consumer-breakage-gate --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=quietrelay/openapi-consumer-breakage-gate", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OpenAPI Consumer Breakage Gate", "description": "Catch consumer-breaking OpenAPI changes before release. Compare HTTPS OpenAPI 3.0/3.1 specs to a baseline and export Dataset findings, SUMMARY, SARIF, and JUnit for CI or schedules.", "version": "0.1", "x-build-id": "Q2deJwb5fhunJqzA2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quietrelay~openapi-consumer-breakage-gate/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quietrelay-openapi-consumer-breakage-gate", "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/quietrelay~openapi-consumer-breakage-gate/runs": { "post": { "operationId": "runs-sync-quietrelay-openapi-consumer-breakage-gate", "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/quietrelay~openapi-consumer-breakage-gate/run-sync": { "post": { "operationId": "run-sync-quietrelay-openapi-consumer-breakage-gate", "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": [ "specUrl" ], "properties": { "specUrl": { "title": "Current specification URL", "pattern": "^https://", "type": "string", "description": "Required HTTPS JSON/YAML OpenAPI 3.0/3.1 document.", "default": "https://petstore3.swagger.io/api/v3/openapi.json" }, "baselineMode": { "title": "Baseline mode", "enum": [ "auto", "accept", "compareOnly" ], "type": "string", "description": "Create the first baseline, explicitly accept a new one, or only compare.", "default": "auto" }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Stable named baseline identifier. Defaults from the specification URL in auto mode." }, "baselineSpecUrl": { "title": "Explicit baseline URL", "pattern": "^https://", "type": "string", "description": "HTTPS baseline for an explicit one-off comparison." }, "allowedReferenceOrigins": { "title": "Allowed external reference origins", "type": "array", "description": "HTTPS origins permitted for external $ref; defaults to the specification origin.", "items": { "type": "string" } }, "operationAllowlist": { "title": "Consumer operation allowlist", "type": "array", "description": "Optional METHOD /path consumer operation filter.", "items": { "type": "string" } }, "severityPolicy": { "title": "Severity policy", "enum": [ "default", "strict" ], "type": "string", "description": "Use strict mode to surface unsupported structural changes as warnings.", "default": "default" }, "failOnSeverity": { "title": "Failure threshold", "enum": [ "error", "warning", "none" ], "type": "string", "description": "The highest finding severity that should fail a CI-oriented comparison.", "default": "error" }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Maximum HTTPS specification request time.", "default": 20 } } }, "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 } } } } } } } } } } ```