diff --git a/content/copilot/how-tos/set-up/install-copilot-extension.md b/content/copilot/how-tos/set-up/install-copilot-extension.md index 479e4be42ce8..17dbe8a0001c 100644 --- a/content/copilot/how-tos/set-up/install-copilot-extension.md +++ b/content/copilot/how-tos/set-up/install-copilot-extension.md @@ -237,7 +237,7 @@ To see instructions for other popular coding environments, use the tool switcher ### Version compatibility -To use the {% data variables.product.prodname_copilot %} extension, you must have Eclipse version 2024-09 or above. See the [Eclipse download page](https://www.eclipse.org/downloads/packages/). +To use the {% data variables.product.prodname_copilot %} extension, you must have Eclipse version 2024-03 or above. See the [Eclipse download page](https://www.eclipse.org/downloads/packages/). ## Installing {% data variables.product.prodname_copilot %} in Eclipse diff --git a/src/audit-logs/data/fpt/organization.json b/src/audit-logs/data/fpt/organization.json index 4b26008f0fe8..2775c80f2009 100644 --- a/src/audit-logs/data/fpt/organization.json +++ b/src/audit-logs/data/fpt/organization.json @@ -16608,7 +16608,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghec/enterprise.json b/src/audit-logs/data/ghec/enterprise.json index 488ea8c10c09..47af0c8471d8 100644 --- a/src/audit-logs/data/ghec/enterprise.json +++ b/src/audit-logs/data/ghec/enterprise.json @@ -19855,7 +19855,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghec/organization.json b/src/audit-logs/data/ghec/organization.json index 4b26008f0fe8..2775c80f2009 100644 --- a/src/audit-logs/data/ghec/organization.json +++ b/src/audit-logs/data/ghec/organization.json @@ -16608,7 +16608,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.14/enterprise.json b/src/audit-logs/data/ghes-3.14/enterprise.json index 40a8ca92fe9b..3681a2d3ca57 100644 --- a/src/audit-logs/data/ghes-3.14/enterprise.json +++ b/src/audit-logs/data/ghes-3.14/enterprise.json @@ -15932,7 +15932,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.14/organization.json b/src/audit-logs/data/ghes-3.14/organization.json index 1c5bf8486f07..9ae1386294e8 100644 --- a/src/audit-logs/data/ghes-3.14/organization.json +++ b/src/audit-logs/data/ghes-3.14/organization.json @@ -14850,7 +14850,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.15/enterprise.json b/src/audit-logs/data/ghes-3.15/enterprise.json index 8518f3aad287..48df946a2ecb 100644 --- a/src/audit-logs/data/ghes-3.15/enterprise.json +++ b/src/audit-logs/data/ghes-3.15/enterprise.json @@ -16131,7 +16131,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.15/organization.json b/src/audit-logs/data/ghes-3.15/organization.json index b323d198ed42..f8a3d8f321e0 100644 --- a/src/audit-logs/data/ghes-3.15/organization.json +++ b/src/audit-logs/data/ghes-3.15/organization.json @@ -15406,7 +15406,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.16/enterprise.json b/src/audit-logs/data/ghes-3.16/enterprise.json index b57e39b5cf88..2e24f4d3b53c 100644 --- a/src/audit-logs/data/ghes-3.16/enterprise.json +++ b/src/audit-logs/data/ghes-3.16/enterprise.json @@ -16845,7 +16845,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.16/organization.json b/src/audit-logs/data/ghes-3.16/organization.json index 478fd47c1d70..e46c69dcd0ef 100644 --- a/src/audit-logs/data/ghes-3.16/organization.json +++ b/src/audit-logs/data/ghes-3.16/organization.json @@ -15869,7 +15869,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.17/enterprise.json b/src/audit-logs/data/ghes-3.17/enterprise.json index d3266bf26467..5d81f5afa700 100644 --- a/src/audit-logs/data/ghes-3.17/enterprise.json +++ b/src/audit-logs/data/ghes-3.17/enterprise.json @@ -17292,7 +17292,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.17/organization.json b/src/audit-logs/data/ghes-3.17/organization.json index 9606601bc5d8..fad68e744cf9 100644 --- a/src/audit-logs/data/ghes-3.17/organization.json +++ b/src/audit-logs/data/ghes-3.17/organization.json @@ -16284,7 +16284,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.18/enterprise.json b/src/audit-logs/data/ghes-3.18/enterprise.json index 9a77838faeca..6be50022e246 100644 --- a/src/audit-logs/data/ghes-3.18/enterprise.json +++ b/src/audit-logs/data/ghes-3.18/enterprise.json @@ -17395,7 +17395,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/data/ghes-3.18/organization.json b/src/audit-logs/data/ghes-3.18/organization.json index c84310dea773..8c307292790d 100644 --- a/src/audit-logs/data/ghes-3.18/organization.json +++ b/src/audit-logs/data/ghes-3.18/organization.json @@ -16583,7 +16583,7 @@ "programmatic_access_type", "request_access_security_header" ], - "docs_reference_titles": "Canceling a workflow" + "docs_reference_titles": "Canceling a workflow run" }, { "action": "workflows.comment_workflow_job", diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 3424283b3609..14229ade1cd4 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -9,5 +9,5 @@ "git": "Note: Git events have special access requirements and retention policies that differ from other audit log events. For GitHub Enterprise Cloud, access Git events via the REST API only with 7-day retention. For GitHub Enterprise Server, Git events must be enabled in audit log configuration and are not included in search results.", "sso_redirect": "Note: Automatically redirecting users to sign in is currently in beta for Enterprise Managed Users and subject to change." }, - "sha": "33b69baa355213d39a04223178396f3d0f2614e9" + "sha": "b74dd07094cbdc7d8bc60c1485a38c25c2eab0b0" } \ No newline at end of file diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json index dd3abb0e2898..fe2b64849961 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json @@ -1314,8 +1314,8 @@ ] }, "organization_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Organization permissions for \"Pre-receive hooks\"", + "title": "Organization pre-receive hooks", + "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", "permissions": [ { "category": "enterprise-admin", @@ -5492,48 +5492,6 @@ } ] }, - "repository_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Repository permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", @@ -6107,6 +6065,48 @@ } ] }, + "repository_pre_receive_hooks": { + "title": "Repository pre-receive hooks", + "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + } + ] + }, "secret_scanning_alerts": { "title": "Secret scanning alerts", "displayTitle": "Repository permissions for \"Secret scanning alerts\"", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json index 5d4fa3f85ad4..34c465209cf7 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json @@ -1593,6 +1593,56 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Organization pre-receive hooks", + "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "patch", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "delete", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "organization_personal_access_token_requests": { "title": "Personal access token requests", "displayTitle": "Organization permissions for \"Personal access token requests\"", @@ -1693,56 +1743,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Organization permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -6923,56 +6923,6 @@ } ] }, - "repository_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Repository permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, "repository_projects": { "title": "Projects", "displayTitle": "Repository permissions for \"Projects\"", @@ -7909,6 +7859,56 @@ } ] }, + "repository_pre_receive_hooks": { + "title": "Repository pre-receive hooks", + "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "secret_scanning_alerts": { "title": "Secret scanning alerts", "displayTitle": "Repository permissions for \"Secret scanning alerts\"", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json index 5c759e8b976d..f428927179a2 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json @@ -1404,8 +1404,8 @@ ] }, "organization_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Organization permissions for \"Pre-receive hooks\"", + "title": "Organization pre-receive hooks", + "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", "permissions": [ { "category": "enterprise-admin", @@ -5600,48 +5600,6 @@ } ] }, - "repository_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Repository permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", @@ -6215,6 +6173,48 @@ } ] }, + "repository_pre_receive_hooks": { + "title": "Repository pre-receive hooks", + "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + } + ] + }, "secret_scanning_alerts": { "title": "Secret scanning alerts", "displayTitle": "Repository permissions for \"Secret scanning alerts\"", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json index bb4ebc536f78..20881a9ea10a 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json @@ -1703,6 +1703,56 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Organization pre-receive hooks", + "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "patch", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "delete", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "organization_personal_access_token_requests": { "title": "Personal access token requests", "displayTitle": "Organization permissions for \"Personal access token requests\"", @@ -1803,56 +1853,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Organization permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -7055,56 +7055,6 @@ } ] }, - "repository_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Repository permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, "repository_projects": { "title": "Projects", "displayTitle": "Repository permissions for \"Projects\"", @@ -8041,6 +7991,56 @@ } ] }, + "repository_pre_receive_hooks": { + "title": "Repository pre-receive hooks", + "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "secret_scanning_alerts": { "title": "Secret scanning alerts", "displayTitle": "Repository permissions for \"Secret scanning alerts\"", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json index f85e3c79b49f..aa93f29c5ffd 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json @@ -1403,6 +1403,48 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Organization pre-receive hooks", + "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "patch", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "delete", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + } + ] + }, "organization_private_registries": { "title": "Organization private registries", "displayTitle": "Organization permissions for \"Organization private registries\"", @@ -1454,48 +1496,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Organization permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -5651,48 +5651,6 @@ } ] }, - "repository_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Repository permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", @@ -6266,6 +6224,48 @@ } ] }, + "repository_pre_receive_hooks": { + "title": "Repository pre-receive hooks", + "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + } + ] + }, "secret_scanning_alerts": { "title": "Secret scanning alerts", "displayTitle": "Repository permissions for \"Secret scanning alerts\"", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json index 1bbc62e01ceb..27873c343c17 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json @@ -1703,6 +1703,56 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Organization pre-receive hooks", + "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "patch", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "delete", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "organization_private_registries": { "title": "Organization private registries", "displayTitle": "Organization permissions for \"Organization private registries\"", @@ -1864,56 +1914,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Organization permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -7116,56 +7116,6 @@ } ] }, - "repository_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Repository permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, "repository_projects": { "title": "Projects", "displayTitle": "Repository permissions for \"Projects\"", @@ -8102,6 +8052,56 @@ } ] }, + "repository_pre_receive_hooks": { + "title": "Repository pre-receive hooks", + "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "secret_scanning_alerts": { "title": "Secret scanning alerts", "displayTitle": "Repository permissions for \"Secret scanning alerts\"", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json index bc0af8eafa2f..81736f19e0d1 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json @@ -1454,6 +1454,48 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Organization pre-receive hooks", + "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "patch", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "delete", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + } + ] + }, "organization_private_registries": { "title": "Organization private registries", "displayTitle": "Organization permissions for \"Organization private registries\"", @@ -1505,48 +1547,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Organization permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -5720,48 +5720,6 @@ } ] }, - "repository_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Repository permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "additional-permissions": false, - "access": "write" - } - ] - }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", @@ -6335,6 +6293,48 @@ } ] }, + "repository_pre_receive_hooks": { + "title": "Repository pre-receive hooks", + "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "additional-permissions": false, + "access": "write" + } + ] + }, "secret_scanning_alerts": { "title": "Secret scanning alerts", "displayTitle": "Repository permissions for \"Secret scanning alerts\"", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json index 796545861df6..049982444a9f 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json @@ -1764,6 +1764,56 @@ } ] }, + "organization_pre_receive_hooks": { + "title": "Organization pre-receive hooks", + "displayTitle": "Organization permissions for \"Organization pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "get", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "patch", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-an-organization", + "subcategory": "org-pre-receive-hooks", + "verb": "delete", + "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "organization_private_registries": { "title": "Organization private registries", "displayTitle": "Organization permissions for \"Organization private registries\"", @@ -1925,56 +1975,6 @@ } ] }, - "organization_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Organization permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "get", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "patch", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-an-organization", - "subcategory": "org-pre-receive-hooks", - "verb": "delete", - "requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, "organization_projects": { "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", @@ -7199,56 +7199,6 @@ } ] }, - "repository_pre_receive_hooks": { - "title": "Pre-receive hooks", - "displayTitle": "Repository permissions for \"Pre-receive hooks\"", - "permissions": [ - { - "category": "enterprise-admin", - "slug": "list-pre-receive-hooks-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "get-a-pre-receive-hook-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "update-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "enterprise-admin", - "slug": "remove-pre-receive-hook-enforcement-for-a-repository", - "subcategory": "repo-pre-receive-hooks", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "access": "write", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - } - ] - }, "repository_projects": { "title": "Projects", "displayTitle": "Repository permissions for \"Projects\"", @@ -8185,6 +8135,56 @@ } ] }, + "repository_pre_receive_hooks": { + "title": "Repository pre-receive hooks", + "displayTitle": "Repository permissions for \"Repository pre-receive hooks\"", + "permissions": [ + { + "category": "enterprise-admin", + "slug": "list-pre-receive-hooks-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "get-a-pre-receive-hook-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "update-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "enterprise-admin", + "slug": "remove-pre-receive-hook-enforcement-for-a-repository", + "subcategory": "repo-pre-receive-hooks", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "secret_scanning_alerts": { "title": "Secret scanning alerts", "displayTitle": "Repository permissions for \"Secret scanning alerts\"", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 0e46bf1330af..b0cecd8da929 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "1a8e746d3e6e8faaef13ee92434686571cccb992" + "sha": "ecbe0df804f3f85f8a68f48d6e9711d05da6f201" } \ No newline at end of file diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index c602d99dcdc9..700418c037f0 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -264,13 +264,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all artifacts for a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all artifacts for a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -1228,13 +1228,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -1468,13 +1468,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2014,13 +2014,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3178,13 +3178,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5728,13 +5728,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6174,13 +6174,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6499,13 +6499,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -8427,13 +8427,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9784,13 +9784,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10665,13 +10665,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -11069,13 +11069,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -11463,13 +11463,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -17355,13 +17355,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -21084,13 +21084,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -23670,13 +23670,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -26740,13 +26740,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -38174,13 +38174,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific workflow run attempt.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific workflow run attempt.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -43800,13 +43800,13 @@ } ], "previews": [], + "descriptionHTML": "

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -59085,13 +59085,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -90544,13 +90544,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -90729,13 +90729,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes the announcement banner currently set for the organization.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes the announcement banner currently set for the organization.

" + ] } ] }, @@ -99867,13 +99867,13 @@ } ], "previews": [], + "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -132089,6 +132089,7 @@ } ], "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

", "statusCodes": [ { "httpStatusCode": "200", @@ -132098,8 +132099,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -139790,13 +139790,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -163289,13 +163289,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -187025,13 +187025,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -188805,13 +188805,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -189175,13 +189175,13 @@ } ], "previews": [], + "descriptionHTML": "

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

" + ] } ] }, @@ -200984,13 +200984,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -201483,13 +201483,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] } ], "announcement": [ @@ -205298,6 +205298,7 @@ } ], "previews": [], + "descriptionHTML": "

Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.

\n

Note

\n

\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.

\n
", "statusCodes": [ { "httpStatusCode": "201", @@ -205315,8 +205316,7 @@ "httpStatusCode": "500", "description": "

Internal error

" } - ], - "descriptionHTML": "

Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.

\n

Note

\n

\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME", @@ -208177,7 +208177,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "read" + "\"Organization pre-receive hooks\" organization permissions": "read" } ] }, @@ -208273,7 +208273,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "read" + "\"Organization pre-receive hooks\" organization permissions": "read" } ] }, @@ -208378,7 +208378,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "write" + "\"Organization pre-receive hooks\" organization permissions": "write" } ] }, @@ -208433,13 +208433,13 @@ } ], "previews": [], + "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -208475,7 +208475,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "write" + "\"Organization pre-receive hooks\" organization permissions": "write" } ] }, @@ -210517,7 +210517,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "read" + "\"Repository pre-receive hooks\" repository permissions": "read" } ] }, @@ -210619,7 +210619,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "read" + "\"Repository pre-receive hooks\" repository permissions": "read" } ] }, @@ -210729,7 +210729,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "write" + "\"Repository pre-receive hooks\" repository permissions": "write" } ] }, @@ -210831,7 +210831,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "write" + "\"Repository pre-receive hooks\" repository permissions": "write" } ] }, @@ -220137,13 +220137,13 @@ } ], "previews": [], + "descriptionHTML": "

You can demote any user account except your own.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

You can demote any user account except your own.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -269877,6 +269877,7 @@ } ], "previews": [], + "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -269890,8 +269891,7 @@ "httpStatusCode": "410", "description": "

Gone

" } - ], - "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -293455,13 +293455,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists labels for issues in a milestone.

" + ] } ], "milestones": [ @@ -316078,13 +316078,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -338554,13 +338554,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Response - list of custom role names

" } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -340118,13 +340118,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" + ] } ], "members": [ @@ -344828,13 +344828,13 @@ } ], "previews": [], + "descriptionHTML": "

Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -357454,6 +357454,7 @@ } ], "previews": [], + "descriptionHTML": "

Delete a ruleset for an organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -357467,8 +357468,7 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ], - "descriptionHTML": "

Delete a ruleset for an organization.

" + ] } ], "security-managers": [ @@ -358916,13 +358916,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -372585,13 +372585,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific package metadata for a public package owned by a user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific package metadata for a public package owned by a user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -408342,13 +408342,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -424333,13 +424333,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n
\n

Delete a reaction to a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Note

\n

\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n
\n

Delete a reaction to a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -453908,6 +453908,7 @@ } ], "previews": [], + "descriptionHTML": "

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -453917,8 +453918,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -524991,13 +524991,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.

\n
\n

List all discussions on a team's page.

\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.

\n
\n

List all discussions on a team's page.

\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -527034,13 +527034,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists a connection between a team and an external group.

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists a connection between a team and an external group.

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 4401ffb50d41..132e2ad4fa27 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -479,13 +479,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific artifact for a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific artifact for a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -1152,13 +1152,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the GitHub Actions cache usage policy for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Sets the GitHub Actions cache usage policy for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -1228,13 +1228,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3420,13 +3420,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5112,13 +5112,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5461,13 +5461,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9736,13 +9736,13 @@ } ], "previews": [], - "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10462,13 +10462,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10537,13 +10537,13 @@ } ], "previews": [], - "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10677,13 +10677,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10883,13 +10883,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -13706,13 +13706,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -20428,7 +20428,6 @@ } ], "previews": [], - "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -20442,7 +20441,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -20707,7 +20707,6 @@ } ], "previews": [], - "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -20721,7 +20720,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.

\n

This endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -20966,13 +20966,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -23768,7 +23768,6 @@ } ], "previews": [], - "descriptionHTML": "

Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -23778,7 +23777,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -24721,13 +24721,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -26899,13 +26899,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific variable in a repository.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific variable in a repository.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -59271,13 +59271,13 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -88644,13 +88644,13 @@ } ], "previews": [], - "descriptionHTML": "

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -91041,13 +91041,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes the announcement banner currently set for the organization.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes the announcement banner currently set for the organization.

" } ] }, @@ -100255,13 +100255,13 @@ } ], "previews": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -140374,13 +140374,13 @@ } ], "previews": [], - "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -163495,7 +163495,6 @@ } ], "previews": [], - "descriptionHTML": "

Returns array of all GitHub's codes of conduct.

", "statusCodes": [ { "httpStatusCode": "200", @@ -163505,7 +163504,8 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ] + ], + "descriptionHTML": "

Returns array of all GitHub's codes of conduct.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -190137,13 +190137,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -205207,13 +205207,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -205391,13 +205391,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211074,7 +211074,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "read" + "\"Organization pre-receive hooks\" organization permissions": "read" } ] }, @@ -211170,7 +211170,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "read" + "\"Organization pre-receive hooks\" organization permissions": "read" } ] }, @@ -211275,7 +211275,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "write" + "\"Organization pre-receive hooks\" organization permissions": "write" } ] }, @@ -211372,7 +211372,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "write" + "\"Organization pre-receive hooks\" organization permissions": "write" } ] }, @@ -211422,13 +211422,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes any overrides for this hook at the org level for this org.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Removes any overrides for this hook at the org level for this org.

" } ], "orgs": [ @@ -213414,7 +213414,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "read" + "\"Repository pre-receive hooks\" repository permissions": "read" } ] }, @@ -213516,7 +213516,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "read" + "\"Repository pre-receive hooks\" repository permissions": "read" } ] }, @@ -213626,7 +213626,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "write" + "\"Repository pre-receive hooks\" repository permissions": "write" } ] }, @@ -213677,13 +213677,13 @@ } ], "previews": [], - "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -213728,7 +213728,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "write" + "\"Repository pre-receive hooks\" repository permissions": "write" } ] }, @@ -236940,7 +236940,6 @@ } ], "previews": [], - "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "201", @@ -236958,7 +236957,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Creates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -266236,13 +266236,13 @@ } ], "previews": [], - "descriptionHTML": "

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -296574,13 +296574,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists labels for issues in a milestone.

" } ], "milestones": [ @@ -316674,13 +316674,13 @@ } ], "previews": [], - "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -319305,13 +319305,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -341883,13 +341883,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Response - list of custom role names

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -343355,13 +343355,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -345385,13 +345385,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -357619,7 +357619,6 @@ } ], "previews": [], - "descriptionHTML": "

Create a repository ruleset for an organization.

", "statusCodes": [ { "httpStatusCode": "201", @@ -357633,7 +357632,8 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ] + ], + "descriptionHTML": "

Create a repository ruleset for an organization.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -362492,7 +362492,6 @@ } ], "previews": [], - "descriptionHTML": "

Delete a webhook for an organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "204", @@ -362502,7 +362501,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Delete a webhook for an organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -370508,7 +370508,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists packages owned by the authenticated user within the user's namespace.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -370518,7 +370517,8 @@ "httpStatusCode": "400", "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" } - ] + ], + "descriptionHTML": "

Lists packages owned by the authenticated user within the user's namespace.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -372449,13 +372449,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific package version for a package owned by the authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific package version for a package owned by the authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -377080,13 +377080,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -378537,13 +378537,13 @@ } ], "previews": [], - "descriptionHTML": "

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

\n

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

\n

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -410226,13 +410226,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -426330,13 +426330,13 @@ } ], "previews": [], - "descriptionHTML": "

List the reactions to a team discussion comment.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

List the reactions to a team discussion comment.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -430311,13 +430311,13 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue comment.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue comment.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -465061,13 +465061,13 @@ } } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } ], + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

", "previews": [ "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] @@ -483588,7 +483588,6 @@ } ], "previews": [], - "descriptionHTML": "

Enables Git LFS for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "202", @@ -483598,7 +483597,8 @@ "httpStatusCode": "403", "description": "

We will return a 403 with one of the following messages:

\n" } - ] + ], + "descriptionHTML": "

Enables Git LFS for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -513111,13 +513111,13 @@ } ], "previews": [], - "descriptionHTML": "

To delete a team, the authenticated user must be an organization owner or team maintainer.

\n

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.

\n
", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

To delete a team, the authenticated user must be an organization owner or team maintainer.

\n

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -519775,7 +519775,6 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -519785,7 +519784,8 @@ "httpStatusCode": "404", "description": "

Not Found if project is not managed by this team

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -527125,13 +527125,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.

\n
\n

Deletes a comment on a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.

\n
\n

Deletes a comment on a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" } ], "discussions": [ @@ -527647,13 +527647,13 @@ } ], "previews": [], - "descriptionHTML": "

List all discussions on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

List all discussions on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -528148,13 +528148,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new discussion post on a team's page.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Creates a new discussion post on a team's page.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index a9de65514eb8..bb4da0c18b24 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -1364,13 +1364,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2634,13 +2634,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2961,13 +2961,13 @@ } ], "previews": [], - "descriptionHTML": "

Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3178,13 +3178,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5461,13 +5461,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6066,13 +6066,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6174,13 +6174,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9433,13 +9433,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9796,13 +9796,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10677,13 +10677,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10883,13 +10883,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -11224,13 +11224,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner group for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific self-hosted runner group for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -12644,13 +12644,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the repositories with access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the repositories with access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -12723,13 +12723,13 @@ } ], "previews": [], - "descriptionHTML": "

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -13269,13 +13269,13 @@ } ], "previews": [], - "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -17379,13 +17379,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18681,13 +18681,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19745,13 +19745,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19989,7 +19989,6 @@ } ], "previews": [], - "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -19999,7 +19998,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -24827,13 +24827,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Response when creating a variable

" } - ] + ], + "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -26776,13 +26776,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Creates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -40453,13 +40453,13 @@ } ], "previews": [], - "descriptionHTML": "

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -43564,13 +43564,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the workflows in a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the workflows in a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -79753,7 +79753,6 @@ } ], "previews": [], - "descriptionHTML": "

List all notifications for the current user, sorted by most recently updated.

", "statusCodes": [ { "httpStatusCode": "200", @@ -79775,7 +79774,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

List all notifications for the current user, sorted by most recently updated.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -100313,13 +100313,13 @@ } ], "previews": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -200130,13 +200130,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the deployment branch policies for an environment.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the deployment branch policies for an environment.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209022,13 +209022,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209337,13 +209337,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209584,13 +209584,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" } ], "announcement": [ @@ -209671,13 +209671,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the current message and expiration date of the global announcement banner in your enterprise.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the current message and expiration date of the global announcement banner in your enterprise.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209819,13 +209819,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes the global announcement banner in your enterprise.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes the global announcement banner in your enterprise.

" } ], "audit-log": [ @@ -216258,7 +216258,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "read" + "\"Organization pre-receive hooks\" organization permissions": "read" } ] }, @@ -216354,7 +216354,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "read" + "\"Organization pre-receive hooks\" organization permissions": "read" } ] }, @@ -216459,7 +216459,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "write" + "\"Organization pre-receive hooks\" organization permissions": "write" } ] }, @@ -216556,7 +216556,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "write" + "\"Organization pre-receive hooks\" organization permissions": "write" } ] }, @@ -218598,7 +218598,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "read" + "\"Repository pre-receive hooks\" repository permissions": "read" } ] }, @@ -218700,7 +218700,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "read" + "\"Repository pre-receive hooks\" repository permissions": "read" } ] }, @@ -218810,7 +218810,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "write" + "\"Repository pre-receive hooks\" repository permissions": "write" } ] }, @@ -218912,7 +218912,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "write" + "\"Repository pre-receive hooks\" repository permissions": "write" } ] }, @@ -277242,13 +277242,13 @@ } ], "previews": [], - "descriptionHTML": "

You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -301805,13 +301805,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists labels for issues in a milestone.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists labels for issues in a milestone.

" } ], "milestones": [ @@ -321905,13 +321905,13 @@ } ], "previews": [], - "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -322192,13 +322192,13 @@ } ], "previews": [], - "descriptionHTML": "

Get a random sentence from the Zen of GitHub

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get a random sentence from the Zen of GitHub

" } ] }, @@ -345107,13 +345107,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:read scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:read scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -347577,13 +347577,13 @@ } ], "previews": [], - "descriptionHTML": "

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Response - list of custom role names

" } - ] + ], + "descriptionHTML": "

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -348249,7 +348249,6 @@ } ], "previews": [], - "descriptionHTML": "

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -348259,7 +348258,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -349212,7 +349212,6 @@ } ], "previews": [], - "descriptionHTML": "

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

\n

Note

\n

\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.

\n
", "statusCodes": [ { "httpStatusCode": "204", @@ -349222,7 +349221,8 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ] + ], + "descriptionHTML": "

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

\n

Note

\n

\nIf a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -367944,13 +367944,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -539020,13 +539020,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index 11a47f4e5d62..f3c35733c5a2 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -217060,7 +217060,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "read" + "\"Organization pre-receive hooks\" organization permissions": "read" } ] }, @@ -217156,7 +217156,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "read" + "\"Organization pre-receive hooks\" organization permissions": "read" } ] }, @@ -217261,7 +217261,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "write" + "\"Organization pre-receive hooks\" organization permissions": "write" } ] }, @@ -217358,7 +217358,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" organization permissions": "write" + "\"Organization pre-receive hooks\" organization permissions": "write" } ] }, @@ -219400,7 +219400,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "read" + "\"Repository pre-receive hooks\" repository permissions": "read" } ] }, @@ -219502,7 +219502,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "read" + "\"Repository pre-receive hooks\" repository permissions": "read" } ] }, @@ -219612,7 +219612,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "write" + "\"Repository pre-receive hooks\" repository permissions": "write" } ] }, @@ -219714,7 +219714,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Pre-receive hooks\" repository permissions": "write" + "\"Repository pre-receive hooks\" repository permissions": "write" } ] }, diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index f337a05ee2ef..566793242c79 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "1a8e746d3e6e8faaef13ee92434686571cccb992" + "sha": "ecbe0df804f3f85f8a68f48d6e9711d05da6f201" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 1b14ce565696..4a1c572945bc 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "1a8e746d3e6e8faaef13ee92434686571cccb992" + "sha": "ecbe0df804f3f85f8a68f48d6e9711d05da6f201" } \ No newline at end of file pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy