{ "openapi": "3.0.1", "info": { "title": "OTel Semantic Convention Validator", "description": "Validate OpenTelemetry traces, metrics and logs (OTLP/JSON) against semantic conventions 1.24–1.44: deprecated names, missing required attributes, wrong types, units, high-cardinality names and PII — with auto-fixed telemetry.", "version": "0.1", "x-build-id": "a2k0zQ0NQtp3IqwyW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/michiganpublictech~otel-semconv-validator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-michiganpublictech-otel-semconv-validator", "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/michiganpublictech~otel-semconv-validator/runs": { "post": { "operationId": "runs-sync-michiganpublictech-otel-semconv-validator", "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/michiganpublictech~otel-semconv-validator/run-sync": { "post": { "operationId": "run-sync-michiganpublictech-otel-semconv-validator", "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": { "telemetry": { "title": "Telemetry (OTLP/JSON or simplified)", "type": "object", "description": "An OTLP/JSON export request — {\"resourceSpans\": …}, {\"resourceMetrics\": …}, {\"resourceLogs\": …} or any combination, as written by the OTLP/HTTP JSON exporter or the Collector `file` exporter — or the simplified shape {\"resource\": {\"attributes\": {…}}, \"spans\": [{\"name\", \"kind\", \"attributes\", \"status\"}], \"metrics\": [{\"name\", \"unit\", \"type\", \"attributes\"}], \"logs\": [{\"body\", \"severityText\", \"attributes\"}]}." }, "telemetryBatches": { "title": "Telemetry batches", "type": "array", "description": "Optional list of batches to validate in one run, e.g. one per service: [{\"name\": \"checkout\", \"telemetry\": {…}}, {…raw OTLP/JSON…}]. Each batch is one billed validation." }, "semconvVersion": { "title": "Semantic conventions version", "enum": [ "1.44.0", "1.43.0", "1.42.0", "1.41.0", "1.40.0", "1.39.0", "1.38.0", "1.37.0", "1.36.0", "1.35.0", "1.34.0", "1.33.0", "1.32.0", "1.31.0", "1.30.0", "1.29.0", "1.28.0", "1.27.0", "1.26.0", "1.25.0", "1.24.0" ], "type": "string", "description": "Validate against this semantic-conventions release. Deprecations are version-aware: e.g. db.statement is only reported as deprecated from 1.26.0, deployment.environment from 1.27.0, db.system from 1.30.0, gen_ai.system from 1.37.0, rpc.system and peer.service from 1.39.0. Attributes newer than the selected version are reported too.", "default": "1.44.0" }, "strictness": { "title": "Strictness", "enum": [ "required", "recommended", "strict" ], "type": "string", "description": "required = required/conditionally-required attributes, deprecations, types, units, privacy and structure only. recommended (default) adds recommended attributes, naming style, resource hygiene. strict adds unknown attributes in reserved namespaces and telemetry.sdk.* checks.", "default": "recommended" }, "signals": { "title": "Signals", "type": "array", "description": "Which signals to validate. Default: all present in the payload.", "items": { "type": "string", "enum": [ "traces", "metrics", "logs" ], "enumTitles": [ "Traces", "Metrics", "Logs" ] }, "default": [ "traces", "metrics", "logs" ] }, "ignoreAttributes": { "title": "Ignore attributes", "type": "array", "description": "Attribute names to skip in every check (and leave untouched in the fixed telemetry). Glob patterns allowed, e.g. app.*, com.acme.*, http.request.header.x-*.", "items": { "type": "string" } }, "emitFixedTelemetry": { "title": "Return fixed telemetry", "type": "boolean", "description": "Return a copy of each batch with deterministic fixes applied (deprecated renames, type conversions, HTTP method casing, base64→hex IDs, secret/credential redaction…). Charged as a separate 'fixed-telemetry' event only when at least one change was made.", "default": true }, "minSeverity": { "title": "Minimum severity to report", "enum": [ "info", "low", "medium", "high", "critical" ], "type": "string", "description": "Hide findings below this severity from the output. The compliance score and `valid` flag always consider every finding.", "default": "info" }, "failOnSeverity": { "title": "Fail run at severity", "enum": [ "none", "critical", "high", "medium", "low" ], "type": "string", "description": "Fail the run (non-zero exit, useful in CI) when any finding is at or above this severity.", "default": "none" }, "disabledRules": { "title": "Disabled rules", "type": "array", "description": "Rule IDs to skip, e.g. SEMCONV-NAME-001. Requires a plan with the custom rules feature.", "items": { "type": "string" } }, "licenseKey": { "title": "License key", "type": "string", "description": "Optional enterprise or prepaid license key. Leave empty to pay per event on Apify." } } }, "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 } } } } } } } } } }