{ "openapi": "3.0.1", "info": { "title": "Release Channel Resolution Safety and Withdrawn-Artifact Watch", "description": "Resolve each declared range or channel tag the way a package manager does, and report when the resolved version is withdrawn, holds no live file, or moved to another version since the last run. One row for each target, with the resolved version, the rule ", "version": "0.1", "x-build-id": "cmuP4Kkx9kxsPdpxF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kingii98~release-channel-resolution-safety-and-withdrawn-artifact-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kingii98-release-channel-resolution-safety-and-withdrawn-artifact-watch", "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/kingii98~release-channel-resolution-safety-and-withdrawn-artifact-watch/runs": { "post": { "operationId": "runs-sync-kingii98-release-channel-resolution-safety-and-withdrawn-artifact-watch", "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/kingii98~release-channel-resolution-safety-and-withdrawn-artifact-watch/run-sync": { "post": { "operationId": "run-sync-kingii98-release-channel-resolution-safety-and-withdrawn-artifact-watch", "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": [ "targets" ], "properties": { "targets": { "title": "Resolution targets", "minItems": 1, "maxItems": 300, "type": "array", "description": "1 to 300 resolution targets, each one in the form ecosystem:name@range_or_tag, for example npm:express@^4.0.0, npm:react@next, pypi:requests@>=2.31,<3 or cargo:serde@^1.0. Supported ecosystems: npm, pypi and cargo (crates.io). A target with no range or tag takes the latest tag. One entry may hold several lines. An entry this Actor cannot read gets its own row with the invalid_target verdict; it does not stop the run.", "default": [ "npm:express@^4.0.0", "npm:request@latest", "pypi:requests@>=2.31,<3", "cargo:serde@^1.0" ], "items": { "type": "string" } }, "includePrerelease": { "title": "Include prereleases", "type": "boolean", "description": "Repeat here the resolver setting that your consumers use. When it is off, a prerelease, for example 4.2.0a1 or 5.0.0-beta.1, is no candidate for a range. A channel tag always names the version that the registry states, because the registry, and not the version order, decides where a tag points.", "default": false }, "failOn": { "title": "Conditions that make a target unsafe", "type": "array", "description": "A resolved version that holds one of these conditions gets the unsafe verdict. A condition that is found but is not named here gives the degraded verdict, so you see the finding either way. An empty list reports every condition without an unsafe verdict. Note that a channel tag moves whenever the publisher releases, so tag_retargeted reports every move of a tag, which is what a channel watch shows.", "items": { "type": "string", "enum": [ "withdrawn", "no_live_files", "tag_retargeted" ], "enumTitles": [ "withdrawn (yanked or deprecated)", "no_live_files (no file left for the resolved version)", "tag_retargeted (the tag points to another version than in the last run)" ] }, "default": [ "withdrawn", "no_live_files", "tag_retargeted" ] }, "stateStoreName": { "title": "State store name", "type": "string", "description": "The name of the named key-value store that holds the last resolved version of each target. Use one name for each watched target list, so that two schedules do not overwrite each other. Letters, digits and hyphens only, at most 63 characters. The first run of a target writes the snapshot and reports no retarget.", "default": "release-channel-resolution-state" }, "requestTimeoutSeconds": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for each registry request. One package needs one request, so the whole run takes at most this value times the number of packages divided by the concurrency.", "default": 30 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "The largest number of packages read at the same time. A public registry refuses a burst, so a small number is safer.", "default": 4 } } }, "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 } } } } } } } } } }