{ "openapi": "3.0.1", "info": { "title": "CKAN & Socrata Schema Change Monitor", "description": "Monitor public CKAN and Socrata endpoints for schema drift, freshness, validation failures, and reproducible source receipts.", "version": "0.1", "x-build-id": "8dRPaNbmQmLaF2zm8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mikelmyers~open-data-release-contract-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mikelmyers-open-data-release-contract-monitor", "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/mikelmyers~open-data-release-contract-monitor/runs": { "post": { "operationId": "runs-sync-mikelmyers-open-data-release-contract-monitor", "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/mikelmyers~open-data-release-contract-monitor/run-sync": { "post": { "operationId": "run-sync-mikelmyers-open-data-release-contract-monitor", "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": [ "sources" ], "properties": { "maxRows": { "title": "Maximum observed rows per source", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard-capped at 100 by the Actor.", "default": 100 }, "baselineStoreName": { "title": "Persistent baseline store name", "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$", "minLength": 3, "maxLength": 63, "type": "string", "description": "Named key-value store used to preserve source hashes and schemas across separate runs in this account.", "default": "open-data-contract-baselines" }, "sources": { "title": "Public API sources", "maxItems": 50, "type": "array", "description": "Each item must describe one explicit public CKAN or Socrata endpoint.", "items": { "type": "object", "properties": { "kind": { "title": "Source kind", "description": "CKAN or Socrata public API.", "type": "string", "editor": "select", "enum": [ "ckan", "socrata" ] }, "apiBase": { "title": "CKAN API base", "description": "HTTPS CKAN action API base, required for CKAN sources.", "type": "string", "editor": "textfield" }, "domain": { "title": "Socrata domain", "description": "Public Socrata hostname, required for Socrata sources.", "type": "string", "editor": "textfield" }, "datasetId": { "title": "Dataset ID", "description": "CKAN package ID or Socrata four-by-four dataset identifier.", "type": "string", "editor": "textfield" }, "query": { "title": "Bounded query", "description": "CKAN search text or Socrata query string. The row limit remains capped.", "type": "string", "editor": "textfield" }, "requiredFields": { "title": "Required fields", "description": "Fields that must be populated in every observed row.", "type": "array", "editor": "json", "items": { "type": "string" } }, "keyFields": { "title": "Key fields", "description": "Fields used to detect duplicate records and stabilize hashes.", "type": "array", "editor": "json", "items": { "type": "string" } }, "freshnessField": { "title": "Freshness field", "description": "Optional timestamp field used for staleness checks.", "type": "string", "editor": "textfield" }, "staleAfterHours": { "title": "Stale threshold in hours", "description": "Mark the source stale when the newest observed timestamp is older than this threshold.", "type": "integer", "minimum": 1, "editor": "number" } }, "required": [ "kind" ] }, "default": [ { "kind": "socrata", "domain": "data.cityofnewyork.us", "datasetId": "erm2-nwe9", "requiredFields": [ "unique_key", "created_date" ], "keyFields": [ "unique_key" ], "freshnessField": "created_date", "staleAfterHours": 168, "query": "$order=created_date DESC" } ] } } }, "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 } } } } } } } } } }