{ "openapi": "3.0.1", "info": { "title": "Locale Bundle Contract Gate", "description": "Validate JSON and YAML locale bundles before release. Detect missing keys, plural, interpolation, type, and HTML drift, then export precise paths plus SARIF, JUnit, and Markdown reports for CI.", "version": "0.0", "x-build-id": "OgzYWMyJttqlfeIMm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bread-kim~locale-bundle-contract-gate/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bread-kim-locale-bundle-contract-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/bread-kim~locale-bundle-contract-gate/runs": { "post": { "operationId": "runs-sync-bread-kim-locale-bundle-contract-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/bread-kim~locale-bundle-contract-gate/run-sync": { "post": { "operationId": "run-sync-bread-kim-locale-bundle-contract-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": [ "baseLocale", "messageSyntax", "candidates" ], "properties": { "baseLocale": { "title": "Base locale", "minLength": 2, "maxLength": 35, "type": "string", "description": "Locale identifier for the reference bundle, for example en or en-US.", "default": "en" }, "baseContent": { "title": "Base bundle content", "maxLength": 1048576, "type": "string", "description": "Inline JSON or YAML reference bundle. Provide this or Base URL, but not both. Maximum 1048576 UTF-8 bytes." }, "baseUrl": { "title": "Base bundle URL", "maxLength": 2048, "type": "string", "description": "Public HTTPS URL for the reference bundle. Credentials, private addresses, non-default ports, and unsafe redirects are rejected." }, "baseFormat": { "title": "Base bundle format", "enum": [ "auto", "json", "yaml" ], "type": "string", "description": "Parser for the base bundle. Auto selects JSON when the first non-space character is a brace or bracket; otherwise YAML.", "default": "auto" }, "messageSyntax": { "title": "Message syntax", "enum": [ "plain", "i18next", "icu" ], "type": "string", "description": "Explicit contract mode: plain skips message parsing, i18next checks double-brace interpolation and locale plural suffixes, and ICU parses ICU MessageFormat.", "default": "i18next" }, "candidates": { "title": "Candidate locale bundles", "minItems": 1, "maxItems": 20, "type": "array", "description": "One to twenty translated bundles to compare against the base. Locale identifiers must be unique.", "items": { "type": "object", "required": [ "locale" ], "properties": { "locale": { "title": "Candidate locale", "description": "BCP-47-like locale identifier used for locale-aware plural rules, for example ko, de, or pt-BR.", "type": "string", "editor": "textfield", "minLength": 2, "maxLength": 35 }, "content": { "title": "Candidate bundle content", "description": "Inline JSON or YAML bundle. Provide this or Source URL, but not both. Maximum 1048576 UTF-8 bytes.", "type": "string", "editor": "textarea", "maxLength": 1048576 }, "sourceUrl": { "title": "Candidate source URL", "description": "Public HTTPS URL for this candidate. Runtime validation enforces URL, DNS, redirect, timeout, and byte limits.", "type": "string", "editor": "textfield", "maxLength": 2048 }, "format": { "title": "Candidate bundle format", "description": "Parser for this candidate bundle.", "type": "string", "editor": "select", "enum": [ "auto", "json", "yaml" ], "enumTitles": [ "Auto detect", "JSON", "YAML" ], "default": "auto" } } } }, "detectHtml": { "title": "Check HTML element structure", "type": "boolean", "description": "Compare ordered HTML start/end tag structure inside matching string values.", "default": true }, "maxFindings": { "title": "Maximum returned findings", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Cap detailed findings while retaining authoritative total counts.", "default": 500 }, "failOn": { "title": "Failure behavior", "enum": [ "error", "never" ], "type": "string", "description": "Error exits non-zero after saving reports when contract errors exist; Never always exits successfully.", "default": "error" } } }, "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 } } } } } } } } } }