{ "openapi": "3.0.1", "info": { "title": "Changelog & Release Tracker — Do I Need To Upgrade?", "description": "Track GitHub and npm releases and get told whether to act. Reads the release notes to flag breaking changes, security fixes and deprecations, counts how many versions you are behind, and returns one urgency verdict per project instead of a wall of markdown.", "version": "0.1", "x-build-id": "rfRk61jDyIbRPQVfU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alaudinburki~changelog-release-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alaudinburki-changelog-release-tracker", "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/alaudinburki~changelog-release-tracker/runs": { "post": { "operationId": "runs-sync-alaudinburki-changelog-release-tracker", "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/alaudinburki~changelog-release-tracker/run-sync": { "post": { "operationId": "run-sync-alaudinburki-changelog-release-tracker", "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": { "repositories": { "title": "GitHub repositories", "type": "array", "description": "Repos to track as owner/repo or a github.com URL. Append @ to get an upgrade verdict, e.g. facebook/react@19.0.0.", "items": { "type": "string" } }, "npmPackages": { "title": "npm packages", "type": "array", "description": "npm packages to track. Append @ for a verdict, e.g. axios@1.6.0. Note the npm registry publishes no release notes, so those rows carry version and date only.", "items": { "type": "string" } }, "githubToken": { "title": "GitHub token (optional)", "type": "string", "description": "Without a token the public atom feed is used, which has no rate limit but fewer fields. With one, the REST API is used: richer data and 5,000 requests/hour instead of 60. A read-only token with no scopes is enough." }, "maxReleasesPerProject": { "title": "Releases per project", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many recent releases to fetch for each project.", "default": 20 }, "includePrereleases": { "title": "Include prereleases", "type": "boolean", "description": "Include alpha/beta/rc/canary builds. Off by default — nobody is 'twelve releases behind' because of nightly canaries.", "default": false }, "onlyNewSinceLastRun": { "title": "Only new since last run", "type": "boolean", "description": "Return only releases not seen in a previous run. Turns this into a scheduled watcher: pair it with a webhook and you get notified only when something actually ships.", "default": false }, "includeNotes": { "title": "Include release notes", "type": "boolean", "description": "Include the release-note text on each row.", "default": true }, "notesMaxChars": { "title": "Max note length", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Truncate release notes to this many characters.", "default": 2000 }, "snapshotKey": { "title": "Snapshot key", "type": "string", "description": "Key-value store key holding what was already seen. Use different keys to watch several sets of projects independently.", "default": "SEEN_RELEASES" }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Hard cap on releases returned. You are never charged beyond this.", "default": 2000 } } }, "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 } } } } } } } } } }