{ "openapi": "3.0.1", "info": { "title": "Dataset Contract & Regression Tester", "description": "Test Apify datasets against versioned contracts. Catch missing and extra fields, type and nullability drift, duplicate keys, and breaking schema changes with CI-ready evidence.", "version": "0.1", "x-build-id": "1OqbkWLIbyZGgktnn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gifted_wagon~dataset-contract-tester/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gifted_wagon-dataset-contract-tester", "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/gifted_wagon~dataset-contract-tester/runs": { "post": { "operationId": "runs-sync-gifted_wagon-dataset-contract-tester", "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/gifted_wagon~dataset-contract-tester/run-sync": { "post": { "operationId": "run-sync-gifted_wagon-dataset-contract-tester", "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": { "datasetId": { "title": "Dataset to test", "type": "string", "description": "Optional Apify dataset. Its items are read once up to Maximum items." }, "items": { "title": "Inline items", "type": "array", "description": "JSON objects to test. Inline and dataset items can be combined.", "items": { "type": "object", "additionalProperties": true }, "default": [] }, "contract": { "title": "Current versioned contract", "type": "object", "description": "Optional dataset-contract-v1 object. Define fields with type or types, required, nullable, keyFields, version, and allowExtraFields. Leave empty to infer it.", "additionalProperties": true }, "baselineContract": { "title": "Previous contract", "type": "object", "description": "Optional prior dataset-contract-v1 object used to report field, type, required, nullability, key, and policy changes.", "additionalProperties": true }, "contractName": { "title": "Inferred contract name", "type": "string", "description": "Used only when the current contract is inferred.", "default": "dataset-contract" }, "contractVersion": { "title": "Inferred contract version", "type": "string", "description": "Version attached to an inferred contract.", "default": "1.0.0" }, "keyFields": { "title": "Duplicate key fields", "type": "array", "description": "Top-level fields forming a composite key when the current contract is inferred. If empty, a unique id, _id, url, email, or key may be inferred.", "items": { "type": "string" }, "default": [] }, "allowExtraFields": { "title": "Allow extra fields in inferred contract", "type": "boolean", "description": "If false, fields outside the inferred field set are reported as warnings on later validation input.", "default": true }, "requiredPresenceRatio": { "title": "Required-field inference ratio", "minimum": 0.5, "maximum": 1, "type": "number", "description": "A field observed in at least this fraction of sampled items becomes required. Use 1 for strict inference.", "default": 1 }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard work limit across inline and dataset items. Pay-per-event budget limits can reduce it further.", "default": 500 }, "maxViolationsPerItem": { "title": "Maximum violations per item", "minimum": 1, "maximum": 200, "type": "integer", "description": "Caps evidence output for unusually wide or malformed items.", "default": 50 }, "includeValueEvidence": { "title": "Include redacted value previews", "type": "boolean", "description": "Include at most 120 characters of a mismatched or extra value. Disable for sensitive datasets; duplicate keys are always hashed.", "default": true } } }, "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 } } } } } } } } } }