{ "openapi": "3.0.1", "info": { "title": "OpenAPI Consumer Breakage Gate", "description": "Compare OpenAPI 3.x contracts with versioned consumer profiles, checked waivers, stable findings, SARIF, JUnit, JSON, and Markdown evidence.", "version": "0.1", "x-build-id": "fm9dBDAUvg6rwbcfx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ceddl~openapi-consumer-breakage-gate/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ceddl-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/ceddl~openapi-consumer-breakage-gate/runs": { "post": { "operationId": "runs-sync-ceddl-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/ceddl~openapi-consumer-breakage-gate/run-sync": { "post": { "operationId": "run-sync-ceddl-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": [ "baseline", "revision", "consumerProfile", "evaluationDate" ], "properties": { "baseline": { "title": "Baseline OpenAPI specification", "type": "object", "description": "Earlier contract supplied inline or through a public HTTPS URL.", "properties": { "content": { "title": "OpenAPI content", "description": "Inline OpenAPI document object.", "type": "object", "editor": "json" }, "url": { "title": "OpenAPI URL", "description": "Credential-free public HTTPS URL for the root specification.", "type": "string" } }, "additionalProperties": false }, "revision": { "title": "Revision OpenAPI specification", "type": "object", "description": "Proposed contract supplied inline or through a public HTTPS URL.", "properties": { "content": { "title": "OpenAPI content", "description": "Inline OpenAPI document object.", "type": "object", "editor": "json" }, "url": { "title": "OpenAPI URL", "description": "Credential-free public HTTPS URL for the root specification.", "type": "string" } }, "additionalProperties": false }, "consumerProfile": { "title": "Consumer profile", "required": [ "id", "version" ], "type": "object", "description": "Versioned consumer policy used to classify engine findings.", "properties": { "id": { "title": "Profile ID", "description": "Stable identifier for the consuming application or integration.", "type": "string", "minLength": 1, "maxLength": 80 }, "version": { "title": "Profile version", "description": "Explicit version of the consumer policy.", "type": "string", "minLength": 1, "maxLength": 40 }, "minimumLevel": { "title": "Minimum finding level", "description": "Lowest oasdiff level included for this consumer.", "type": "string", "enum": [ "INFO", "WARN", "ERR" ], "default": "WARN" }, "severityOverrides": { "title": "Rule severity overrides", "description": "Map oasdiff rule IDs to consumer-specific levels.", "type": "object", "editor": "json", "additionalProperties": true } }, "additionalProperties": false }, "waivers": { "title": "Finding waivers", "maxItems": 1000, "type": "array", "description": "Explicit fingerprint waivers with reviewed reasons and optional expiration dates.", "items": { "type": "object", "required": [ "fingerprint", "reason" ], "additionalProperties": false, "properties": { "fingerprint": { "title": "Finding fingerprint", "description": "Stable fingerprint of the finding to waive.", "type": "string", "minLength": 8, "maxLength": 128 }, "reason": { "title": "Waiver reason", "description": "Reviewed reason for accepting this finding.", "type": "string", "minLength": 1, "maxLength": 500 }, "expiresOn": { "title": "Expiration date", "description": "Optional final date on which the waiver remains active.", "type": "string" } } } }, "evaluationDate": { "title": "Waiver evaluation date", "type": "string", "description": "Explicit ISO date used to evaluate waiver expiration deterministically." }, "maxSpecBytes": { "title": "Maximum bytes per specification", "minimum": 1024, "maximum": 10000000, "type": "integer", "description": "Reject either root specification when it exceeds this UTF-8 byte limit.", "default": 2000000 }, "maxFindings": { "title": "Maximum findings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Fail closed when the engine produces more findings than this bound.", "default": 2000 }, "engineTimeoutSecs": { "title": "Engine timeout", "minimum": 1, "maximum": 120, "type": "integer", "description": "Maximum seconds allowed for the pinned diff engine process.", "default": 30 } } }, "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 } } } } } } } } } }