OpenAPI Spec Diff Auditor
Pricing
from $9.80 / 1,000 target auditeds
Diff OpenAPI specs for breaking changes, added or removed endpoints, required parameters, response drift, and schema compatibility. by default.
You can access the OpenAPI Spec Diff Auditor programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "nWj3ivbA1OJ8edzkB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~openapi-spec-diff-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-openapi-spec-diff-auditor", "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/junipr~openapi-spec-diff-auditor/runs": { "post": { "operationId": "runs-sync-junipr-openapi-spec-diff-auditor", "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/junipr~openapi-spec-diff-auditor/run-sync": { "post": { "operationId": "run-sync-junipr-openapi-spec-diff-auditor", "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", "properties": { "sourceId": { "title": "Source ID", "type": "string", "description": "Stable label for this OpenAPI specification pair.", "default": "example-billing-api" }, "previousLabel": { "title": "Previous Label", "type": "string", "description": "Label for the older specification.", "default": "previous" }, "currentLabel": { "title": "Current Label", "type": "string", "description": "Label for the newer specification.", "default": "current" }, "previousSpec": { "title": "Previous OpenAPI Spec", "type": "string", "description": "Older OpenAPI document as JSON or simple YAML text. Leave blank only when URL fetch is explicitly enabled.", "default": "{\n \"openapi\": \"3.1.0\",\n \"info\": { \"title\": \"Example Billing API\", \"version\": \"2026-06-01\" },\n \"paths\": {\n \"/v1/customers\": {\n \"get\": {\n \"summary\": \"List customers\",\n \"responses\": {\n \"200\": {\n \"description\": \"Customer list\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\"data\"],\n \"properties\": {\n \"data\": { \"type\": \"array\" },\n \"next_cursor\": { \"type\": \"string\" }\n }\n }\n }\n }\n }\n }\n }\n },\n \"/v1/legacy-invoices\": {\n \"get\": {\n \"deprecated\": true,\n \"responses\": { \"200\": { \"description\": \"Legacy invoice list\" } }\n }\n }\n }\n}" }, "currentSpec": { "title": "Current OpenAPI Spec", "type": "string", "description": "Newer OpenAPI document as JSON or simple YAML text. Leave blank only when URL fetch is explicitly enabled.", "default": "{\n \"openapi\": \"3.1.0\",\n \"info\": { \"title\": \"Example Billing API\", \"version\": \"2026-07-01\" },\n \"paths\": {\n \"/v1/customers\": {\n \"get\": {\n \"summary\": \"List customers\",\n \"parameters\": [\n { \"name\": \"X-API-Version\", \"in\": \"header\", \"required\": true, \"schema\": { \"type\": \"string\" } }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Customer list\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\"data\", \"has_more\"],\n \"properties\": {\n \"data\": { \"type\": \"array\" },\n \"has_more\": { \"type\": \"boolean\" }\n }\n }\n }\n }\n }\n }\n }\n },\n \"/v1/invoices\": {\n \"get\": {\n \"responses\": { \"200\": { \"description\": \"Invoice list\" } }\n }\n }\n }\n}" }, "previousSpecUrl": { "title": "Previous Spec URL", "type": "string", "description": "Optional URL for the older spec. Fetched only when Allow URL Fetch is enabled and previousSpec is blank.", "default": "" }, "currentSpecUrl": { "title": "Current Spec URL", "type": "string", "description": "Optional URL for the newer spec. Fetched only when Allow URL Fetch is enabled and currentSpec is blank.", "default": "" }, "targets": { "title": "Spec Targets", "type": "array", "description": "Optional list of OpenAPI spec pairs. When provided, these override the top-level spec fields.", "items": { "type": "object" }, "default": [] }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 50, "type": "integer", "description": "Alias for Max Targets/Maximum Records used by the Junipr actor baseline. When both are provided, actor-specific limits still apply.", "default": 1 }, "maxTargets": { "title": "Maximum Targets", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum spec pairs to audit in one run.", "default": 1 }, "maxChanges": { "title": "Maximum Changes Per Target", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum structured diff rows emitted per target after sorting by severity.", "default": 100 }, "includeReport": { "title": "Generate Summary Report", "type": "boolean", "description": "Store diff rows, summary JSON, and a Markdown report in the default key-value store.", "default": true }, "allowUrlFetch": { "title": "Allow URL Fetch", "type": "boolean", "description": "Disabled by default. When enabled, the actor may fetch previous/current spec URLs with a strict byte and timeout cap.", "default": false }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "Validate input and write a dry-run summary without PPE charges or dataset output.", "default": false }, "debug": { "title": "Debug Logging", "type": "boolean", "description": "Enable additional logs for spec normalization and diff extraction.", "default": false } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for OpenAPI Spec Diff Auditor from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: