{ "openapi": "3.0.1", "info": { "title": "Dependency Bot Backlog and Degradation Ledger", "description": "Reads the public dependency dashboard issue of each repository, and reports the declared repository problems, the size of each backlog section, and the change since the last run. One row for each repository, one row for each new problem and each backlog g", "version": "0.1", "x-build-id": "QUDocMyUKFCcNcWc8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kingii98~dependency-bot-backlog-and-degradation-ledger/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kingii98-dependency-bot-backlog-and-degradation-ledger", "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~dependency-bot-backlog-and-degradation-ledger/runs": { "post": { "operationId": "runs-sync-kingii98-dependency-bot-backlog-and-degradation-ledger", "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~dependency-bot-backlog-and-degradation-ledger/run-sync": { "post": { "operationId": "run-sync-kingii98-dependency-bot-backlog-and-degradation-ledger", "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": [ "repositories" ], "properties": { "repositories": { "title": "Repositories", "minItems": 1, "maxItems": 250, "type": "array", "description": "1 to 250 public repositories, as owner/repo or as https://github.com/owner/repo. The Actor searches the open issues of each repository for the dashboard issue, and reads its body. It does not crawl.", "default": [ "snyssen/mother-of-all-infra", "sebastka/homelab", "vrozaksen/home-ops" ], "items": { "type": "string" } }, "dashboardIssueTitle": { "title": "Dashboard issue title filter", "maxLength": 80, "type": "string", "description": "A phrase that the title of the dashboard issue holds. The Actor searches open issues with this phrase in the title, and keeps only an issue whose body reads as a dependency dashboard. Use \"Dependency Dashboard\" for the standard title, or a shorter phrase such as \"Dashboard\" when your bot renames the issue.", "default": "Dashboard" }, "backlogAgeThresholdDays": { "title": "Backlog age threshold (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "A dashboard with no update for more days than this value is reported as stale, which shows that the bot did not serve the repository.", "default": 7 }, "growthThreshold": { "title": "Backlog growth threshold", "minimum": 1, "maximum": 1000, "type": "integer", "description": "The smallest growth of one backlog section, against the stored baseline, that becomes a change event and a charged event.", "default": 1 }, "githubToken": { "title": "GitHub token", "type": "string", "description": "Optional. A read-only GitHub token that you own. Without a token, the Actor uses the anonymous GitHub limit, which other users of the same IP address can share. When GitHub refuses a call, the Actor reports RATE_LIMITED and keeps the baseline. The Actor sends the token only to api.github.com and never writes it to the log or to the dataset." }, "stateStoreName": { "title": "State store name", "maxLength": 63, "type": "string", "description": "The named key-value store that keeps, for each repository, the problem set and the backlog counts of the last run. Runs that use the same name share the baseline. Letters, digits and hyphens.", "default": "dependency-dashboard-ledger-state" }, "timeoutSeconds": { "title": "Request timeout (seconds)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Timeout for one call to the GitHub API.", "default": 20 }, "maxResponseBytes": { "title": "Maximum response bytes", "minimum": 500000, "maximum": 16000000, "type": "integer", "description": "Hard cap on the bytes read from one GitHub API answer. A larger answer is reported as an error for that repository.", "default": 4000000 } } }, "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 } } } } } } } } } }