From ec14f523a74e48d35c85541380b86e4b7f83acbf Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:12:42 -0400 Subject: [PATCH 1/2] Update OpenAPI Descriptions (#21929) --- lib/rest/static/decorated/api.github.com.json | 232 +++++++++++---- lib/rest/static/decorated/ghes-2.22.json | 132 ++++----- lib/rest/static/decorated/ghes-3.0.json | 132 ++++----- lib/rest/static/decorated/ghes-3.1.json | 151 +++++----- lib/rest/static/decorated/ghes-3.2.json | 151 +++++----- lib/rest/static/decorated/github.ae.json | 162 ++++++++--- .../dereferenced/api.github.com.deref.json | 274 ++++++++++++------ .../static/dereferenced/ghes-2.22.deref.json | 128 +++----- .../static/dereferenced/ghes-3.0.deref.json | 128 +++----- .../static/dereferenced/ghes-3.1.deref.json | 142 ++++----- .../static/dereferenced/ghes-3.2.deref.json | 142 ++++----- .../static/dereferenced/github.ae.deref.json | 227 ++++++++++----- 12 files changed, 1109 insertions(+), 892 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 40b0db3a37..33718e7264 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -24713,12 +24713,22 @@ { "name": "secret_type", "in": "query", - "description": "A comma separated list of secret types to return. By default all secret types are returned.", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "
A comma separated list of secret types to return. By default all secret types are returned.
" + "descriptionHTML": "A comma-separated list of secret types to return. By default all secret types are returned.
" + }, + { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
check_run_id parameter
" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/rerequest", + "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/rerequest"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})\n"
+ }
+ ],
+ "summary": "Rerequest a check run",
+ "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/rerequest-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "checks",
+ "subcategory": "runs"
+ },
+ "slug": "rerequest-a-check-run",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "runs",
+ "subcategoryLabel": "Runs",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation error if the check run is not rerequestable"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared.
To rerequest a check run, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'"
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
- "html": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})\n"
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})\n"
}
],
"summary": "Create a GitHub Pages site",
@@ -67441,14 +67545,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "previews": [
- {
- "required": true,
- "name": "switcheroo",
- "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
- "html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
- }
- ],
"category": "repos",
"subcategory": "pages"
},
@@ -67472,11 +67568,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -67839,13 +67930,13 @@
"x-codeSamples": [
{
"lang": "Shell",
- "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
- "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages"
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
- "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})\n"
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n"
}
],
"summary": "Delete a GitHub Pages site",
@@ -67861,14 +67952,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "previews": [
- {
- "required": true,
- "name": "switcheroo",
- "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
- "html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
- }
- ],
"category": "repos",
"subcategory": "pages"
},
@@ -67889,11 +67972,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -73435,6 +73513,16 @@
"rawType": "string",
"rawDescription": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"",
"childParamsGroups": []
+ },
+ "generate_release_notes": {
+ "type": "boolean",
+ "description": "Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.
Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.
A comma separated list of secret types to return. By default all secret types are returned. See \"About secret scanning for private repositories\" for a complete list of secret types (API slug).
" + "descriptionHTML": "A comma-separated list of secret types to return. By default all secret types are returned. See \"About secret scanning for private repositories\" for a complete list of secret types (API slug).
" + }, + { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
{\n \"number\": 42,\n \"created_at\": \"2020-11-06T18:18:30Z\",\n \"url\": \"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\n \"html_url\": \"https://github.com/owner/private-repo/security/secret-scanning/42\",\n \"state\": \"open\",\n \"resolution\": null,\n \"resolved_at\": null,\n \"resolved_by\": null,\n \"secret_type\": \"mailchimp_api_key\",\n \"secret\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"\n}\n"
},
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
@@ -87758,7 +87872,7 @@
"tags": [
"users"
],
- "operationId": "users/list-blocked-by-authenticated",
+ "operationId": "users/list-blocked-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user"
@@ -88079,7 +88193,7 @@
"tags": [
"users"
],
- "operationId": "users/set-primary-email-visibility-for-authenticated",
+ "operationId": "users/set-primary-email-visibility-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user"
@@ -88219,7 +88333,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -88290,7 +88404,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -88433,7 +88547,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -88682,7 +88796,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -89009,7 +89123,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -89077,7 +89191,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -89202,7 +89316,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -89284,7 +89398,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -89575,7 +89689,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -89660,7 +89774,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -90157,7 +90271,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -90225,7 +90339,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -90372,7 +90486,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -90454,7 +90568,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -91689,7 +91803,7 @@
"tags": [
"migrations"
],
- "operationId": "migrations/list-repos-for-user",
+ "operationId": "migrations/list-repos-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration"
@@ -92757,7 +92871,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -93596,7 +93710,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation"
@@ -93677,7 +93791,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json
index 0cdf188188..53d7174bd8 100644
--- a/lib/rest/static/decorated/ghes-2.22.json
+++ b/lib/rest/static/decorated/ghes-2.22.json
@@ -8897,7 +8897,7 @@
}
],
"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"
@@ -8920,7 +8920,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. Name of the runner group.
", @@ -9156,7 +9156,7 @@ } ], "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" @@ -9179,7 +9179,7 @@ "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
Updates the name and visibility of a self-hosted runner group in an enterprise.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Name of the runner group.
", @@ -9363,7 +9363,7 @@ } ], "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" @@ -9393,7 +9393,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. List of organization IDs that can access the runner group.
", @@ -9656,7 +9656,7 @@ } ], "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" @@ -9686,7 +9686,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "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.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. List of runner IDs to add to the runner group.
", @@ -10030,7 +10030,7 @@ } ], "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" @@ -10060,7 +10060,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise\nscope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise\nscope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n",
+ "descriptionHTML": "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 admin:enterprise scope to use this endpoint.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n",
"responses": [
{
"httpStatusCode": "201",
@@ -10378,7 +10378,7 @@
}
],
"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"
@@ -10401,7 +10401,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "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.
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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 admin:enterprise scope to use this endpoint.
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"responses": [
{
"httpStatusCode": "201",
@@ -10450,7 +10450,7 @@
}
],
"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"
@@ -10473,7 +10473,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
},
"slug": "create-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -58441,11 +58441,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -58830,6 +58825,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
@@ -58837,9 +58834,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
},
"slug": "delete-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -58858,11 +58853,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -73488,7 +73478,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -73559,7 +73549,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -73702,7 +73692,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -73951,7 +73941,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -74278,7 +74268,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -74346,7 +74336,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -74471,7 +74461,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -74553,7 +74543,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -74844,7 +74834,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -74929,7 +74919,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -75194,7 +75184,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -75262,7 +75252,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -75409,7 +75399,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -75491,7 +75481,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -76103,7 +76093,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -76925,7 +76915,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#accept-a-repository-invitation"
@@ -77006,7 +76996,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json
index 44c11299fc..b20fbc7f38 100644
--- a/lib/rest/static/decorated/ghes-3.0.json
+++ b/lib/rest/static/decorated/ghes-3.0.json
@@ -11921,7 +11921,7 @@
}
],
"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"
@@ -11944,7 +11944,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. Name of the runner group.
", @@ -12180,7 +12180,7 @@ } ], "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" @@ -12203,7 +12203,7 @@ "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
Updates the name and visibility of a self-hosted runner group in an enterprise.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Name of the runner group.
", @@ -12387,7 +12387,7 @@ } ], "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" @@ -12417,7 +12417,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. List of organization IDs that can access the runner group.
", @@ -12680,7 +12680,7 @@ } ], "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" @@ -12710,7 +12710,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "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.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. List of runner IDs to add to the runner group.
", @@ -13054,7 +13054,7 @@ } ], "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" @@ -13084,7 +13084,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise\nscope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise\nscope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n",
+ "descriptionHTML": "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 admin:enterprise scope to use this endpoint.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n",
"responses": [
{
"httpStatusCode": "201",
@@ -13402,7 +13402,7 @@
}
],
"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"
@@ -13425,7 +13425,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "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.
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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 admin:enterprise scope to use this endpoint.
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"responses": [
{
"httpStatusCode": "201",
@@ -13474,7 +13474,7 @@
}
],
"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"
@@ -13497,7 +13497,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
},
"slug": "create-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -63244,11 +63244,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -63633,6 +63628,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
@@ -63640,9 +63637,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
},
"slug": "delete-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -63661,11 +63656,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -78291,7 +78281,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -78362,7 +78352,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -78505,7 +78495,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -78754,7 +78744,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -79081,7 +79071,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -79149,7 +79139,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -79274,7 +79264,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -79356,7 +79346,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -79647,7 +79637,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -79732,7 +79722,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -79997,7 +79987,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -80065,7 +80055,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -80212,7 +80202,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -80294,7 +80284,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -80906,7 +80896,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -81728,7 +81718,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#accept-a-repository-invitation"
@@ -81809,7 +81799,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json
index a2e4c4cdee..a9be9ef299 100644
--- a/lib/rest/static/decorated/ghes-3.1.json
+++ b/lib/rest/static/decorated/ghes-3.1.json
@@ -11921,7 +11921,7 @@
}
],
"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"
@@ -11944,7 +11944,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. Name of the runner group.
", @@ -12180,7 +12180,7 @@ } ], "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" @@ -12203,7 +12203,7 @@ "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
Updates the name and visibility of a self-hosted runner group in an enterprise.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Name of the runner group.
", @@ -12387,7 +12387,7 @@ } ], "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" @@ -12417,7 +12417,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. List of organization IDs that can access the runner group.
", @@ -12680,7 +12680,7 @@ } ], "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" @@ -12710,7 +12710,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "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.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. List of runner IDs to add to the runner group.
", @@ -13054,7 +13054,7 @@ } ], "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" @@ -13084,7 +13084,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise\nscope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise\nscope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n",
+ "descriptionHTML": "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 admin:enterprise scope to use this endpoint.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n",
"responses": [
{
"httpStatusCode": "201",
@@ -13402,7 +13402,7 @@
}
],
"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"
@@ -13425,7 +13425,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "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.
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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 admin:enterprise scope to use this endpoint.
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"responses": [
{
"httpStatusCode": "201",
@@ -13474,7 +13474,7 @@
}
],
"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"
@@ -13497,7 +13497,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
},
"slug": "create-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -63934,11 +63934,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -64323,6 +64318,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
@@ -64330,9 +64327,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
},
"slug": "delete-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -64351,11 +64346,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -71491,12 +71481,22 @@
{
"name": "secret_type",
"in": "query",
- "description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
- "descriptionHTML": "A comma separated list of secret types to return. By default all secret types are returned. See \"About secret scanning for private repositories\" for a complete list of secret types (API slug).
" + "descriptionHTML": "A comma-separated list of secret types to return. By default all secret types are returned. See \"About secret scanning for private repositories\" for a complete list of secret types (API slug).
" + }, + { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
{\n \"number\": 42,\n \"created_at\": \"2020-11-06T18:18:30Z\",\n \"url\": \"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\n \"html_url\": \"https://github.com/owner/private-repo/security/secret-scanning/42\",\n \"state\": \"open\",\n \"resolution\": null,\n \"resolved_at\": null,\n \"resolved_by\": null,\n \"secret_type\": \"mailchimp_api_key\",\n \"secret\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"\n}\n"
},
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
@@ -79194,7 +79199,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -79265,7 +79270,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -79408,7 +79413,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -79657,7 +79662,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -79984,7 +79989,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -80052,7 +80057,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -80177,7 +80182,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -80259,7 +80264,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -80550,7 +80555,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -80635,7 +80640,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -80900,7 +80905,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -80968,7 +80973,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -81115,7 +81120,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -81197,7 +81202,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -81809,7 +81814,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -82631,7 +82636,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#accept-a-repository-invitation"
@@ -82712,7 +82717,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json
index 6acfe2d5f9..6531c22d50 100644
--- a/lib/rest/static/decorated/ghes-3.2.json
+++ b/lib/rest/static/decorated/ghes-3.2.json
@@ -12144,7 +12144,7 @@
}
],
"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"
@@ -12167,7 +12167,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runner groups for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. Name of the runner group.
", @@ -12403,7 +12403,7 @@ } ], "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" @@ -12426,7 +12426,7 @@ "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
Updates the name and visibility of a self-hosted runner group in an enterprise.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Name of the runner group.
", @@ -12610,7 +12610,7 @@ } ], "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" @@ -12640,7 +12640,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Deletes a self-hosted runner group for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. List of organization IDs that can access the runner group.
", @@ -12903,7 +12903,7 @@ } ], "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" @@ -12933,7 +12933,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "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.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an enterprise runner group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Required. List of runner IDs to add to the runner group.
", @@ -13277,7 +13277,7 @@ } ], "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" @@ -13307,7 +13307,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise\nscope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise\nscope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n",
+ "descriptionHTML": "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 admin:enterprise scope to use this endpoint.
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n",
"responses": [
{
"httpStatusCode": "201",
@@ -13625,7 +13625,7 @@
}
],
"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"
@@ -13648,7 +13648,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "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.
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
+ "descriptionHTML": "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 admin:enterprise scope to use this endpoint.
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\n",
"responses": [
{
"httpStatusCode": "201",
@@ -13697,7 +13697,7 @@
}
],
"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"
@@ -13720,7 +13720,7 @@
"subcategoryLabel": "Actions",
"notes": [],
"bodyParameters": [],
- "descriptionHTML": "Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner configured in an enterprise.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
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.
\nYou must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
},
"slug": "create-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -66140,11 +66140,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -66529,6 +66524,8 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
@@ -66536,9 +66533,7 @@
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
"html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
},
"slug": "delete-a-github-enterprise-server-pages-site",
"category": "repos",
@@ -66557,11 +66552,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -73846,12 +73836,22 @@
{
"name": "secret_type",
"in": "query",
- "description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
- "descriptionHTML": "A comma separated list of secret types to return. By default all secret types are returned. See \"About secret scanning for private repositories\" for a complete list of secret types (API slug).
" + "descriptionHTML": "A comma-separated list of secret types to return. By default all secret types are returned. See \"About secret scanning for private repositories\" for a complete list of secret types (API slug).
" + }, + { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.
{\n \"number\": 42,\n \"created_at\": \"2020-11-06T18:18:30Z\",\n \"url\": \"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\n \"html_url\": \"https://github.com/owner/private-repo/security/secret-scanning/42\",\n \"state\": \"open\",\n \"resolution\": null,\n \"resolved_at\": null,\n \"resolved_by\": null,\n \"secret_type\": \"mailchimp_api_key\",\n \"secret\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"\n}\n"
},
+ {
+ "httpStatusCode": "304",
+ "httpStatusMessage": "Not Modified",
+ "description": "Not modified"
+ },
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
@@ -82017,7 +82022,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -82088,7 +82093,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -82231,7 +82236,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -82480,7 +82485,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -82807,7 +82812,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -82875,7 +82880,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -83000,7 +83005,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -83082,7 +83087,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -83373,7 +83378,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -83458,7 +83463,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -83723,7 +83728,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -83791,7 +83796,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -83938,7 +83943,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -84020,7 +84025,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -84632,7 +84637,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -85471,7 +85476,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#accept-a-repository-invitation"
@@ -85552,7 +85557,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json
index 56ea9542d0..9cda85f012 100644
--- a/lib/rest/static/decorated/github.ae.json
+++ b/lib/rest/static/decorated/github.ae.json
@@ -38546,6 +38546,100 @@
}
]
},
+ {
+ "verb": "post",
+ "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest",
+ "serverUrl": "https://{hostname}/api/v3",
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "descriptionHTML": ""
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ },
+ "descriptionHTML": "check_run_id parameter
" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/rerequest", + "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/check-runs/42/rerequest"
+ },
+ {
+ "lang": "JavaScript",
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})\n"
+ }
+ ],
+ "summary": "Rerequest a check run",
+ "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/rerequest-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-run"
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [],
+ "category": "checks",
+ "subcategory": "runs"
+ },
+ "slug": "rerequest-a-check-run",
+ "category": "checks",
+ "categoryLabel": "Checks",
+ "subcategory": "runs",
+ "subcategoryLabel": "Runs",
+ "notes": [],
+ "responses": [
+ {
+ "httpStatusCode": "201",
+ "httpStatusMessage": "Created",
+ "description": "Response"
+ },
+ {
+ "httpStatusCode": "403",
+ "httpStatusMessage": "Forbidden",
+ "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App"
+ },
+ {
+ "httpStatusCode": "404",
+ "httpStatusMessage": "Not Found",
+ "description": "Resource not found"
+ },
+ {
+ "httpStatusCode": "422",
+ "httpStatusMessage": "Unprocessable Entity",
+ "description": "Validation error if the check run is not rerequestable"
+ }
+ ],
+ "bodyParameters": [],
+ "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared.
To rerequest a check run, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'"
+ "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'",
+ "html": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"source\":{\"branch\":\"branch\",\"path\":\"path\"}}'"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
- "html": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n },\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})\n"
+ "source": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})",
+ "html": "await octokit.request('POST /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n source: {\n branch: 'branch',\n path: 'path'\n }\n})\n"
}
],
"summary": "Create a GitHub AE Pages site",
@@ -57053,14 +57147,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "previews": [
- {
- "required": true,
- "name": "switcheroo",
- "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
- "html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
- }
- ],
"category": "repos",
"subcategory": "pages"
},
@@ -57084,11 +57170,6 @@
"httpStatusMessage": "Conflict",
"description": "Conflict"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -57451,13 +57532,13 @@
"x-codeSamples": [
{
"lang": "Shell",
- "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages",
- "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.switcheroo-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages"
+ "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages",
+ "html": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/pages"
},
{
"lang": "JavaScript",
- "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})",
- "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'switcheroo'\n ]\n }\n})\n"
+ "source": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
+ "html": "await octokit.request('DELETE /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world'\n})\n"
}
],
"summary": "Delete a GitHub AE Pages site",
@@ -57473,14 +57554,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "previews": [
- {
- "required": true,
- "name": "switcheroo",
- "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```",
- "html": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the blog post preview for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.switcheroo-preview+json"
- }
- ],
"category": "repos",
"subcategory": "pages"
},
@@ -57501,11 +57574,6 @@
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
- {
- "httpStatusCode": "415",
- "httpStatusMessage": "Unsupported Media Type",
- "description": "Preview header missing"
- },
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
@@ -71924,7 +71992,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -72251,7 +72319,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -72319,7 +72387,7 @@
],
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -72444,7 +72512,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -72526,7 +72594,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -72817,7 +72885,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -72902,7 +72970,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -73154,7 +73222,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -73222,7 +73290,7 @@
],
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -73369,7 +73437,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -73451,7 +73519,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -74803,7 +74871,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#accept-a-repository-invitation"
@@ -74884,7 +74952,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json
index 96d3a4b326..1ceca59b38 100644
--- a/lib/rest/static/dereferenced/api.github.com.deref.json
+++ b/lib/rest/static/dereferenced/api.github.com.deref.json
@@ -93305,7 +93305,16 @@
{
"name": "secret_type",
"in": "query",
- "description": "A comma separated list of secret types to return. By default all secret types are returned.",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "resolution",
+ "in": "query",
+ "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
@@ -166839,6 +166848,149 @@
}
}
},
+ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
+ "post": {
+ "summary": "Rerequest a check run",
+ "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/rerequest-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation error if the check run is not rerequestable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ }
+ },
"/repos/{owner}/{repo}/check-suites": {
"post": {
"summary": "Create a check suite",
@@ -289620,28 +289772,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"409": {
"description": "Conflict",
"content": {
@@ -289672,13 +289802,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "previews": [
- {
- "required": true,
- "name": "switcheroo",
- "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
- }
- ],
"category": "repos",
"subcategory": "pages"
}
@@ -290047,28 +290170,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"404": {
"description": "Resource not found",
"content": {
@@ -290099,13 +290200,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "previews": [
- {
- "required": true,
- "name": "switcheroo",
- "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
- }
- ],
"category": "repos",
"subcategory": "pages"
}
@@ -326539,6 +326633,11 @@
"discussion_category_name": {
"type": "string",
"description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""
+ },
+ "generate_release_notes": {
+ "type": "boolean",
+ "description": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
+ "default": false
}
},
"required": [
@@ -326551,7 +326650,8 @@
"name": "v1.0.0",
"body": "Description of the release",
"draft": false,
- "prerelease": false
+ "prerelease": false,
+ "generate_release_notes": false
}
}
}
@@ -331898,7 +331998,16 @@
{
"name": "secret_type",
"in": "query",
- "description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "resolution",
+ "in": "query",
+ "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
@@ -332467,6 +332576,9 @@
}
}
},
+ "304": {
+ "description": "Not modified"
+ },
"404": {
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
},
@@ -371171,7 +371283,7 @@
"tags": [
"users"
],
- "operationId": "users/list-blocked-by-authenticated",
+ "operationId": "users/list-blocked-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user"
@@ -371879,7 +371991,7 @@
"tags": [
"users"
],
- "operationId": "users/set-primary-email-visibility-for-authenticated",
+ "operationId": "users/set-primary-email-visibility-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user"
@@ -372133,7 +372245,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -372318,7 +372430,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -372606,7 +372718,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -373095,7 +373207,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -373711,7 +373823,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -374054,7 +374166,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -374463,7 +374575,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -374787,7 +374899,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -377299,7 +377411,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -377399,7 +377511,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -380539,7 +380651,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -380740,7 +380852,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -381004,7 +381116,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -381177,7 +381289,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -388520,7 +388632,7 @@
"tags": [
"migrations"
],
- "operationId": "migrations/list-repos-for-user",
+ "operationId": "migrations/list-repos-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration"
@@ -396214,7 +396326,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -401721,7 +401833,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation"
@@ -401839,7 +401951,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json
index f922a13c3b..755256bbcd 100644
--- a/lib/rest/static/dereferenced/ghes-2.22.deref.json
+++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json
@@ -22174,7 +22174,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"
@@ -22316,7 +22316,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"
@@ -22461,7 +22461,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"
@@ -22558,7 +22558,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"
@@ -22683,7 +22683,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"
@@ -22731,7 +22731,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"
@@ -22910,7 +22910,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"
@@ -22987,7 +22987,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"
@@ -23042,7 +23042,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"
@@ -23099,7 +23099,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"
@@ -23233,7 +23233,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"
@@ -23310,7 +23310,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"
@@ -23365,7 +23365,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"
@@ -23422,7 +23422,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"
@@ -23545,7 +23545,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"
@@ -23659,7 +23659,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"
@@ -24846,7 +24846,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"
@@ -26033,7 +26033,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"
@@ -26114,7 +26114,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"
@@ -254238,28 +254238,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"409": {
"description": "Conflict",
"content": {
@@ -254290,15 +254268,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
}
},
"put": {
@@ -254665,28 +254643,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"404": {
"description": "Resource not found",
"content": {
@@ -254717,15 +254673,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
}
}
},
@@ -326901,7 +326857,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -327086,7 +327042,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -327374,7 +327330,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -327863,7 +327819,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -328479,7 +328435,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -328822,7 +328778,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -329231,7 +329187,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -329555,7 +329511,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -331802,7 +331758,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -331902,7 +331858,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -334754,7 +334710,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -334955,7 +334911,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -335219,7 +335175,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -335392,7 +335348,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -337544,7 +337500,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -343017,7 +342973,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#accept-a-repository-invitation"
@@ -343135,7 +343091,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json
index 7a10b2c513..1e5b68d775 100644
--- a/lib/rest/static/dereferenced/ghes-3.0.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json
@@ -24888,7 +24888,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"
@@ -25030,7 +25030,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"
@@ -25175,7 +25175,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"
@@ -25272,7 +25272,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"
@@ -25397,7 +25397,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"
@@ -25445,7 +25445,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"
@@ -25624,7 +25624,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"
@@ -25701,7 +25701,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"
@@ -25756,7 +25756,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"
@@ -25813,7 +25813,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"
@@ -26028,7 +26028,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"
@@ -26105,7 +26105,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"
@@ -26160,7 +26160,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"
@@ -26217,7 +26217,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"
@@ -26421,7 +26421,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"
@@ -26535,7 +26535,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"
@@ -27722,7 +27722,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"
@@ -28909,7 +28909,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"
@@ -29054,7 +29054,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"
@@ -261079,28 +261079,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"409": {
"description": "Conflict",
"content": {
@@ -261131,15 +261109,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
}
},
"put": {
@@ -261506,28 +261484,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"404": {
"description": "Resource not found",
"content": {
@@ -261558,15 +261514,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
}
}
},
@@ -333742,7 +333698,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -333927,7 +333883,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -334215,7 +334171,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -334704,7 +334660,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -335320,7 +335276,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -335663,7 +335619,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -336072,7 +336028,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -336396,7 +336352,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -338898,7 +338854,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -338998,7 +338954,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -341850,7 +341806,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -342051,7 +342007,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -342315,7 +342271,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -342488,7 +342444,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -344640,7 +344596,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -350113,7 +350069,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#accept-a-repository-invitation"
@@ -350231,7 +350187,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json
index e2fa667c1e..9ba308e81f 100644
--- a/lib/rest/static/dereferenced/ghes-3.1.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json
@@ -24888,7 +24888,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"
@@ -25030,7 +25030,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"
@@ -25175,7 +25175,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"
@@ -25272,7 +25272,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"
@@ -25397,7 +25397,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"
@@ -25445,7 +25445,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"
@@ -25624,7 +25624,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"
@@ -25701,7 +25701,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"
@@ -25756,7 +25756,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"
@@ -25813,7 +25813,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"
@@ -26028,7 +26028,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"
@@ -26105,7 +26105,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"
@@ -26160,7 +26160,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"
@@ -26217,7 +26217,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"
@@ -26421,7 +26421,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"
@@ -26535,7 +26535,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"
@@ -27722,7 +27722,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"
@@ -28909,7 +28909,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"
@@ -29054,7 +29054,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"
@@ -264056,28 +264056,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"409": {
"description": "Conflict",
"content": {
@@ -264108,15 +264086,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
}
},
"put": {
@@ -264483,28 +264461,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"404": {
"description": "Resource not found",
"content": {
@@ -264535,15 +264491,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
}
}
},
@@ -305551,7 +305507,16 @@
{
"name": "secret_type",
"in": "query",
- "description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "resolution",
+ "in": "query",
+ "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
@@ -306120,6 +306085,9 @@
}
}
},
+ "304": {
+ "description": "Not modified"
+ },
"404": {
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
},
@@ -338294,7 +338262,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -338479,7 +338447,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -338767,7 +338735,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -339256,7 +339224,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -339872,7 +339840,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -340215,7 +340183,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -340624,7 +340592,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -340948,7 +340916,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -343450,7 +343418,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -343550,7 +343518,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -346402,7 +346370,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -346603,7 +346571,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.1/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -346867,7 +346835,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -347040,7 +347008,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -349192,7 +349160,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -354665,7 +354633,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#accept-a-repository-invitation"
@@ -354783,7 +354751,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.1/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json
index 7cdd021d57..e4f1cf797d 100644
--- a/lib/rest/static/dereferenced/ghes-3.2.deref.json
+++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json
@@ -25796,7 +25796,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"
@@ -25938,7 +25938,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"
@@ -26083,7 +26083,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"
@@ -26180,7 +26180,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"
@@ -26305,7 +26305,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"
@@ -26353,7 +26353,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"
@@ -26532,7 +26532,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"
@@ -26609,7 +26609,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"
@@ -26664,7 +26664,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"
@@ -26721,7 +26721,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"
@@ -26936,7 +26936,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"
@@ -27013,7 +27013,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"
@@ -27068,7 +27068,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"
@@ -27125,7 +27125,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"
@@ -27329,7 +27329,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"
@@ -27453,7 +27453,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"
@@ -28649,7 +28649,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"
@@ -29845,7 +29845,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"
@@ -29990,7 +29990,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"
@@ -270869,28 +270869,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"409": {
"description": "Conflict",
"content": {
@@ -270921,15 +270899,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
}
},
"put": {
@@ -271296,28 +271274,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"404": {
"description": "Resource not found",
"content": {
@@ -271348,15 +271304,15 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
+ "category": "repos",
+ "subcategory": "pages",
"previews": [
{
"required": true,
"name": "switcheroo",
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
}
- ],
- "category": "repos",
- "subcategory": "pages"
+ ]
}
}
},
@@ -312997,7 +312953,16 @@
{
"name": "secret_type",
"in": "query",
- "description": "A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "resolution",
+ "in": "query",
+ "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
"required": false,
"schema": {
"type": "string"
@@ -313566,6 +313531,9 @@
}
}
},
+ "304": {
+ "description": "Not modified"
+ },
"404": {
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
},
@@ -346307,7 +346275,7 @@
"tags": [
"users"
],
- "operationId": "users/list-emails-for-authenticated",
+ "operationId": "users/list-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-email-addresses-for-the-authenticated-user"
@@ -346492,7 +346460,7 @@
"tags": [
"users"
],
- "operationId": "users/add-email-for-authenticated",
+ "operationId": "users/add-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#add-an-email-address-for-the-authenticated-user"
@@ -346780,7 +346748,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-email-for-authenticated",
+ "operationId": "users/delete-email-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
@@ -347269,7 +347237,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -347885,7 +347853,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -348228,7 +348196,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -348637,7 +348605,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -348961,7 +348929,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -351473,7 +351441,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -351573,7 +351541,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -354435,7 +354403,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -354636,7 +354604,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -354900,7 +354868,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -355073,7 +355041,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -357225,7 +357193,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-emails-for-authenticated",
+ "operationId": "users/list-public-emails-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
@@ -362732,7 +362700,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#accept-a-repository-invitation"
@@ -362850,7 +362818,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#decline-a-repository-invitation"
diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json
index 35b62f481c..3eb2b3242f 100644
--- a/lib/rest/static/dereferenced/github.ae.deref.json
+++ b/lib/rest/static/dereferenced/github.ae.deref.json
@@ -119420,6 +119420,149 @@
}
}
},
+ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
+ "post": {
+ "summary": "Rerequest a check run",
+ "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
+ "tags": [
+ "checks"
+ ],
+ "operationId": "checks/rerequest-run",
+ "externalDocs": {
+ "description": "API method documentation",
+ "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-run"
+ },
+ "parameters": [
+ {
+ "name": "owner",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "check_run_id",
+ "description": "check_run_id parameter",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ },
+ "additionalProperties": false
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation error if the check run is not rerequestable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Basic Error",
+ "description": "Basic Error",
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "documentation_url": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "x-github": {
+ "githubCloudOnly": false,
+ "enabledForGitHubApps": true,
+ "previews": [
+
+ ],
+ "category": "checks",
+ "subcategory": "runs"
+ }
+ }
+ },
"/repos/{owner}/{repo}/check-suites": {
"post": {
"summary": "Create a check suite",
@@ -237643,28 +237786,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"409": {
"description": "Conflict",
"content": {
@@ -237695,13 +237816,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "previews": [
- {
- "required": true,
- "name": "switcheroo",
- "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
- }
- ],
"category": "repos",
"subcategory": "pages"
}
@@ -238070,28 +238184,6 @@
}
}
},
- "415": {
- "description": "Preview header missing",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message",
- "documentation_url"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "documentation_url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
"404": {
"description": "Resource not found",
"content": {
@@ -238122,13 +238214,6 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
- "previews": [
- {
- "required": true,
- "name": "switcheroo",
- "note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
- }
- ],
"category": "repos",
"subcategory": "pages"
}
@@ -309534,7 +309619,7 @@
"tags": [
"users"
],
- "operationId": "users/list-followed-by-authenticated",
+ "operationId": "users/list-followed-by-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-the-people-the-authenticated-user-follows"
@@ -310150,7 +310235,7 @@
"tags": [
"users"
],
- "operationId": "users/list-gpg-keys-for-authenticated",
+ "operationId": "users/list-gpg-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
@@ -310493,7 +310578,7 @@
"post": {
"summary": "Create a GPG key for the authenticated user",
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-gpg-key-for-authenticated",
+ "operationId": "users/create-gpg-key-for-authenticated-user",
"tags": [
"users"
],
@@ -310902,7 +310987,7 @@
"tags": [
"users"
],
- "operationId": "users/get-gpg-key-for-authenticated",
+ "operationId": "users/get-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
@@ -311226,7 +311311,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-gpg-key-for-authenticated",
+ "operationId": "users/delete-gpg-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
@@ -313738,7 +313823,7 @@
"tags": [
"apps"
],
- "operationId": "apps/add-repo-to-installation",
+ "operationId": "apps/add-repo-to-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#add-a-repository-to-an-app-installation"
@@ -313838,7 +313923,7 @@
"tags": [
"apps"
],
- "operationId": "apps/remove-repo-from-installation",
+ "operationId": "apps/remove-repo-from-installation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#remove-a-repository-from-an-app-installation"
@@ -316689,7 +316774,7 @@
"tags": [
"users"
],
- "operationId": "users/list-public-ssh-keys-for-authenticated",
+ "operationId": "users/list-public-ssh-keys-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
@@ -316890,7 +316975,7 @@
"post": {
"summary": "Create a public SSH key for the authenticated user",
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
- "operationId": "users/create-public-ssh-key-for-authenticated",
+ "operationId": "users/create-public-ssh-key-for-authenticated-user",
"tags": [
"users"
],
@@ -317154,7 +317239,7 @@
"tags": [
"users"
],
- "operationId": "users/get-public-ssh-key-for-authenticated",
+ "operationId": "users/get-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
@@ -317327,7 +317412,7 @@
"tags": [
"users"
],
- "operationId": "users/delete-public-ssh-key-for-authenticated",
+ "operationId": "users/delete-public-ssh-key-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
@@ -324793,7 +324878,7 @@
"tags": [
"repos"
],
- "operationId": "repos/accept-invitation",
+ "operationId": "repos/accept-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#accept-a-repository-invitation"
@@ -324911,7 +324996,7 @@
"tags": [
"repos"
],
- "operationId": "repos/decline-invitation",
+ "operationId": "repos/decline-invitation-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#decline-a-repository-invitation"
From 33153c801edba3b130033283ecd676fd7ff4ae93 Mon Sep 17 00:00:00 2001
From: Grey Baker