diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index ff41e428b1e0..0e16264cf593 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -6670,13 +6670,13 @@ } ], "previews": [], - "descriptionHTML": "
Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the self-hosted runners that are in a specific enterprise group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo
or admin:org
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.
\nPaid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"
\nOAuth app tokens and personal access tokens (classic) need the repo
or admin:org
scope to use this endpoint.
Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the user
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the user
scope to use this endpoint.
Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
" }, { "serverUrl": "https://api.github.com", @@ -142699,7 +142699,6 @@ } ], "previews": [], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -142709,7 +142708,8 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
" }, { "serverUrl": "https://api.github.com", @@ -151194,13 +151194,13 @@ } ], "previews": [], - "descriptionHTML": "Gets a single check run using its id
.
Note
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint on a private repository.
OK
" } - ] + ], + "descriptionHTML": "Gets a single check run using its id
.
Note
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint on a private repository.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Response when updating a secret
" } - ] + ], + "descriptionHTML": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Gets a single repository secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a single repository secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Create a new snapshot of a repository's dependencies.
\nThe authenticated user must have access to the repository.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Create a new snapshot of a repository's dependencies.
\nThe authenticated user must have access to the repository.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Updates an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -283855,7 +283854,8 @@ "httpStatusCode": "422", "description": "Validation error
" } - ] + ], + "descriptionHTML": "Updates an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" }, { "serverUrl": "https://api.github.com", @@ -283909,13 +283909,13 @@ } ], "previews": [], - "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "204", "description": "The audit log stream configuration was deleted successfully.
" } - ] + ], + "descriptionHTML": "Deletes an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" } ], "billing": [ @@ -287853,13 +287853,13 @@ } ], "previews": [], - "descriptionHTML": "Gets information about the status of a license sync job for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise
scope to use this endpoint.
License Sync Status Response
" } - ] + ], + "descriptionHTML": "Gets information about the status of a license sync job for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:enterprise
scope to use this endpoint.
Gets a hosted compute network configuration configured in an enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Gets a hosted compute network configuration configured in an enterprise.
" }, { "serverUrl": "https://api.github.com", @@ -322353,7 +322353,6 @@ } ], "previews": [], - "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "statusCodes": [ { "httpStatusCode": "200", @@ -322363,7 +322362,8 @@ "httpStatusCode": "304", "description": "Not modified
" } - ] + ], + "descriptionHTML": "List all templates available to pass as an option when creating a repository.
" }, { "serverUrl": "https://api.github.com", @@ -322679,7 +322679,6 @@ } ], "previews": [], - "descriptionHTML": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
", "statusCodes": [ { "httpStatusCode": "200", @@ -322689,7 +322688,8 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
" }, { "serverUrl": "https://api.github.com", @@ -413522,7 +413522,6 @@ } ], "previews": [], - "descriptionHTML": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
", "statusCodes": [ { "httpStatusCode": "200", @@ -413532,7 +413531,8 @@ "httpStatusCode": "403", "description": "Forbidden
" } - ] + ], + "descriptionHTML": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
" }, { "serverUrl": "https://api.github.com", @@ -432132,13 +432132,13 @@ } ], "previews": [], - "descriptionHTML": "Get API request count statistics for an actor broken down by route within a specified time frame.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Get API request count statistics for an actor broken down by route within a specified time frame.
" }, { "serverUrl": "https://api.github.com", @@ -438712,13 +438712,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.
\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
or repo
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.
\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
or repo
scope to use this endpoint.
Updates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Updates a hosted compute network configuration for an organization.
\nOAuth app tokens and personal access tokens (classic) need the write:network_configurations
scope to use this endpoint.
Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
List all users who are outside collaborators of an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "List all users who are outside collaborators of an organization.
" }, { "serverUrl": "https://api.github.com", @@ -462546,7 +462546,6 @@ } ], "previews": [], - "descriptionHTML": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit webhooks\nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit webhooks\nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
" }, { "serverUrl": "https://api.github.com", @@ -535166,13 +535166,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment
endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment
endpoint.
List the reactions to a team discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nForbidden if the project is not owned by the organization
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
\nDeletes a comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Lists the GitHub Actions caches for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the GitHub Actions caches for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions
to selected
actions, then you cannot override them for the organization.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions
to selected
actions, then you cannot override them for the organization.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Gets the default workflow permissions granted to the GITHUB_TOKEN
when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN
when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Adds a repository to an organization secret when the visibility
for\nrepository access is set to selected
. For more information about setting the visibility, see Create or\nupdate an organization secret.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Conflict when visibility type is not set to selected
" } - ], - "descriptionHTML": "Adds a repository to an organization secret when the visibility
for\nrepository access is set to selected
. For more information about setting the visibility, see Create or\nupdate an organization secret.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Updates the name
and visibility
of a self-hosted runner group in an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Updates the name
and visibility
of a self-hosted runner group in an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists the repositories with access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the repositories with access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see \"Create a self-hosted runner group for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Returns a token that you can pass to the config
script. The token expires after one hour.
For example, you can replace TOKEN
in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\n
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Returns a token that you can pass to the config
script. The token expires after one hour.
For example, you can replace TOKEN
in the following example with the registration token provided by this endpoint to configure your self-hosted runner:
./config.sh --url https://github.com/octo-org --token TOKEN\n
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets a specific job in a workflow run.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a specific job in a workflow run.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Forbidden
" } - ], - "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
Gets a specific workflow run attempt.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Gets a specific workflow run attempt.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
Disables a workflow and sets the state
of the workflow to disabled_manually
. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Disables a workflow and sets the state
of the workflow to disabled_manually
. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template
. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml
type in the Accept
header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nOK
" } - ], - "descriptionHTML": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template
. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml
type in the Accept
header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nEnables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -131740,6 +131740,7 @@ } ], "previews": [], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -131749,8 +131750,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -149905,13 +149905,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a single check suite using its id
.
Note
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array and a null
value for head_branch
.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint on a private repository.
OK
" } - ], - "descriptionHTML": "Gets a single check suite using its id
.
Note
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array and a null
value for head_branch
.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint on a private repository.
Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists all repositories that have been selected when the visibility
\nfor repository access to a secret is set to selected
.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all repositories that have been selected when the visibility
\nfor repository access to a secret is set to selected
.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -202112,13 +202112,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the audit log for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the audit log for an enterprise.
\nThe authenticated user must be an enterprise admin to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers
is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count
field.
Success
" } - ], - "descriptionHTML": "Gets the GitHub Advanced Security active committers for an enterprise per repository.
\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers
is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count
field.
When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST
to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data
data. You can can reference the license file by prefixing the filename with the @
symbol using curl
. For more information, see the curl
documentation.
Internal error
" } - ], - "descriptionHTML": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.
\nImportant
\n\nTo start the configuration process and apply the license, you need to POST
to /manage/v1/config/apply
The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.
\nNote
\n\nThe request body for this operation must be submitted as multipart/form-data
data. You can can reference the license file by prefixing the filename with the @
symbol using curl
. For more information, see the curl
documentation.
Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
", "statusCodes": [ { "httpStatusCode": "200", @@ -220819,8 +220820,7 @@ "httpStatusCode": "403", "description": "Forbidden
" } - ], - "descriptionHTML": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -268970,13 +268970,13 @@ } ], "previews": [], + "descriptionHTML": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -293139,13 +293139,13 @@ } ], "previews": [], + "descriptionHTML": "Updates a label using the given label name.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Updates a label using the given label name.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -293405,13 +293405,13 @@ } ], "previews": [], + "descriptionHTML": "Lists labels for issues in a milestone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists labels for issues in a milestone.
" + ] } ], "milestones": [ @@ -338489,13 +338489,13 @@ } ], "previews": [], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
or repo
scope to use this endpoint.
Response - list of custom role names
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"
\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
or repo
scope to use this endpoint.
Updates the webhook configuration for an organization. To update more information about the webhook, including the active
state and events
, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OK
" } - ], - "descriptionHTML": "Updates the webhook configuration for an organization. To update more information about the webhook, including the active
state and events
, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
This will trigger a ping event\nto be sent to the hook.
\nYou must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Resource not found
" } - ], - "descriptionHTML": "This will trigger a ping event\nto be sent to the hook.
\nYou must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Gets a specific package version in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages
scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package version in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:packages
scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Gets information about a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Gets information about a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Lists pull requests in a specified repository.
\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Lists pull requests in a specified repository.
\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.OK
" } - ], - "descriptionHTML": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github-commitcomment.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github-commitcomment.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.OK
" } - ], - "descriptionHTML": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github-commitcomment.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github-commitcomment.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.Create a reaction to a pull request review comment. A response with an HTTP 200
status means that you already added the reaction type to this pull request review comment.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Create a reaction to a pull request review comment. A response with an HTTP 200
status means that you already added the reaction type to this pull request review comment.
Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis
block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
OK
" } - ], - "descriptionHTML": "Lists repositories for the specified organization.
\nNote
\n\nIn order to see the security_and_analysis
block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
Gets all autolinks that are configured for a repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets all autolinks that are configured for a repository.
\nInformation about autolinks are only available to repository administrators.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -476128,13 +476128,13 @@ } ], "previews": [], + "descriptionHTML": "Disables Git LFS for a repository.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Disables Git LFS for a repository.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Delete a discussion from a team's page.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -523424,6 +523424,7 @@ } ], "previews": [], + "descriptionHTML": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}
.
Forbidden if team synchronization is set up
" } - ], - "descriptionHTML": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Server.\"
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}
.
Lists the SSH signing keys for a user. This operation is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the SSH signing keys for a user. This operation is accessible by anyone.
" + ] } ] } diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index b3721d9a921c..de7633002909 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -1152,13 +1152,13 @@ } ], "previews": [], + "descriptionHTML": "Sets the GitHub Actions cache usage policy for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions cache usage policy for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise
scope to use this endpoint.
Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Gets a specific self-hosted runner configured in a repository.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a specific self-hosted runner configured in a repository.
\nAuthenticated users must have admin access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Creates a repository variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a repository variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template
. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml
type in the Accept
header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nOK
" } - ], - "descriptionHTML": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.
\nuri_template
. For more information, see \"Hypermedia.\"By default, timeline resources are returned in JSON. You can specify the application/atom+xml
type in the Accept
header to return timeline resources in Atom format. For more information, see \"Media types.\"
Note
\n\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
\nUninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -94557,8 +94558,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.
\nYou must use a JWT to access this endpoint.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -138160,13 +138160,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a single check run using its id
.
Note
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint on a private repository.
OK
" } - ], - "descriptionHTML": "Gets a single check run using its id
.
Note
\n\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint on a private repository.
Gets the statistics about security products for a GitHub Enterprise Server instance.
\nTo use this endpoint, you must be a site admin.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets the statistics about security products for a GitHub Enterprise Server instance.
\nTo use this endpoint, you must be a site admin.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -201643,13 +201643,13 @@ } ], "previews": [], + "descriptionHTML": "Sets the message and expiration time for the global announcement banner in your enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Sets the message and expiration time for the global announcement banner in your enterprise.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -206922,6 +206922,7 @@ } ], "previews": [], + "descriptionHTML": "Check your installation's maintenance status:
", "statusCodes": [ { "httpStatusCode": "200", @@ -206931,8 +206932,7 @@ "httpStatusCode": "401", "description": "Unauthorized
" } - ], - "descriptionHTML": "Check your installation's maintenance status:
" + ] }, { "serverUrl": "http(s)://HOSTNAME", @@ -425592,6 +425592,7 @@ } ], "previews": [], + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -425601,8 +425602,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "List the reactions to an issue comment.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -468959,13 +468959,13 @@ } ], "previews": [], + "descriptionHTML": "Lists public repositories for the specified user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists public repositories for the specified user.
" + ] } ], "autolinks": [ @@ -489326,13 +489326,13 @@ } ], "previews": [], + "descriptionHTML": "Updates the webhook configuration for a repository. To update more information about the webhook, including the active
state and events
, use \"Update a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the write:repo_hook
or repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Updates the webhook configuration for a repository. To update more information about the webhook, including the active
state and events
, use \"Update a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the write:repo_hook
or repo
scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index b7c26aa74e18..b2bfbf3674ee 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -553,13 +553,13 @@ } ], "previews": [], + "descriptionHTML": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
A JSON serialized template for OIDC subject claim customization
" } - ], - "descriptionHTML": "Gets the customization template for an OpenID Connect (OIDC) subject claim.
\nOAuth app tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for an organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions
to selected
actions, then you cannot override them for the repository.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions
to selected
actions, then you cannot override them for the repository.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint. If the repository is private, the repo
scope is also required.
OK
" } - ], - "descriptionHTML": "Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint. If the repository is private, the repo
scope is also required.
Updates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint. If the repository is private, the repo
scope is also required.
No Content
" } - ], - "descriptionHTML": "Updates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint. If the repository is private, the repo
scope is also required.
Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Anyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
This is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "This is the user's organization dashboard. You must be authenticated as the user to view this.
\nNote
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nLists all secrets available in an organization without revealing their\nencrypted values.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a secret in an organization using the secret name.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -197202,13 +197202,13 @@ } ], "previews": [], + "descriptionHTML": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
" + ] } ] }, @@ -203707,13 +203707,13 @@ } ], "previews": [], + "descriptionHTML": "Gets all custom deployment protection rule integrations that are available for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see \"GET an app\".
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
A list of custom deployment rule integrations available for this environment.
" } - ], - "descriptionHTML": "Gets all custom deployment protection rule integrations that are available for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see \"GET an app\".
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
Created
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -225995,13 +225995,13 @@ } ], "previews": [], + "descriptionHTML": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.
\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\"
as the login, a user named \"octo-cat\"
will be created.
If the login name or email address is already associated with an account, the server will return a 422
response.
Created
" } - ], - "descriptionHTML": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.
\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\"
as the login, a user named \"octo-cat\"
will be created.
If the login name or email address is already associated with an account, the server will return a 422
response.
Lists the most commonly used licenses on GitHub. For more information, see \"Licensing a repository .\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -320978,8 +320979,7 @@ "httpStatusCode": "304", "description": "Not modified
" } - ], - "descriptionHTML": "Lists the most commonly used licenses on GitHub. For more information, see \"Licensing a repository .\"
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -353347,13 +353347,13 @@ } ], "previews": [], + "descriptionHTML": "Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nwrite_organization_custom_org_role
in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nwrite_organization_custom_org_role
in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
List all users who are outside collaborators of an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "List all users who are outside collaborators of an organization.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -367948,13 +367948,13 @@ } ], "previews": [], + "descriptionHTML": "Returns the webhook configuration for an organization. To get more information about the webhook, including the active
state and events
, use \"Get an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OK
" } - ], - "descriptionHTML": "Returns the webhook configuration for an organization. To get more information about the webhook, including the active
state and events
, use \"Get an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Gets a specific package version for a public package owned by a specified user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages
scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
OK
" } - ], - "descriptionHTML": "Gets a specific package version for a public package owned by a specified user.
\nOAuth app tokens and personal access tokens (classic) need the read:packages
scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets information about the single most recent build of a GitHub Enterprise Server Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -499782,13 +499782,13 @@ } ], "previews": [], + "descriptionHTML": "Returns the webhook configuration for a repository. To get more information about the webhook, including the active
state and events
, use \"Get a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the read:repo_hook
or repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Returns the webhook configuration for a repository. To get more information about the webhook, including the active
state and events
, use \"Get a repository webhook.\"
OAuth app tokens and personal access tokens (classic) need the read:repo_hook
or repo
scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
\nCreates a new comment on a team discussion.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
\nEdits the body text of a discussion comment.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route POST /organizations/{org_id}/team/{team_id}/discussions
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a new discussion post on a team's page.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route POST /organizations/{org_id}/team/{team_id}/discussions
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
" + ] } ], "members": [ diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index 153c9529ccac..f180482052f7 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -264,13 +264,13 @@ } ], "previews": [], + "descriptionHTML": "Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
OK
" } - ], - "descriptionHTML": "Lists all artifacts for a repository.
\nAnyone with read access to the repository can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint with a private repository.
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.
\nOAuth tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
\nOAuth tokens and personal access tokens (classic) need the read:org
scope to use this endpoint.
Gets GitHub Actions cache usage policy for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets GitHub Actions cache usage policy for a repository.
\nOAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for a repository.\"
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
OK
" } - ], - "descriptionHTML": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions
must be configured to selected
. For more information, see \"Set GitHub Actions permissions for a repository.\"
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
Lists all repositories that have been selected when the visibility
\nfor repository access to a secret is set to selected
.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint. If the repository is private, the repo
scope is also required.
OK
" } - ], - "descriptionHTML": "Lists all repositories that have been selected when the visibility
\nfor repository access to a secret is set to selected
.
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint. If the repository is private, the repo
scope is also required.
Replaces the list of self-hosted runners that are part of an organization runner group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces the list of self-hosted runners that are part of an organization runner group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Gets a specific self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a specific self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise
scope to use this endpoint.
Deletes a specific workflow run.
\nAnyone with write access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a specific workflow run.
\nAnyone with write access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Cancels a workflow run using its id
.
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Conflict
" } - ], - "descriptionHTML": "Cancels a workflow run using its id
.
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must configure your GitHub Actions workflow to run when the workflow_dispatch
webhook event occurs. The inputs
are configured in the workflow file. For more information about how to configure the workflow_dispatch
event in the workflow file, see \"Events that trigger workflows.\"
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must configure your GitHub Actions workflow to run when the workflow_dispatch
webhook event occurs. The inputs
are configured in the workflow file. For more information about how to configure the workflow_dispatch
event in the workflow file, see \"Events that trigger workflows.\"
OAuth tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nOK
" } - ], - "descriptionHTML": "Note
\n\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
\nReturns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -184177,6 +184177,7 @@ } ], "previews": [], + "descriptionHTML": "Updates the contents of a specified commit comment.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github-commitcomment.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github-commitcomment.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.Resource not found
" } - ], - "descriptionHTML": "Updates the contents of a specified commit comment.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json
: Returns the raw markdown body. Response will include body
. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json
: Returns a text only representation of the markdown body. Response will include body_text
.application/vnd.github-commitcomment.html+json
: Returns HTML rendered from the body's markdown. Response will include body_html
.application/vnd.github-commitcomment.full+json
: Returns raw, text, and HTML representations. Response will include body
, body_text
, and body_html
.Lists all secrets available in an organization without revealing their\nencrypted values.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in an organization without revealing their\nencrypted values.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Lists all repositories that have been selected when the visibility
\nfor repository access to a secret is set to selected
.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all repositories that have been selected when the visibility
\nfor repository access to a secret is set to selected
.
OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Gets the current message and expiration date of the global announcement banner in your enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets the current message and expiration date of the global announcement banner in your enterprise.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -213671,13 +213671,13 @@ } ], "previews": [], + "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -214251,13 +214251,13 @@ } ], "previews": [], + "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201
is returned, the sync job is queued successfully, and is performed when the instance is ready.
Created
" } - ], - "descriptionHTML": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201
is returned, the sync job is queued successfully, and is performed when the instance is ready.
OK
" } - ], - "descriptionHTML": "" + ] } ], "manage-ghes": [ @@ -217168,13 +217168,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -217370,13 +217370,13 @@ } ], "previews": [], + "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Removes any overrides for this hook at the org level for this org.
" + ] } ], "orgs": [ @@ -218413,13 +218413,13 @@ } ], "previews": [], + "descriptionHTML": "In addition to seeing the download status at the \"Get a pre-receive environment\" endpoint, there is also this separate endpoint for just the download status.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "In addition to seeing the download status at the \"Get a pre-receive environment\" endpoint, there is also this separate endpoint for just the download status.
" + ] } ], "pre-receive-hooks": [ @@ -325399,13 +325399,13 @@ } ], "previews": [], + "descriptionHTML": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
\nA list of repositories
is only returned for export migrations.
OK
" } - ], - "descriptionHTML": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).
\nA list of repositories
is only returned for export migrations.
Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
or repo
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
or repo
scope to use this endpoint.
Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nwrite_organization_custom_org_role
in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nwrite_organization_custom_org_role
in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
Removing a user from this list will remove them from all the organization's repositories.
", "statusCodes": [ { "httpStatusCode": "204", @@ -356750,8 +356751,7 @@ "httpStatusCode": "422", "description": "Unprocessable Entity if user is a member of the organization
" } - ], - "descriptionHTML": "Removing a user from this list will remove them from all the organization's repositories.
" + ] } ], "personal-access-tokens": [ @@ -370303,13 +370303,13 @@ } ], "previews": [], + "descriptionHTML": "Updates the webhook configuration for an organization. To update more information about the webhook, including the active
state and events
, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OK
" } - ], - "descriptionHTML": "Updates the webhook configuration for an organization. To update more information about the webhook, including the active
state and events
, use \"Update an organization webhook .\"
You must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need admin:org_hook
scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -434567,13 +434567,13 @@ } ], "previews": [], + "descriptionHTML": "List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions
.
OAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "List the reactions to a team discussion comment.
\nNote
\n\nYou can also specify a team by org_id
and team_id
using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions
.
OAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
Bad Request
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -538508,13 +538508,13 @@ } ], "previews": [], + "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
\nList all comments on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Warning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.
\nOAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.