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.
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\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\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.
Lists jobs for a specific workflow run attempt. 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.
Resource not found
" } - ], - "descriptionHTML": "Lists jobs for a specific workflow run attempt. 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.
Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.
\nOAuth app 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.
\nSets a code security configuration as a default to be applied to new repositories in your enterprise.
\nThis configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.
\nThe authenticated user must be an administrator for the enterprise to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Sets a code security configuration as a default to be applied to new repositories in your enterprise.
\nThis configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.
\nThe authenticated user must be an administrator for the enterprise to use this endpoint.
\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.
\nOAuth app tokens and personal access tokens (classic) need the admin:org 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.
\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.
Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org 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. The visibility is set when you Create or\nupdate an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Enable a custom deployment protection rule for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The enabled custom deployment protection rule
" } - ], - "descriptionHTML": "Enable a custom deployment protection rule for an environment.
\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Get the content of a gitignore template.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw .gitignore contents.Not modified
" } - ], - "descriptionHTML": "Get the content of a gitignore template.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.raw+json: Returns the raw .gitignore contents.Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
" + ] }, { "serverUrl": "https://api.github.com", @@ -402628,13 +402628,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.
Fetches the status of a migration.
\nThe state of a migration can be one of the following values:
pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.Resource not found
" } - ], - "descriptionHTML": "Fetches the status of a migration.
\nThe state of a migration can be one of the following values:
pending, which means the migration hasn't started yet.exporting, which means the migration is in progress.exported, which means the migration finished successfully.failed, which means the migration failed.Get a list of models available for use, including details like supported input/output modalities,\npublisher, and rate limits.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get a list of models available for use, including details like supported input/output modalities,\npublisher, and rate limits.
" + ] } ], "embeddings": [ @@ -414986,13 +414986,13 @@ } ], "previews": [], + "descriptionHTML": "This endpoint allows you to run an embedding request. The token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.
OK
" } - ], - "descriptionHTML": "This endpoint allows you to run an embedding request. The token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.
This endpoint allows you to run an inference request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the messages for the chat completion request. The response will include either a non-streaming or streaming response based on the request parameters.
OK
" } - ], - "descriptionHTML": "This endpoint allows you to run an inference request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the models: read permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the messages for the chat completion request. The response will include either a non-streaming or streaming response based on the request parameters.
Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
" + ] }, { "serverUrl": "https://api.github.com", @@ -429381,13 +429381,13 @@ } ], "previews": [], + "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.
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 all assigned organization roles 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 all assigned organization roles 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.
When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "statusCodes": [ { "httpStatusCode": "202", @@ -431898,8 +431899,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" + ] }, { "serverUrl": "https://api.github.com", @@ -432662,6 +432662,7 @@ } ], "previews": [], + "descriptionHTML": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.
\nOnly GitHub Apps can use this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -432683,8 +432684,7 @@ "httpStatusCode": "500", "description": "Internal Error
" } - ], - "descriptionHTML": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.
\nOnly GitHub Apps can use this endpoint.
" + ] }, { "serverUrl": "https://api.github.com", @@ -446400,6 +446400,7 @@ } ], "previews": [], + "descriptionHTML": "Returns a delivery for a webhook configured in an organization.
\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.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Returns a delivery for a webhook configured in an organization.
\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.
Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
" + ] }, { "serverUrl": "https://api.github.com", @@ -612632,13 +612632,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nFound
" } - ], - "descriptionHTML": "Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nLists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.
\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"
Too many requests
" } - ], - "descriptionHTML": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.
\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nNo Content
" } - ], - "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.
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 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.\"
\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 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.\"
\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}.
Provides publicly available information about someone with a GitHub account.
\nIf you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.
The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.
", "statusCodes": [ { "httpStatusCode": "200", @@ -700119,8 +700120,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Provides publicly available information about someone with a GitHub account.
\nIf you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.
The email key in the following response is the publicly visible email address from your GitHub profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.
" + ] }, { "serverUrl": "https://api.github.com", @@ -703146,13 +703146,13 @@ } ], "previews": [], + "descriptionHTML": "Lists the people following the specified user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the people following the specified user.
" + ] }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index b4e3b4dd3afe..bc3cb2390a47 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -2836,13 +2836,13 @@ } ], "previews": [], - "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.
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.
Updates the name and visibility of a self-hosted runner group in an enterprise.
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Updates the name and visibility of a self-hosted runner group in an enterprise.
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Replaces the list of organizations that have access to a 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.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Updates 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 app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Updates 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 app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about 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.
This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.
OK
" } - ] + ], + "descriptionHTML": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about 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.
This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.
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.
\nProtected 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.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "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.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -135766,7 +135766,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.
\nLists the people who have push access to this branch.
", "statusCodes": [ { "httpStatusCode": "200", @@ -135776,7 +135775,8 @@ "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 people who have push access to this branch.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -136627,7 +136627,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.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
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.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Updates a check run for a specific commit in a repository.
\nNote
\n\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Updates a check run for a specific commit in a repository.
\nNote
\n\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
OAuth apps and personal access tokens (classic) cannot use this endpoint.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -145818,13 +145818,13 @@ } ], "previews": [], - "descriptionHTML": "Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
OK
" } - ] + ], + "descriptionHTML": "Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.
Note
\n\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.
If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessResource not found
" } - ] + ], + "descriptionHTML": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.
\nAdditionally, a combined state is returned. The state is one of:
error or failurependingsuccessUpdates a deployment branch or tag policy for an environment.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Updates a deployment branch or tag policy for an environment.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209274,13 +209274,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210036,13 +210036,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.
Removes all labels from an issue.
", "statusCodes": [ { "httpStatusCode": "204", @@ -299201,7 +299200,8 @@ "httpStatusCode": "410", "description": "Gone
" } - ] + ], + "descriptionHTML": "Removes all labels from an issue.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -344183,13 +344183,13 @@ } ], "previews": [], - "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "List public organization memberships for the specified user.
\nThis method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
" } ], "custom-properties": [ @@ -345804,13 +345804,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.
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.
No Content
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -487657,13 +487657,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.
List all comments on a team discussion.
\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.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "List all comments on a team discussion.
\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.
OAuth 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 Create a discussion 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.\"
\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 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.\"
\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 Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\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 Get a discussion endpoint.
\nGet a specific discussion on a team's page.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Lists social media accounts for a user. This endpoint is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Lists social media accounts for a user. This endpoint is accessible by anyone.
" } ], "ssh-signing-keys": [ @@ -547449,13 +547449,13 @@ } ], "previews": [], - "descriptionHTML": "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.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index f23c5f044076..57edf2d53e99 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 @@ -922,13 +922,13 @@ } ], "previews": [], + "descriptionHTML": "Lists artifacts for a workflow run.
\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 artifacts for a workflow run.
\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.
Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all secrets available in a repository without revealing their encrypted\nvalues.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
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.
Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Approve or reject pending deployments that are waiting on approval by a required reviewer.
\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Re-runs your workflow run using its id.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Re-runs your workflow run using its id.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.
Created
" } - ], - "descriptionHTML": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.
OK
" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -204563,13 +204563,13 @@ } ], "previews": [], + "descriptionHTML": "Lists the environments 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 the environments 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": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -231428,13 +231428,13 @@ } ], "previews": [], + "descriptionHTML": "If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.
You can suspend any user account except your own.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
No Content
" } - ], - "descriptionHTML": "If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.
You can suspend any user account except your own.
\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"
Deletes an organization and all its repositories.
\nThe organization login will be unavailable for 90 days after deletion.
\nPlease review the Terms of Service regarding account deletion before using this endpoint:
\nhttps://docs.github.com/enterprise-server@3.17/site-policy/github-terms/github-terms-of-service
", "statusCodes": [ { "httpStatusCode": "202", @@ -348430,8 +348431,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Deletes an organization and all its repositories.
\nThe organization login will be unavailable for 90 days after deletion.
\nPlease review the Terms of Service regarding account deletion before using this endpoint:
\nhttps://docs.github.com/enterprise-server@3.17/site-policy/github-terms/github-terms-of-service
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -354106,13 +354106,13 @@ } ], "previews": [], + "descriptionHTML": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\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.
Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nNo Content
" } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.
\nGets 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.
Gets information about a GitHub Enterprise Server Pages build.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets information about a GitHub Enterprise Server Pages build.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.
Delete a reaction to an issue.
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -445559,13 +445559,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 Create reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth 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 reaction for a team discussion endpoint.
Create a reaction to a team discussion.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Accepted
" } - ], - "descriptionHTML": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\nFound
" } - ], - "descriptionHTML": "Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.
Note
\n\nFor private repositories, these links are temporary and expire after five minutes.
\n