diff --git a/cache/api.github.com.json b/cache/api.github.com.json index be2900b58..f1e1a22ae 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "5.7.0", + "version": "5.8.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -13846,7 +13846,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -13897,7 +13898,8 @@ "parameters": [ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, - { "$ref": "#/components/parameters/run-id" } + { "$ref": "#/components/parameters/run-id" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -14095,7 +14097,8 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/run-id" }, - { "$ref": "#/components/parameters/attempt-number" } + { "$ref": "#/components/parameters/attempt-number" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -14947,7 +14950,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -74993,6 +74997,13 @@ "required": false, "schema": { "type": "string", "format": "date-time" } }, + "exclude-pull-requests": { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "query", + "required": false, + "schema": { "type": "boolean", "default": false } + }, "run-id": { "name": "run_id", "description": "The id of the workflow run.", diff --git a/cache/ghes-3.0.json b/cache/ghes-3.0.json index 20d384343..16d64bcb3 100644 --- a/cache/ghes-3.0.json +++ b/cache/ghes-3.0.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "5.7.0", + "version": "5.8.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -4525,7 +4525,7 @@ "/enterprises/{enterprise}/actions/runner-groups": { "get": { "summary": "List self-hosted runner groups for an enterprise", - "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4575,7 +4575,7 @@ }, "post": { "summary": "Create a self-hosted runner group for an enterprise", - "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4657,7 +4657,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { "get": { "summary": "Get a self-hosted runner group for an enterprise", - "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4696,7 +4696,7 @@ }, "patch": { "summary": "Update a self-hosted runner group for an enterprise", - "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4760,7 +4760,7 @@ }, "delete": { "summary": "Delete a self-hosted runner group from an enterprise", - "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4785,7 +4785,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { "get": { "summary": "List organization access to a self-hosted runner group in an enterprise", - "description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4836,7 +4836,7 @@ }, "put": { "summary": "Set organization access for a self-hosted runner group in an enterprise", - "description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4883,7 +4883,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { "put": { "summary": "Add organization access to a self-hosted runner group in an enterprise", - "description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4907,7 +4907,7 @@ }, "delete": { "summary": "Remove organization access to a self-hosted runner group in an enterprise", - "description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4933,7 +4933,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { "get": { "summary": "List self-hosted runners in a group for an enterprise", - "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4983,7 +4983,7 @@ }, "put": { "summary": "Set self-hosted runners in a group for an enterprise", - "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5030,7 +5030,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { "put": { "summary": "Add a self-hosted runner to a group for an enterprise", - "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5054,7 +5054,7 @@ }, "delete": { "summary": "Remove a self-hosted runner from a group for an enterprise", - "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5080,7 +5080,7 @@ "/enterprises/{enterprise}/actions/runners": { "get": { "summary": "List self-hosted runners for an enterprise", - "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5130,7 +5130,7 @@ "/enterprises/{enterprise}/actions/runners/downloads": { "get": { "summary": "List runner applications for an enterprise", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-runner-applications-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5169,7 +5169,7 @@ "/enterprises/{enterprise}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for an enterprise", - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```", "operationId": "enterprise-admin/create-registration-token-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5207,7 +5207,7 @@ "/enterprises/{enterprise}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for an enterprise", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", "operationId": "enterprise-admin/create-remove-token-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5245,7 +5245,7 @@ "/enterprises/{enterprise}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for an enterprise", - "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5280,7 +5280,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from an enterprise", - "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5511,7 +5511,7 @@ "category": "gists", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } } } }, "/gists/public": { @@ -5724,7 +5724,7 @@ "category": "gists", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } } }, "delete": { "summary": "Delete a gist", @@ -14484,7 +14484,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -14535,7 +14536,8 @@ "parameters": [ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, - { "$ref": "#/components/parameters/run-id" } + { "$ref": "#/components/parameters/run-id" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -15273,7 +15275,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -26250,7 +26253,7 @@ "category": "pulls", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/pulls/comments": { @@ -26759,7 +26762,7 @@ "category": "pulls", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { @@ -27373,7 +27376,7 @@ "category": "pulls", "subcategory": "review-requests" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } } }, "delete": { "summary": "Remove requested reviewers from a pull request", @@ -32532,7 +32535,7 @@ "category": "users", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } } } }, "/user/emails": { @@ -36194,6 +36197,13 @@ "required": false, "schema": { "type": "string", "format": "date-time" } }, + "exclude-pull-requests": { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "query", + "required": false, + "schema": { "type": "boolean", "default": false } + }, "run-id": { "name": "run_id", "description": "The id of the workflow run.", diff --git a/cache/ghes-3.1.json b/cache/ghes-3.1.json index 51b4403d9..bb32d9816 100644 --- a/cache/ghes-3.1.json +++ b/cache/ghes-3.1.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "5.7.0", + "version": "5.8.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -2123,7 +2123,7 @@ "category": "enterprise-admin", "subcategory": "users" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Delete an impersonation OAuth token", @@ -2520,7 +2520,7 @@ "category": "apps", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/app/installations/{installation_id}/suspended": { @@ -2823,7 +2823,7 @@ "category": "apps", "subcategory": "oauth-applications" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "patch": { "summary": "Reset a token", @@ -2875,7 +2875,7 @@ "category": "apps", "subcategory": "oauth-applications" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Delete an app token", @@ -2998,7 +2998,7 @@ "category": "apps", "subcategory": "oauth-applications" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/applications/{client_id}/tokens/{access_token}": { @@ -3083,7 +3083,7 @@ "subcategory": "oauth-applications" }, "deprecated": true, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Revoke an authorization for an application", @@ -3290,7 +3290,7 @@ "subcategory": null }, "deprecated": true, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/authorizations/clients/{client_id}": { @@ -3394,7 +3394,7 @@ "subcategory": null }, "deprecated": true, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/authorizations/clients/{client_id}/{fingerprint}": { @@ -3499,7 +3499,7 @@ "subcategory": null }, "deprecated": true, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/authorizations/{authorization_id}": { @@ -3616,7 +3616,7 @@ "subcategory": null }, "deprecated": true, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Delete an authorization", @@ -4525,7 +4525,7 @@ "/enterprises/{enterprise}/actions/runner-groups": { "get": { "summary": "List self-hosted runner groups for an enterprise", - "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4575,7 +4575,7 @@ }, "post": { "summary": "Create a self-hosted runner group for an enterprise", - "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4657,7 +4657,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { "get": { "summary": "Get a self-hosted runner group for an enterprise", - "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4696,7 +4696,7 @@ }, "patch": { "summary": "Update a self-hosted runner group for an enterprise", - "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4760,7 +4760,7 @@ }, "delete": { "summary": "Delete a self-hosted runner group from an enterprise", - "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4785,7 +4785,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { "get": { "summary": "List organization access to a self-hosted runner group in an enterprise", - "description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4836,7 +4836,7 @@ }, "put": { "summary": "Set organization access for a self-hosted runner group in an enterprise", - "description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4883,7 +4883,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { "put": { "summary": "Add organization access to a self-hosted runner group in an enterprise", - "description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4907,7 +4907,7 @@ }, "delete": { "summary": "Remove organization access to a self-hosted runner group in an enterprise", - "description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4933,7 +4933,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { "get": { "summary": "List self-hosted runners in a group for an enterprise", - "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4983,7 +4983,7 @@ }, "put": { "summary": "Set self-hosted runners in a group for an enterprise", - "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5030,7 +5030,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { "put": { "summary": "Add a self-hosted runner to a group for an enterprise", - "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5054,7 +5054,7 @@ }, "delete": { "summary": "Remove a self-hosted runner from a group for an enterprise", - "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5080,7 +5080,7 @@ "/enterprises/{enterprise}/actions/runners": { "get": { "summary": "List self-hosted runners for an enterprise", - "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5130,7 +5130,7 @@ "/enterprises/{enterprise}/actions/runners/downloads": { "get": { "summary": "List runner applications for an enterprise", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-runner-applications-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5169,7 +5169,7 @@ "/enterprises/{enterprise}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for an enterprise", - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```", "operationId": "enterprise-admin/create-registration-token-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5201,13 +5201,13 @@ "category": "enterprise-admin", "subcategory": "actions" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/enterprises/{enterprise}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for an enterprise", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", "operationId": "enterprise-admin/create-remove-token-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5239,13 +5239,13 @@ "category": "enterprise-admin", "subcategory": "actions" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/enterprises/{enterprise}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for an enterprise", - "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5280,7 +5280,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from an enterprise", - "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -8349,7 +8349,7 @@ "category": "actions", "subcategory": "self-hosted-runners" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/orgs/{org}/actions/runners/remove-token": { @@ -8387,7 +8387,7 @@ "category": "actions", "subcategory": "self-hosted-runners" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/orgs/{org}/actions/runners/{runner_id}": { @@ -9071,7 +9071,7 @@ "category": "orgs", "subcategory": "webhooks" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/orgs/{org}/hooks/{hook_id}": { @@ -9189,7 +9189,7 @@ "category": "orgs", "subcategory": "webhooks" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Delete an organization webhook", @@ -10649,7 +10649,7 @@ } ] }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/orgs/{org}/teams": { @@ -13834,7 +13834,7 @@ } ] }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Delete a repository", @@ -14405,7 +14405,7 @@ "category": "actions", "subcategory": "self-hosted-runners" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/actions/runners/remove-token": { @@ -14446,7 +14446,7 @@ "category": "actions", "subcategory": "self-hosted-runners" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/actions/runners/{runner_id}": { @@ -14530,7 +14530,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -14581,7 +14582,8 @@ "parameters": [ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, - { "$ref": "#/components/parameters/run-id" } + { "$ref": "#/components/parameters/run-id" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -15319,7 +15321,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -18111,7 +18114,7 @@ "category": "checks", "subcategory": "suites" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/check-suites/preferences": { @@ -18186,7 +18189,7 @@ "category": "checks", "subcategory": "suites" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { @@ -18516,7 +18519,7 @@ "previews": [], "category": "code-scanning" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { @@ -19044,7 +19047,7 @@ "category": "repos", "subcategory": "collaborators" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Remove a repository collaborator", @@ -21370,7 +21373,7 @@ "category": "repos", "subcategory": "forks" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/git/blobs": { @@ -22394,7 +22397,7 @@ "category": "repos", "subcategory": "webhooks" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/hooks/{hook_id}": { @@ -22531,7 +22534,7 @@ "category": "repos", "subcategory": "webhooks" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Delete a repository webhook", @@ -22862,7 +22865,7 @@ "category": "repos", "subcategory": "invitations" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Delete a repository invitation", @@ -23111,7 +23114,7 @@ "category": "issues", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/issues/comments": { @@ -23752,7 +23755,7 @@ "category": "issues", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { @@ -23807,7 +23810,7 @@ "category": "issues", "subcategory": "assignees" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Remove assignees from an issue", @@ -27708,7 +27711,7 @@ "category": "pulls", "subcategory": "review-requests" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Remove requested reviewers from a pull request", @@ -28555,7 +28558,7 @@ "category": "repos", "subcategory": "releases" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/releases/assets/{asset_id}": { @@ -28878,7 +28881,7 @@ "category": "repos", "subcategory": "releases" }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } }, "delete": { "summary": "Delete a release", @@ -29974,7 +29977,7 @@ "category": "repos", "subcategory": null }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repos/{owner}/{repo}/zipball/{ref}": { @@ -30123,7 +30126,7 @@ } ] }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/repositories": { @@ -34643,7 +34646,7 @@ } ] }, - "x-octokit": {} + "x-octokit": { "diff": { "ghes-3.2.json": { "type": "changed" } } } } }, "/user/repository_invitations": { @@ -36885,6 +36888,13 @@ "required": false, "schema": { "type": "string", "format": "date-time" } }, + "exclude-pull-requests": { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "query", + "required": false, + "schema": { "type": "boolean", "default": false } + }, "run-id": { "name": "run_id", "description": "The id of the workflow run.", diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json index ab10de8a1..ef2e54fc5 100644 --- a/cache/ghes-3.2.json +++ b/cache/ghes-3.2.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "5.7.0", + "version": "5.8.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -4627,13 +4627,15 @@ "category": "enterprise-admin", "subcategory": "actions" }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } } }, "/enterprises/{enterprise}/actions/runner-groups": { "get": { "summary": "List self-hosted runner groups for an enterprise", - "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4683,7 +4685,7 @@ }, "post": { "summary": "Create a self-hosted runner group for an enterprise", - "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4765,7 +4767,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { "get": { "summary": "Get a self-hosted runner group for an enterprise", - "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4804,7 +4806,7 @@ }, "patch": { "summary": "Update a self-hosted runner group for an enterprise", - "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4868,7 +4870,7 @@ }, "delete": { "summary": "Delete a self-hosted runner group from an enterprise", - "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4893,7 +4895,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { "get": { "summary": "List organization access to a self-hosted runner group in an enterprise", - "description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4944,7 +4946,7 @@ }, "put": { "summary": "Set organization access for a self-hosted runner group in an enterprise", - "description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -4991,7 +4993,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { "put": { "summary": "Add organization access to a self-hosted runner group in an enterprise", - "description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5015,7 +5017,7 @@ }, "delete": { "summary": "Remove organization access to a self-hosted runner group in an enterprise", - "description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5041,7 +5043,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { "get": { "summary": "List self-hosted runners in a group for an enterprise", - "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5091,7 +5093,7 @@ }, "put": { "summary": "Set self-hosted runners in a group for an enterprise", - "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5138,7 +5140,7 @@ "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { "put": { "summary": "Add a self-hosted runner to a group for an enterprise", - "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5162,7 +5164,7 @@ }, "delete": { "summary": "Remove a self-hosted runner from a group for an enterprise", - "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5188,7 +5190,7 @@ "/enterprises/{enterprise}/actions/runners": { "get": { "summary": "List self-hosted runners for an enterprise", - "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5238,7 +5240,7 @@ "/enterprises/{enterprise}/actions/runners/downloads": { "get": { "summary": "List runner applications for an enterprise", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/list-runner-applications-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5277,7 +5279,7 @@ "/enterprises/{enterprise}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for an enterprise", - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```", "operationId": "enterprise-admin/create-registration-token-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5315,7 +5317,7 @@ "/enterprises/{enterprise}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for an enterprise", - "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", "operationId": "enterprise-admin/create-remove-token-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5353,7 +5355,7 @@ "/enterprises/{enterprise}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for an enterprise", - "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -5388,7 +5390,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from an enterprise", - "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", "tags": ["enterprise-admin"], "externalDocs": { @@ -7495,7 +7497,9 @@ } ] }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } } }, "/orgs/{org}/actions/permissions": { @@ -7786,7 +7790,9 @@ "category": "actions", "subcategory": "permissions" }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } } }, "/orgs/{org}/actions/runner-groups": { @@ -14517,7 +14523,9 @@ "category": "actions", "subcategory": "permissions" }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } } }, "/repos/{owner}/{repo}/actions/runners": { @@ -14777,7 +14785,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -14828,7 +14837,8 @@ "parameters": [ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, - { "$ref": "#/components/parameters/run-id" } + { "$ref": "#/components/parameters/run-id" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -15727,7 +15737,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -18924,7 +18935,9 @@ "previews": [], "category": "code-scanning" }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } } }, "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { @@ -29281,7 +29294,9 @@ "category": "repos", "subcategory": "releases" }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } } }, "/repos/{owner}/{repo}/releases/assets/{asset_id}": { @@ -29610,7 +29625,9 @@ "category": "repos", "subcategory": "releases" }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } }, "delete": { "summary": "Delete a release", @@ -39524,6 +39541,13 @@ "required": false, "schema": { "type": "string", "format": "date-time" } }, + "exclude-pull-requests": { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "query", + "required": false, + "schema": { "type": "boolean", "default": false } + }, "run-id": { "name": "run_id", "description": "The id of the workflow run.", diff --git a/cache/github.ae.json b/cache/github.ae.json index 5c06ceb32..4c1dbbd6c 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "5.7.0", + "version": "5.8.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, @@ -11016,7 +11016,9 @@ "category": "repos", "subcategory": null }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } }, "delete": { "summary": "Delete a repository", @@ -11552,7 +11554,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -11603,7 +11606,8 @@ "parameters": [ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, - { "$ref": "#/components/parameters/run-id" } + { "$ref": "#/components/parameters/run-id" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -11719,7 +11723,8 @@ { "$ref": "#/components/parameters/owner" }, { "$ref": "#/components/parameters/repo" }, { "$ref": "#/components/parameters/run-id" }, - { "$ref": "#/components/parameters/attempt-number" } + { "$ref": "#/components/parameters/attempt-number" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -11778,9 +11783,7 @@ "category": "actions", "subcategory": "workflow-runs" }, - "x-octokit": { - "diff": { "api.github.com.json": { "type": "changed" } } - } + "x-octokit": {} } }, "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { @@ -12459,7 +12462,8 @@ { "$ref": "#/components/parameters/workflow-run-status" }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" }, - { "$ref": "#/components/parameters/created" } + { "$ref": "#/components/parameters/created" }, + { "$ref": "#/components/parameters/exclude-pull-requests" } ], "responses": { "200": { @@ -25481,7 +25485,9 @@ "category": "repos", "subcategory": "releases" }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } } }, "/repos/{owner}/{repo}/releases/assets/{asset_id}": { @@ -25804,7 +25810,9 @@ "category": "repos", "subcategory": "releases" }, - "x-octokit": {} + "x-octokit": { + "diff": { "api.github.com.json": { "type": "changed" } } + } }, "delete": { "summary": "Delete a release", @@ -35319,6 +35327,13 @@ "required": false, "schema": { "type": "string", "format": "date-time" } }, + "exclude-pull-requests": { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "query", + "required": false, + "schema": { "type": "boolean", "default": false } + }, "run-id": { "name": "run_id", "description": "The id of the workflow run.", diff --git a/packages/openapi-types-ghes-3.0/package.json b/packages/openapi-types-ghes-3.0/package.json index 520e443ed..8be4b037e 100644 --- a/packages/openapi-types-ghes-3.0/package.json +++ b/packages/openapi-types-ghes-3.0/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "5.7.0" } + "octokit": { "openapi-version": "5.8.0" } } diff --git a/packages/openapi-types-ghes-3.0/types.d.ts b/packages/openapi-types-ghes-3.0/types.d.ts index a91aac9f2..a525437f2 100644 --- a/packages/openapi-types-ghes-3.0/types.d.ts +++ b/packages/openapi-types-ghes-3.0/types.d.ts @@ -446,13 +446,13 @@ export interface paths { /** * Lists all self-hosted runner groups for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; /** * Creates a new self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; }; @@ -460,19 +460,19 @@ export interface paths { /** * Gets a specific self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; /** * Deletes a self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; }; @@ -480,13 +480,13 @@ export interface paths { /** * Lists the organizations with access to a self-hosted runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; }; @@ -494,13 +494,13 @@ export interface paths { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; }; @@ -508,13 +508,13 @@ export interface paths { /** * Lists the self-hosted runners that are in a specific enterprise group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; }; @@ -522,14 +522,14 @@ export interface paths { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` + * You must authenticate using an access token with the `admin:enterprise` * scope to use this endpoint. */ put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; }; @@ -537,7 +537,7 @@ export interface paths { /** * Lists all self-hosted runners configured for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; }; @@ -545,7 +545,7 @@ export interface paths { /** * Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; }; @@ -553,7 +553,7 @@ export interface paths { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using registration token * @@ -569,7 +569,7 @@ export interface paths { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using remove token * @@ -586,13 +586,13 @@ export interface paths { /** * Gets a specific self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; }; @@ -9999,6 +9999,8 @@ export interface components { | "requested" | "waiting"; created: string; + /** If `true` pull requests are omitted from the response (empty array). */ + "exclude-pull-requests": boolean; /** The id of the workflow run. */ "run-id": number; /** The ID of the workflow. You can also pass the workflow file name as a string. */ @@ -12037,7 +12039,7 @@ export interface operations { /** * Lists all self-hosted runner groups for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { parameters: { @@ -12067,7 +12069,7 @@ export interface operations { /** * Creates a new self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { parameters: { @@ -12102,7 +12104,7 @@ export interface operations { /** * Gets a specific self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { parameters: { @@ -12125,7 +12127,7 @@ export interface operations { /** * Deletes a self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { parameters: { @@ -12144,7 +12146,7 @@ export interface operations { /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { parameters: { @@ -12177,7 +12179,7 @@ export interface operations { /** * Lists the organizations with access to a self-hosted runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -12209,7 +12211,7 @@ export interface operations { /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -12236,7 +12238,7 @@ export interface operations { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -12257,7 +12259,7 @@ export interface operations { /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -12278,7 +12280,7 @@ export interface operations { /** * Lists the self-hosted runners that are in a specific enterprise group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { parameters: { @@ -12311,7 +12313,7 @@ export interface operations { /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { parameters: { @@ -12338,7 +12340,7 @@ export interface operations { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` + * You must authenticate using an access token with the `admin:enterprise` * scope to use this endpoint. */ "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { @@ -12360,7 +12362,7 @@ export interface operations { /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { parameters: { @@ -12381,7 +12383,7 @@ export interface operations { /** * Lists all self-hosted runners configured for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { @@ -12412,7 +12414,7 @@ export interface operations { /** * Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-runner-applications-for-enterprise": { parameters: { @@ -12433,7 +12435,7 @@ export interface operations { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using registration token * @@ -12462,7 +12464,7 @@ export interface operations { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using remove token * @@ -12492,7 +12494,7 @@ export interface operations { /** * Gets a specific self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/get-self-hosted-runner-for-enterprise": { parameters: { @@ -12515,7 +12517,7 @@ export interface operations { /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/delete-self-hosted-runner-from-enterprise": { parameters: { @@ -17585,6 +17587,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { @@ -17609,6 +17613,10 @@ export interface operations { /** The id of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + query: { + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + }; }; responses: { /** Response */ @@ -18102,6 +18110,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { diff --git a/packages/openapi-types-ghes-3.1/package.json b/packages/openapi-types-ghes-3.1/package.json index 4207a9cb5..ad757b2ca 100644 --- a/packages/openapi-types-ghes-3.1/package.json +++ b/packages/openapi-types-ghes-3.1/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "5.7.0" } + "octokit": { "openapi-version": "5.8.0" } } diff --git a/packages/openapi-types-ghes-3.1/types.d.ts b/packages/openapi-types-ghes-3.1/types.d.ts index e70709083..2f6c20e5e 100644 --- a/packages/openapi-types-ghes-3.1/types.d.ts +++ b/packages/openapi-types-ghes-3.1/types.d.ts @@ -446,13 +446,13 @@ export interface paths { /** * Lists all self-hosted runner groups for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; /** * Creates a new self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; }; @@ -460,19 +460,19 @@ export interface paths { /** * Gets a specific self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; /** * Deletes a self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; }; @@ -480,13 +480,13 @@ export interface paths { /** * Lists the organizations with access to a self-hosted runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; }; @@ -494,13 +494,13 @@ export interface paths { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; }; @@ -508,13 +508,13 @@ export interface paths { /** * Lists the self-hosted runners that are in a specific enterprise group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; }; @@ -522,14 +522,14 @@ export interface paths { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` + * You must authenticate using an access token with the `admin:enterprise` * scope to use this endpoint. */ put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; }; @@ -537,7 +537,7 @@ export interface paths { /** * Lists all self-hosted runners configured for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; }; @@ -545,7 +545,7 @@ export interface paths { /** * Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; }; @@ -553,7 +553,7 @@ export interface paths { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using registration token * @@ -569,7 +569,7 @@ export interface paths { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using remove token * @@ -586,13 +586,13 @@ export interface paths { /** * Gets a specific self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; }; @@ -10333,6 +10333,8 @@ export interface components { | "requested" | "waiting"; created: string; + /** If `true` pull requests are omitted from the response (empty array). */ + "exclude-pull-requests": boolean; /** The id of the workflow run. */ "run-id": number; /** The ID of the workflow. You can also pass the workflow file name as a string. */ @@ -12371,7 +12373,7 @@ export interface operations { /** * Lists all self-hosted runner groups for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { parameters: { @@ -12401,7 +12403,7 @@ export interface operations { /** * Creates a new self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { parameters: { @@ -12436,7 +12438,7 @@ export interface operations { /** * Gets a specific self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { parameters: { @@ -12459,7 +12461,7 @@ export interface operations { /** * Deletes a self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { parameters: { @@ -12478,7 +12480,7 @@ export interface operations { /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { parameters: { @@ -12511,7 +12513,7 @@ export interface operations { /** * Lists the organizations with access to a self-hosted runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -12543,7 +12545,7 @@ export interface operations { /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -12570,7 +12572,7 @@ export interface operations { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -12591,7 +12593,7 @@ export interface operations { /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -12612,7 +12614,7 @@ export interface operations { /** * Lists the self-hosted runners that are in a specific enterprise group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { parameters: { @@ -12645,7 +12647,7 @@ export interface operations { /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { parameters: { @@ -12672,7 +12674,7 @@ export interface operations { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` + * You must authenticate using an access token with the `admin:enterprise` * scope to use this endpoint. */ "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { @@ -12694,7 +12696,7 @@ export interface operations { /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { parameters: { @@ -12715,7 +12717,7 @@ export interface operations { /** * Lists all self-hosted runners configured for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { @@ -12746,7 +12748,7 @@ export interface operations { /** * Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-runner-applications-for-enterprise": { parameters: { @@ -12767,7 +12769,7 @@ export interface operations { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using registration token * @@ -12796,7 +12798,7 @@ export interface operations { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using remove token * @@ -12826,7 +12828,7 @@ export interface operations { /** * Gets a specific self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/get-self-hosted-runner-for-enterprise": { parameters: { @@ -12849,7 +12851,7 @@ export interface operations { /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/delete-self-hosted-runner-from-enterprise": { parameters: { @@ -17967,6 +17969,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { @@ -17991,6 +17995,10 @@ export interface operations { /** The id of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + query: { + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + }; }; responses: { /** Response */ @@ -18484,6 +18492,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json index 9ae6cee23..06336379a 100644 --- a/packages/openapi-types-ghes-3.2/package.json +++ b/packages/openapi-types-ghes-3.2/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "5.7.0" } + "octokit": { "openapi-version": "5.8.0" } } diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts index 95cc12941..2492b73ee 100644 --- a/packages/openapi-types-ghes-3.2/types.d.ts +++ b/packages/openapi-types-ghes-3.2/types.d.ts @@ -470,13 +470,13 @@ export interface paths { /** * Lists all self-hosted runner groups for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; /** * Creates a new self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; }; @@ -484,19 +484,19 @@ export interface paths { /** * Gets a specific self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; /** * Deletes a self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; }; @@ -504,13 +504,13 @@ export interface paths { /** * Lists the organizations with access to a self-hosted runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; }; @@ -518,13 +518,13 @@ export interface paths { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; }; @@ -532,13 +532,13 @@ export interface paths { /** * Lists the self-hosted runners that are in a specific enterprise group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; }; @@ -546,14 +546,14 @@ export interface paths { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` + * You must authenticate using an access token with the `admin:enterprise` * scope to use this endpoint. */ put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; }; @@ -561,7 +561,7 @@ export interface paths { /** * Lists all self-hosted runners configured for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; }; @@ -569,7 +569,7 @@ export interface paths { /** * Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; }; @@ -577,7 +577,7 @@ export interface paths { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using registration token * @@ -593,7 +593,7 @@ export interface paths { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using remove token * @@ -610,13 +610,13 @@ export interface paths { /** * Gets a specific self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; }; @@ -11096,6 +11096,8 @@ export interface components { | "requested" | "waiting"; created: string; + /** If `true` pull requests are omitted from the response (empty array). */ + "exclude-pull-requests": boolean; /** The id of the workflow run. */ "run-id": number; /** The ID of the workflow. You can also pass the workflow file name as a string. */ @@ -13200,7 +13202,7 @@ export interface operations { /** * Lists all self-hosted runner groups for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { parameters: { @@ -13230,7 +13232,7 @@ export interface operations { /** * Creates a new self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { parameters: { @@ -13265,7 +13267,7 @@ export interface operations { /** * Gets a specific self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { parameters: { @@ -13288,7 +13290,7 @@ export interface operations { /** * Deletes a self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { parameters: { @@ -13307,7 +13309,7 @@ export interface operations { /** * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { parameters: { @@ -13340,7 +13342,7 @@ export interface operations { /** * Lists the organizations with access to a self-hosted runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -13372,7 +13374,7 @@ export interface operations { /** * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -13399,7 +13401,7 @@ export interface operations { /** * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -13420,7 +13422,7 @@ export interface operations { /** * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { @@ -13441,7 +13443,7 @@ export interface operations { /** * Lists the self-hosted runners that are in a specific enterprise group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { parameters: { @@ -13474,7 +13476,7 @@ export interface operations { /** * Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { parameters: { @@ -13501,7 +13503,7 @@ export interface operations { /** * Adds a self-hosted runner to a runner group configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` + * You must authenticate using an access token with the `admin:enterprise` * scope to use this endpoint. */ "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { @@ -13523,7 +13525,7 @@ export interface operations { /** * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { parameters: { @@ -13544,7 +13546,7 @@ export interface operations { /** * Lists all self-hosted runners configured for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { @@ -13575,7 +13577,7 @@ export interface operations { /** * Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/list-runner-applications-for-enterprise": { parameters: { @@ -13596,7 +13598,7 @@ export interface operations { /** * Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using registration token * @@ -13625,7 +13627,7 @@ export interface operations { /** * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * * #### Example using remove token * @@ -13655,7 +13657,7 @@ export interface operations { /** * Gets a specific self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/get-self-hosted-runner-for-enterprise": { parameters: { @@ -13678,7 +13680,7 @@ export interface operations { /** * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ "enterprise-admin/delete-self-hosted-runner-from-enterprise": { parameters: { @@ -18870,6 +18872,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { @@ -18894,6 +18898,10 @@ export interface operations { /** The id of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + query: { + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + }; }; responses: { /** Response */ @@ -19464,6 +19472,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index 3204c9665..d50a3b0fc 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "5.7.0" } + "octokit": { "openapi-version": "5.8.0" } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index 48712d088..6f1d34ce1 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -10208,6 +10208,8 @@ export interface components { | "requested" | "waiting"; created: string; + /** If `true` pull requests are omitted from the response (empty array). */ + "exclude-pull-requests": boolean; /** The id of the workflow run. */ "run-id": number; /** The attempt number of the workflow run. */ @@ -16423,6 +16425,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { @@ -16447,6 +16451,10 @@ export interface operations { /** The id of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + query: { + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + }; }; responses: { /** Response */ @@ -16521,6 +16529,10 @@ export interface operations { /** The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + query: { + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + }; }; responses: { /** Response */ @@ -17011,6 +17023,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index c5fe7f488..f30c81444 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -12,5 +12,5 @@ "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", - "octokit": { "openapi-version": "5.7.0" } + "octokit": { "openapi-version": "5.8.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index b54b3a732..49a458174 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -11754,6 +11754,8 @@ export interface components { | "requested" | "waiting"; created: string; + /** If `true` pull requests are omitted from the response (empty array). */ + "exclude-pull-requests": boolean; /** The id of the workflow run. */ "run-id": number; /** The attempt number of the workflow run. */ @@ -19726,6 +19728,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: { @@ -19750,6 +19754,10 @@ export interface operations { /** The id of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + query: { + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + }; }; responses: { /** Response */ @@ -19868,6 +19876,10 @@ export interface operations { /** The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + query: { + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + }; }; responses: { /** Response */ @@ -20416,6 +20428,8 @@ export interface operations { /** Page number of the results to fetch. */ page?: components["parameters"]["page"]; created?: components["parameters"]["created"]; + /** If `true` pull requests are omitted from the response (empty array). */ + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; }; responses: {