Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions 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.
OK
" } - ], - "descriptionHTML": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions 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.
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.
Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
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.
Conflict when visibility type not set to selected
" } - ], - "descriptionHTML": "Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
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.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\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.
Resource not found
" } - ], - "descriptionHTML": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nAuthenticated users must have admin access to the organization to use this endpoint.
\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.
Gets a specific variable in a repository.
\nThe authenticated user must have collaborator 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 variable in a repository.
\nThe authenticated user must have collaborator access to the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo 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.
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 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 user 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 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", @@ -127436,8 +127437,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.
" + ] }, { "serverUrl": "https://api.github.com", @@ -181393,6 +181393,7 @@ } ], "previews": [], + "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.
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 information about an export of a codespace.
\nOAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Gets information about an export of a codespace.
\nOAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.
Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org 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.Removes one or more assignees from an issue.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Removes one or more assignees from an issue.
" + ] }, { "serverUrl": "https://api.github.com", @@ -401706,13 +401706,13 @@ } ], "previews": [], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" + ] }, { "serverUrl": "https://api.github.com", @@ -422311,13 +422311,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", @@ -432693,13 +432693,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a hosted compute network settings resource configured for an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"
OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
Resource not found
" } - ], - "descriptionHTML": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.
\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"
OAuth app tokens and personal access tokens (classic) need the read:packages and delete:packages scopes to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"
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.Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
\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": "Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
\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 reviews for a specified pull request. The list of reviews returns in chronological order.
\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.The list of reviews returns in chronological order.
" } - ], - "descriptionHTML": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.
\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.Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
Resource not found
" } - ], - "descriptionHTML": "Note
\n\nAccessing this endpoint does not count against your REST API rate limit.
\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:
core object provides your rate limit status for all non-search-related resources in the REST API.search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"Note
\n\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Response if you upload an asset with the same filename as another uploaded asset
" } - ], - "descriptionHTML": "This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\nMost libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:
application/zip
GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.
\nWhen an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -596936,8 +596937,7 @@ "httpStatusCode": "422", "description": "Bad Request
" } - ], - "descriptionHTML": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"
" + ] }, { "serverUrl": "https://api.github.com", @@ -598978,6 +598978,7 @@ } ], "previews": [], + "descriptionHTML": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -598987,8 +598988,7 @@ "httpStatusCode": "404", "description": "Not Found if repository is not enabled with vulnerability alerts
" } - ], - "descriptionHTML": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".
" + ] }, { "serverUrl": "https://api.github.com", @@ -599110,13 +599110,13 @@ } ], "previews": [], + "descriptionHTML": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".
" + ] }, { "serverUrl": "https://api.github.com", @@ -612498,6 +612498,7 @@ } ], "previews": [], + "descriptionHTML": "This deletes a single autolink reference by ID that was configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
", "statusCodes": [ { "httpStatusCode": "204", @@ -612507,8 +612508,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "This deletes a single autolink reference by ID that was configured for the given repository.
\nInformation about autolinks are only available to repository administrators.
" + ] } ], "contents": [ @@ -638239,18 +638239,6 @@ "schema": { "type": "string" } - }, - { - "name": "search_type", - "description": "The type of search to perform. Set to semantic to perform a semantic search.
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": "https://api.github.com", @@ -693134,13 +693122,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 Get a discussion comment endpoint.
\nGet a specific comment 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 Get a discussion comment endpoint.
\nGet a specific comment on a team discussion.
\nOAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.
\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.
Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.
OK
" } - ], - "descriptionHTML": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.
\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.
Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.
Lists the GPG keys for a user. This information is accessible by anyone.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the GPG keys for a user. This information is accessible by anyone.
" + ] } ], "keys": [ diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 52397aa3afe9..4ac9d73fcf19 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -7784,13 +7784,13 @@ } ], "previews": [], + "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.
To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"
If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.
To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt 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": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt 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.
Lists all environment 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 repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Lists all environment 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 repo scope to use this endpoint.
Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No content
" } - ], - "descriptionHTML": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications.
" + ] }, { "serverUrl": "https://api.github.com", @@ -92642,13 +92642,13 @@ } ], "previews": [], + "descriptionHTML": "Lists all notifications for the current user in the specified repository.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists all notifications for the current user in the specified repository.
" + ] }, { "serverUrl": "https://api.github.com", @@ -98300,13 +98300,13 @@ } ], "previews": [], + "descriptionHTML": "Lists repositories a user has starred.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.star+json: Includes a timestamp of when the star was created.OK
" } - ], - "descriptionHTML": "Lists repositories a user has starred.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github.star+json: Includes a timestamp of when the star was created.Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of 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 a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of 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": "" + ] }, { "serverUrl": "https://api.github.com", @@ -276562,13 +276562,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single organization secret without revealing its encrypted value.
\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.
Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
List of deployment protection rules
" } - ], - "descriptionHTML": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Creates a hosted compute network configuration for an enterprise.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ], - "descriptionHTML": "Creates a hosted compute network configuration for an enterprise.
" + ] }, { "serverUrl": "https://api.github.com", @@ -442401,13 +442401,13 @@ } ], "previews": [], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" + ] }, { "serverUrl": "https://api.github.com", @@ -443335,13 +443335,13 @@ } ], "previews": [], + "descriptionHTML": "Returns all community profile metrics for a repository. The repository cannot be a fork.
\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"
content_reports_enabled is only returned for organization-owned repositories.
OK
" } - ], - "descriptionHTML": "Returns all community profile metrics for a repository. The repository cannot be a fork.
\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.
\nThe health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"
content_reports_enabled is only returned for organization-owned repositories.
You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
", "statusCodes": [ { "httpStatusCode": "201", "description": "Created
" } - ], - "descriptionHTML": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.
\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
" + ] }, { "serverUrl": "https://api.github.com", @@ -596299,13 +596299,13 @@ } ], "previews": [], + "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
" + ] }, { "serverUrl": "https://api.github.com", @@ -613494,13 +613494,13 @@ } ], "previews": [], + "descriptionHTML": "Note
\n\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
", "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/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a commit comment.
" + ] }, { "serverUrl": "https://api.github.com", @@ -688349,18 +688349,6 @@ "schema": { "type": "string" } - }, - { - "name": "search_type", - "description": "The type of search to perform. Set to semantic to perform a semantic search.
Lists the people who the specified user follows.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Lists the people who the specified user follows.
" + ] }, { "serverUrl": "https://api.github.com", 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 f33e2fb442e2..014b7bb9736e 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 @@ -499949,18 +499949,6 @@ "schema": { "type": "string" } - }, - { - "name": "search_type", - "description": "The type of search to perform. Set to semantic to perform a semantic search.
The type of search to perform. Set to semantic to perform a semantic search.
The type of search to perform. Set to semantic to perform a semantic search.
Adds a repository to 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 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": "Adds a repository to 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 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.
Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
OK
" } - ] + ], + "descriptionHTML": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
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.
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.\"
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
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.\"
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
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.
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.
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.
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.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
", "statusCodes": [ { "httpStatusCode": "204", @@ -131758,7 +131757,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.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -133364,13 +133364,13 @@ } ], "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.
\nDisables the ability to restrict who can push to this branch.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "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.
\nDisables the ability to restrict who can push to this branch.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -199071,13 +199071,13 @@ } ], "previews": [], - "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.
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.
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.
Users with pull access can view deployment statuses for a deployment:
", "statusCodes": [ { "httpStatusCode": "200", @@ -210074,7 +210073,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Users with pull access can view deployment statuses for a deployment:
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -224015,13 +224015,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -224129,13 +224129,13 @@ } ], "previews": [], - "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
OK
" } - ] + ], + "descriptionHTML": "For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
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", @@ -329244,13 +329244,13 @@ } ], "previews": [], - "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Get Hypermedia links to resources accessible in GitHub's REST API
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -386697,13 +386697,13 @@ } ], "previews": [], - "descriptionHTML": "Gets a specific package version for a package owned by the authenticated 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 package owned by the authenticated 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.
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.
Removes review requests from a pull request for a given set of users and/or teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -435078,7 +435077,8 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ] + ], + "descriptionHTML": "Removes review requests from a pull request for a given set of users and/or teams.
" } ], "reviews": [ @@ -447682,13 +447682,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 comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
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 comment\" endpoint.
\nCreate a reaction to a team discussion comment.
\nA response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Get a published release with the specified tag.
", "statusCodes": [ { "httpStatusCode": "200", @@ -451649,7 +451648,8 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ] + ], + "descriptionHTML": "Get a published release with the specified tag.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -452407,7 +452407,6 @@ } ], "previews": [], - "descriptionHTML": "Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
Unauthorized
" } - ] + ], + "descriptionHTML": "Gets a public release with the specified release ID.
\nNote
\n\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"
OK
" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "https://HOSTNAME/api/uploads", @@ -513511,18 +513511,6 @@ "schema": { "type": "string" } - }, - { - "name": "search_type", - "description": "The type of search to perform. Set to semantic to perform a semantic search.
Gets a single secret scanning alert detected in an eligible repository.
\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
Service unavailable
" } - ] + ], + "descriptionHTML": "Gets a single secret scanning alert detected in an eligible repository.
\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
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 Remove team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo 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.
\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.\"
\nif team synchronization is set up
" } - ] + ], + "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 team membership for a user endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nTo 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.
\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.\"
\n