{ "openapi": "3.0.1", "info": { "title": "GitHub Actions Reference Pin and Archived-Action Inventory", "description": "Reads the workflow files of a public repository set and reports every `uses:` reference: mutable tag or branch against commit sha pin, archived, renamed or missing action repositories, the last release date and a risk class. One dataset row for each refer", "version": "0.1", "x-build-id": "7SY7kPAc4Z40dsDAN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kingii98~github-actions-reference-pin-and-archived-action-inventory/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kingii98-github-actions-reference-pin-and-archived-action-inventory", "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~github-actions-reference-pin-and-archived-action-inventory/runs": { "post": { "operationId": "runs-sync-kingii98-github-actions-reference-pin-and-archived-action-inventory", "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~github-actions-reference-pin-and-archived-action-inventory/run-sync": { "post": { "operationId": "run-sync-kingii98-github-actions-reference-pin-and-archived-action-inventory", "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": 200, "type": "array", "description": "1 to 200 public repositories in the form \"owner/repo\". The Actor reads the workflow files of each one and reports every `uses:` reference that they hold.", "default": [ "actions/checkout", "peter-evans/create-pull-request" ], "items": { "type": "string" } }, "branch": { "title": "Branch", "type": "string", "description": "Branch, tag or commit to read the workflow files from. Leave this empty to use the default branch of each repository.", "default": "" }, "trustedOwners": { "title": "Trusted action owners", "type": "array", "description": "Owner accounts whose actions may use a mutable tag, for example \"actions\". A reference to a trusted owner does not fail the pin rule. It still fails the maintenance rule when the action repository is archived, renamed or missing.", "default": [], "items": { "type": "string" } }, "staleReleaseDays": { "title": "Stale release age in days", "minimum": 30, "maximum": 3650, "type": "integer", "description": "An action with no release and no push inside this many days fails the maintenance rule.", "default": 365 }, "maxWorkflowFilesPerRepo": { "title": "Workflow files for each repository", "minimum": 1, "maximum": 50, "type": "integer", "description": "Highest number of workflow files that the Actor reads in one repository. The files are read in name order.", "default": 3 }, "resolveCommitSha": { "title": "Resolve the commit sha", "type": "boolean", "description": "Send one extra API call for each flagged mutable reference to resolve the commit sha that it points to today. Turn this off to spend fewer API calls.", "default": true }, "maxShaResolutions": { "title": "Highest number of sha resolutions", "minimum": 0, "maximum": 500, "type": "integer", "description": "Upper bound on the extra sha resolution calls of one run.", "default": 5 }, "maxReferences": { "title": "Highest number of references", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Upper bound on the reference rows of one run. The run stops to read more workflow files when it reaches this number.", "default": 2000 }, "onlyFlagged": { "title": "Write only the flagged references", "type": "boolean", "description": "Write a dataset row only for a reference that fails the pin rule or the maintenance rule. The summary always counts every reference.", "default": false }, "githubToken": { "title": "GitHub token", "type": "string", "description": "Optional. The Actor reads public repositories without a token. An anonymous caller may send 60 API calls in one hour, which is enough for a few repositories only. A read-only token lifts the limit to 5000 calls in one hour." }, "concurrency": { "title": "Concurrent repositories", "minimum": 1, "maximum": 8, "type": "integer", "description": "Highest number of repositories that the Actor audits at the same time.", "default": 4 }, "requestsPerSecond": { "title": "Requests for each second", "minimum": 1, "maximum": 20, "type": "integer", "description": "Upper bound on the call rate against the GitHub API.", "default": 5 }, "timeoutSeconds": { "title": "Request timeout in seconds", "minimum": 3, "maximum": 60, "type": "integer", "description": "Highest time in seconds that one GitHub API call may take. A call that passes this time is stopped, and the target becomes a reported failure.", "default": 15 }, "maxResponseBytes": { "title": "Highest answer size in bytes", "minimum": 10000, "maximum": 20000000, "type": "integer", "description": "An answer that passes this size is refused, and the target becomes a reported failure.", "default": 2000000 } } }, "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 } } } } } } } } } }