{ "openapi": "3.0.1", "info": { "title": "JSON Content Checker & Validator - API Testing Tool", "description": "Check public JSON API endpoints with structural, JSON Schema, or path-based content rules. Get a dataset row for each readable endpoint with pass or fail status, response time, and actionable findings.", "version": "0.0", "x-build-id": "aXNO5dwTasYQWl1Zx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~api-testing-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-api-testing-tool", "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/maximedupre~api-testing-tool/runs": { "post": { "operationId": "runs-sync-maximedupre-api-testing-tool", "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/maximedupre~api-testing-tool/run-sync": { "post": { "operationId": "run-sync-maximedupre-api-testing-tool", "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": [ "endpoints", "validationMode" ], "properties": { "endpoints": { "title": "JSON API endpoints", "minItems": 1, "type": "array", "description": "Add one or more public HTTP or HTTPS URLs that return JSON. The same validation setup is used for every endpoint.", "items": { "type": "object", "properties": { "url": { "title": "Endpoint URL", "type": "string", "description": "A public HTTP or HTTPS URL that returns a JSON response.", "pattern": "^https?://.+$" } }, "required": [ "url" ], "additionalProperties": false } }, "validationMode": { "title": "Validation checks", "enum": [ "structural", "jsonSchema", "content", "combined" ], "type": "string", "description": "Choose which checks to run. Structural checks look for missing paths, nulls, empty strings, and duplicate array entries. JSON Schema checks compare each response with your schema. Path-based content rules check selected values. Combined checks run structural, JSON Schema, and content checks." }, "validationSettings": { "title": "Validation settings", "type": "object", "description": "Set structural checks and an optional response-time threshold. Required paths, null checks, empty-string checks, and duplicate-entry checks apply in Structural checks and Combined checks. The threshold applies to every choice.", "properties": { "requiredFieldPaths": { "title": "Required field paths", "type": "array", "description": "Add optional dot paths that must be present in each JSON response, such as data.id. This check runs in Structural checks and Combined checks.", "editor": "stringList", "minItems": 1, "items": { "type": "string", "minLength": 1 } }, "checkNullValues": { "title": "Check null values", "type": "boolean", "description": "In Structural checks and Combined checks, flag null values found anywhere in each JSON response.", "editor": "checkbox", "default": true }, "checkEmptyStrings": { "title": "Check empty strings", "type": "boolean", "description": "In Structural checks and Combined checks, flag empty string values found anywhere in each JSON response.", "editor": "checkbox", "default": true }, "checkDuplicateArrayEntries": { "title": "Check duplicate array entries", "type": "boolean", "description": "In Structural checks and Combined checks, flag duplicate entries found within JSON arrays.", "editor": "checkbox", "default": true }, "responseTimeThresholdMs": { "title": "Response time threshold (ms)", "type": "integer", "description": "Set an optional maximum response time in milliseconds. A response above this value gets a threshold finding in every choice.", "minimum": 1, "editor": "number", "prefill": 1000 } }, "default": { "checkNullValues": true, "checkEmptyStrings": true, "checkDuplicateArrayEntries": true }, "additionalProperties": false }, "jsonSchema": { "title": "JSON Schema", "type": "object", "description": "Add a JSON Schema when you choose JSON Schema checks or Combined checks. Other choices ignore this field. Example: {\"type\":\"object\",\"required\":[\"id\"]}." }, "contentRules": { "title": "Path-based content rules", "type": "array", "description": "Add one or more rules when you choose Path-based content rules or Combined checks. Each rule has a response path, a condition, and a JSON value written as text. Other choices ignore this field.", "items": { "type": "object", "properties": { "path": { "title": "Response path", "type": "string", "description": "A dot path in the JSON response, such as data.status.", "minLength": 1 }, "operator": { "title": "Condition", "type": "string", "description": "The condition to apply to the value at the response path.", "editor": "select", "enum": [ "equals", "notEquals", "contains", "notContains", "greaterThan", "lessThan" ], "enumTitles": [ "Equals", "Does not equal", "Contains", "Does not contain", "Greater than", "Less than" ] }, "expectedValue": { "title": "Expected value", "type": "string", "description": "Enter one JSON value as text to compare with the value at the response path. Use \"active\" for a string or 200 for a number.", "editor": "textarea" } }, "required": [ "path", "operator", "expectedValue" ], "additionalProperties": 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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }