{ "openapi": "3.0.1", "info": { "title": "SpecBreak Monitor", "description": "Detect breaking changes in OpenAPI 3.x specs. Create baselines, compare scheduled checks, and receive structured evidence with severity, JSON Pointer, before/after values, SHA-256 provenance, datasets, and optional webhooks.", "version": "0.0", "x-build-id": "9CjerqASK1aAbcjYd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rayanna~my-actor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rayanna-my-actor", "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/rayanna~my-actor/runs": { "post": { "operationId": "runs-sync-rayanna-my-actor", "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/rayanna~my-actor/run-sync": { "post": { "operationId": "run-sync-rayanna-my-actor", "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", "minItems": 1, "maxItems": 20, "type": "array", "description": "Up to 20 items. Each item needs a name and either an HTTPS url or inline spec object.", "items": { "type": "object", "properties": { "name": { "title": "Name", "description": "Stable display name for this monitored API.", "type": "string", "editor": "textfield", "minLength": 1, "maxLength": 120 }, "url": { "title": "OpenAPI URL", "description": "Public HTTPS URL. Omit only when supplying an inline spec in JSON view.", "type": "string", "editor": "textfield" }, "spec": { "title": "Inline OpenAPI object", "description": "Optional inline OpenAPI object for private or generated contracts.", "type": "object", "editor": "json" } }, "required": [ "name" ], "additionalProperties": false } }, "updateBaseline": { "title": "Update baseline after every successful check", "type": "boolean", "description": "Recommended for scheduled monitoring so an alert is emitted once per new document version.", "default": true }, "failOnBreaking": { "title": "Fail the run when breaking changes are found", "type": "boolean", "description": "Useful as a release gate. Results are still saved before the run fails.", "default": false }, "webhookUrl": { "title": "Optional change webhook", "type": "string", "description": "HTTPS endpoint called only when a document changed. Store sensitive URLs in a private Task input." }, "baselineStoreName": { "title": "Baseline store name", "type": "string", "description": "Named Apify key-value store used across runs.", "default": "specbreak-baselines" }, "allowHttp": { "title": "Allow non-TLS HTTP spec URLs", "type": "boolean", "description": "Applies only to OpenAPI spec URLs. Disabled by default; webhooks always require HTTPS.", "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 } } } } } } } } } }