jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #39548 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
docs-bot
2025-07-28 02:37:25 -07:00
committed by GitHub
parent 80559c7168 5640679fb7
commit 9778bc6df5
4 changed files with 330 additions and 326 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md
View File

@@ -14,7 +14,10 @@ topics:
{% data reusables.repositories.you-can-fork %} {% data reusables.repositories.you-can-fork %}
If you fork a private repository that belongs to a personal account, external collaborators also get access to the fork. If you fork a private {% ifversion ghec or ghes %}or internal {% endif %}repository that belongs to an organization, teams within the organization get access to the fork, but external collaborators do not. You can add an external collaborator to a fork of a private repository that belongs to an organization if you are an owner of that organization or if your organization allows repository administrators to invite external collaborators.{% ifversion ghec or ghes %} You can add an external collaborator to a fork of an internal repository that belongs to an organization if the external collaborator also has access to the upstream repository.{% endif %} * If you fork a private repository that belongs to a personal account, external collaborators also get access to the fork.
* If you fork a private {% ifversion ghec or ghes %}or internal {% endif %}repository that belongs to an organization, teams within the organization get access to the fork, but external collaborators do not.
* {% ifversion ghes %} You can add an external collaborator to a fork of a private repository that belongs to an organization if you are an owner of that organization or if your organization allows repository administrators to invite external collaborators.{% endif %}{% ifversion fpt or ghec %} You can add an external collaborator to a fork of a private repository owned by an organization if you are an organization owner, or if your organization allows repository administrators to invite external collaborators, and the external collaborator also has access to the upstream repository.{% endif %}
{% ifversion ghec or ghes %} * You can add an external collaborator to a fork of an internal repository that belongs to an organization if the external collaborator also has access to the upstream repository.{% endif %}
{% ifversion fpt or ghec %} {% ifversion fpt or ghec %}
@@ -64,6 +67,7 @@ If you work with forks, or if you're the owner of a repository or organization t
### About forks within an organization ### About forks within an organization
Forks within the same organization copy the collaborators and team settings of their upstream repositories. If a repository is owned by an organization: Forks within the same organization copy the collaborators and team settings of their upstream repositories. If a repository is owned by an organization:
* That organization controls the permissions of its forks. * That organization controls the permissions of its forks.
* Any teams from the upstream permission structure that exist and are visible in the target organization or user namespace will have their permissions copied. * Any teams from the upstream permission structure that exist and are visible in the target organization or user namespace will have their permissions copied.
* Admin permissions remain with the upstream owner, except when a user forks into a different organization. * Admin permissions remain with the upstream owner, except when a user forks into a different organization.

276
src/rest/data/ghes-3.14-2022-11-28/schema.json
View File

File diff suppressed because it is too large Load Diff

210
src/rest/data/ghes-3.15-2022-11-28/schema.json
View File

@@ -479,13 +479,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific artifact for a workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific artifact for a workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -1152,13 +1152,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Sets the GitHub Actions cache usage policy for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Sets the GitHub Actions cache usage policy for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -1228,13 +1228,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>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.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -3420,13 +3420,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> organization permission to use this API.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> organization permission to use this API.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5112,13 +5112,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization\">Setting the permissions of the GITHUB_TOKEN for your organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization\">Setting the permissions of the GITHUB_TOKEN for your organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5461,13 +5461,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9736,13 +9736,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10462,13 +10462,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10537,13 +10537,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10677,13 +10677,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10883,13 +10883,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13706,13 +13706,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -20428,6 +20428,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -20441,8 +20442,7 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
], ]
"descriptionHTML": "<p>Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -20707,6 +20707,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.</p>\n<p>This endpoint returns a <code>404 Not Found</code> status if the custom label is not\npresent on the runner.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -20720,8 +20721,7 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
], ]
"descriptionHTML": "<p>Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.</p>\n<p>This endpoint returns a <code>404 Not Found</code> status if the custom label is not\npresent on the runner.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -20966,13 +20966,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all self-hosted runners configured in a repository.</p>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all self-hosted runners configured in a repository.</p>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -23768,6 +23768,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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.</p>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -23777,8 +23778,7 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
], ]
"descriptionHTML": "<p>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.</p>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -24721,13 +24721,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26899,13 +26899,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific variable in a repository.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific variable in a repository.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -59271,13 +59271,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\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.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\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.</p>\n</div>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -88644,13 +88644,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.15/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.15/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -91041,13 +91041,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes the announcement banner currently set for the organization.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Removes the announcement banner currently set for the organization.</p>"
} }
] ]
}, },
@@ -100255,13 +100255,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -140374,13 +140374,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates a check run for a specific commit in a repository.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\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 <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Updates a check run for a specific commit in a repository.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\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 <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -163495,6 +163495,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Returns array of all GitHub's codes of conduct.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -163504,8 +163505,7 @@
"httpStatusCode": "304", "httpStatusCode": "304",
"description": "<p>Not modified</p>" "description": "<p>Not modified</p>"
} }
], ]
"descriptionHTML": "<p>Returns array of all GitHub's codes of conduct.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -190137,13 +190137,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -205207,13 +205207,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -205391,13 +205391,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -211422,13 +211422,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes any overrides for this hook at the org level for this org.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Removes any overrides for this hook at the org level for this org.</p>"
} }
], ],
"orgs": [ "orgs": [
@@ -213677,13 +213677,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>For pre-receive hooks which are allowed to be configured at the repo level, you can set <code>enforcement</code></p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>For pre-receive hooks which are allowed to be configured at the repo level, you can set <code>enforcement</code></p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -236940,6 +236940,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
@@ -236957,8 +236958,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
], ]
"descriptionHTML": "<p>Creates a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -266236,13 +266236,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -296574,13 +296574,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists labels for issues in a milestone.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists labels for issues in a milestone.</p>"
} }
], ],
"milestones": [ "milestones": [
@@ -316674,13 +316674,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -319305,13 +319305,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>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).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -341883,13 +341883,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in the future. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization\">List custom repository roles</a>\" endpoint instead.</p>\n</div>\n<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>Response - list of custom role names</p>" "description": "<p>Response - list of custom role names</p>"
} }
], ]
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in the future. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization\">List custom repository roles</a>\" endpoint instead.</p>\n</div>\n<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -343355,13 +343355,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -345385,13 +345385,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -357619,6 +357619,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Create a repository ruleset for an organization.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
@@ -357632,8 +357633,7 @@
"httpStatusCode": "500", "httpStatusCode": "500",
"description": "<p>Internal Error</p>" "description": "<p>Internal Error</p>"
} }
], ]
"descriptionHTML": "<p>Create a repository ruleset for an organization.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -362492,6 +362492,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Delete a webhook for an organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> 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.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -362501,8 +362502,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
], ]
"descriptionHTML": "<p>Delete a webhook for an organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> 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.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -370508,6 +370508,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists packages owned by the authenticated user within the user's namespace.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -370517,8 +370518,7 @@
"httpStatusCode": "400", "httpStatusCode": "400",
"description": "<p>The value of <code>per_page</code> multiplied by <code>page</code> cannot be greater than 10000.</p>" "description": "<p>The value of <code>per_page</code> multiplied by <code>page</code> cannot be greater than 10000.</p>"
} }
], ]
"descriptionHTML": "<p>Lists packages owned by the authenticated user within the user's namespace.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -372449,13 +372449,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific package version for a package owned by the authenticated user.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific package version for a package owned by the authenticated user.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -377080,13 +377080,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific package version for a public package owned by a specified user.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific package version for a public package owned by a specified user.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -378537,13 +378537,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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.</p>\n<p>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.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>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.</p>\n<p>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.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -410226,13 +410226,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -426330,13 +426330,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -430311,13 +430311,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -465061,13 +465061,13 @@
} }
} }
], ],
"descriptionHTML": "<p>Creates a new repository using a repository template. Use the <code>template_owner</code> and <code>template_repo</code> 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 <a href=\"https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-a-repository\">Get a repository</a> endpoint and check that the <code>is_template</code> key is <code>true</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>public_repo</code> or <code>repo</code> scope to create a public repository, and <code>repo</code> scope to create a private repository.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ],
"descriptionHTML": "<p>Creates a new repository using a repository template. Use the <code>template_owner</code> and <code>template_repo</code> 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 <a href=\"https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-a-repository\">Get a repository</a> endpoint and check that the <code>is_template</code> key is <code>true</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>public_repo</code> or <code>repo</code> scope to create a public repository, and <code>repo</code> scope to create a private repository.</p>",
"previews": [ "previews": [
"<p>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 <a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>" "<p>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 <a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>"
] ]
@@ -483588,6 +483588,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Enables Git LFS for a repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "202", "httpStatusCode": "202",
@@ -483597,8 +483598,7 @@
"httpStatusCode": "403", "httpStatusCode": "403",
"description": "<p>We will return a 403 with one of the following messages:</p>\n<ul>\n<li>Git LFS support not enabled because Git LFS is globally disabled.</li>\n<li>Git LFS support not enabled because Git LFS is disabled for the root repository in the network.</li>\n<li>Git LFS support not enabled because Git LFS is disabled for <owner>.</owner></li>\n</ul>" "description": "<p>We will return a 403 with one of the following messages:</p>\n<ul>\n<li>Git LFS support not enabled because Git LFS is globally disabled.</li>\n<li>Git LFS support not enabled because Git LFS is disabled for the root repository in the network.</li>\n<li>Git LFS support not enabled because Git LFS is disabled for <owner>.</owner></li>\n</ul>"
} }
], ]
"descriptionHTML": "<p>Enables Git LFS for a repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -513111,13 +513111,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.</p>\n</div>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -519775,6 +519775,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -519784,8 +519785,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Not Found if project is not managed by this team</p>" "description": "<p>Not Found if project is not managed by this team</p>"
} }
], ]
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -527125,13 +527125,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment\">Delete a discussion comment</a> endpoint.</p>\n</div>\n<p>Deletes a comment on a team discussion.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment\">Delete a discussion comment</a> endpoint.</p>\n</div>\n<p>Deletes a comment on a team discussion.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
} }
], ],
"discussions": [ "discussions": [
@@ -527647,13 +527647,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>List all discussions on a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>List all discussions on a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -528148,13 +528148,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",

164
src/rest/data/ghes-3.16-2022-11-28/schema.json
View File

@@ -1364,13 +1364,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>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.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2634,13 +2634,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2961,13 +2961,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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 <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>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 <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -3178,13 +3178,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5461,13 +5461,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -6066,13 +6066,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -6174,13 +6174,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9433,13 +9433,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9796,13 +9796,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10677,13 +10677,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10883,13 +10883,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -11224,13 +11224,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -12644,13 +12644,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the repositories with access to a self-hosted runner group configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the repositories with access to a self-hosted runner group configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -12723,13 +12723,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13269,13 +13269,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -17379,13 +17379,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -18681,13 +18681,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -19745,13 +19745,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an organization. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an organization. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -19989,6 +19989,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -19998,8 +19999,7 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
], ]
"descriptionHTML": "<p>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.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -24827,13 +24827,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Response when creating a variable</p>" "description": "<p>Response when creating a variable</p>"
} }
], ]
"descriptionHTML": "<p>Creates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26776,13 +26776,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates a repository variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Creates a repository variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -40453,13 +40453,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Re-run all of the failed jobs and their dependent jobs in a workflow run using the <code>id</code> of the workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Re-run all of the failed jobs and their dependent jobs in a workflow run using the <code>id</code> of the workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -43564,13 +43564,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the workflows in a repository.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the workflows in a repository.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -79753,6 +79753,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>List all notifications for the current user, sorted by most recently updated.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -79774,8 +79775,7 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
], ]
"descriptionHTML": "<p>List all notifications for the current user, sorted by most recently updated.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -100313,13 +100313,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.16/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.16/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -200130,13 +200130,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the deployment branch policies for an environment.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the deployment branch policies for an environment.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209022,13 +209022,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209337,13 +209337,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209584,13 +209584,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
} }
], ],
"announcement": [ "announcement": [
@@ -209671,13 +209671,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the current message and expiration date of the global announcement banner in your enterprise.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the current message and expiration date of the global announcement banner in your enterprise.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209819,13 +209819,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes the global announcement banner in your enterprise.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Removes the global announcement banner in your enterprise.</p>"
} }
], ],
"audit-log": [ "audit-log": [
@@ -277242,13 +277242,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>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.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -301805,13 +301805,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists labels for issues in a milestone.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists labels for issues in a milestone.</p>"
} }
], ],
"milestones": [ "milestones": [
@@ -321905,13 +321905,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -322192,13 +322192,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Get a random sentence from the Zen of GitHub</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Get a random sentence from the Zen of GitHub</p>"
} }
] ]
}, },
@@ -345107,13 +345107,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -347577,13 +347577,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>Response - list of custom role names</p>" "description": "<p>Response - list of custom role names</p>"
} }
], ]
"descriptionHTML": "<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -348249,6 +348249,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -348258,8 +348259,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
], ]
"descriptionHTML": "<p>Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -349212,6 +349212,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>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.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\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.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -349221,8 +349222,7 @@
"httpStatusCode": "403", "httpStatusCode": "403",
"description": "<p>Forbidden</p>" "description": "<p>Forbidden</p>"
} }
], ]
"descriptionHTML": "<p>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.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\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.</p>\n</div>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -367944,13 +367944,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> 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.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> 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.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -539020,13 +539020,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists external groups available in an organization. You can query the groups using the <code>display_name</code> parameter, only groups with a <code>group_name</code> containing the text provided in the <code>display_name</code> parameter will be returned. You can also limit your page results using the <code>per_page</code> parameter. GitHub Enterprise Server generates a url-encoded <code>page</code> token using a cursor value for where the next page begins. For more information on cursor pagination, see \"<a href=\"https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89\">Offset and Cursor Pagination explained</a>.\"</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists external groups available in an organization. You can query the groups using the <code>display_name</code> parameter, only groups with a <code>group_name</code> containing the text provided in the <code>display_name</code> parameter will be returned. You can also limit your page results using the <code>per_page</code> parameter. GitHub Enterprise Server generates a url-encoded <code>page</code> token using a cursor value for where the next page begins. For more information on cursor pagination, see \"<a href=\"https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89\">Offset and Cursor Pagination explained</a>.\"</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",