diff --git a/content/billing/managing-billing-for-your-products/about-billing-for-github-copilot.md b/content/billing/managing-billing-for-your-products/about-billing-for-github-copilot.md index d2dcbbae97f2..70e56eef84d5 100644 --- a/content/billing/managing-billing-for-your-products/about-billing-for-github-copilot.md +++ b/content/billing/managing-billing-for-your-products/about-billing-for-github-copilot.md @@ -71,9 +71,7 @@ When {% data variables.product.prodname_copilot_short %} works on coding tasks, This allowance of free premium requests is shared with other {% data variables.product.prodname_copilot_short %} features, such as {% data variables.copilot.copilot_chat_short %}. -When you use {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} will make multiple premium requests to complete a single task. Each time {% data variables.product.prodname_copilot_short %} calls the underlying model service, it counts as one premium request. - -On average, {% data variables.copilot.copilot_coding_agent %} uses 30-50 premium requests each time it is invoked. The exact number of premium requests will vary depending on the task’s complexity and the number of required steps. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/monitoring-usage-and-entitlements/avoiding-unexpected-copilot-costs). +When you use {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} will use one premium request per session. A session begins when you ask {% data variables.product.prodname_copilot_short %} to create a pull request or make one or more changes to an existing pull request. For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). diff --git a/content/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot.md b/content/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot.md index 0212d4b7dce5..c77817e1b329 100644 --- a/content/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot.md +++ b/content/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot.md @@ -34,7 +34,7 @@ The following {% data variables.product.prodname_copilot_short %} features can u | Feature | Premium request consumption | | ------- | ----------- | | [{% data variables.copilot.copilot_chat_short %}](/copilot/using-github-copilot/copilot-chat) | {% data variables.copilot.copilot_chat_short %} uses **one premium request** per user prompt, multiplied by the model's rate. | -| [{% data variables.copilot.copilot_coding_agent %}](/copilot/concepts/about-copilot-coding-agent) | {% data variables.copilot.copilot_coding_agent %} will make multiple premium requests to complete a single task. On average, {% data variables.copilot.copilot_coding_agent %} uses **30-50 premium requests** each time it is invoked. The exact number of premium requests will vary depending on the task’s complexity and the number of required steps. {% data variables.copilot.copilot_coding_agent %} uses a fixed multiplier of 1 for the premium requests it uses. | +| [{% data variables.copilot.copilot_coding_agent %}](/copilot/concepts/about-copilot-coding-agent) | {% data variables.copilot.copilot_coding_agent %} uses **one premium request** per session. A session begins when you ask {% data variables.product.prodname_copilot_short %} to create a pull request or make one or more changes to an existing pull request. | | [Agent mode in {% data variables.copilot.copilot_chat_short %}](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide#copilot-edits) | Agent mode uses **one premium request** per user prompt, multiplied by the model's rate. | | [{% data variables.product.prodname_copilot_short %} code review](/copilot/using-github-copilot/code-review/using-copilot-code-review) | When you assign {% data variables.product.prodname_copilot_short %} as a reviewer for a pull request, **one premium request** is used each time {% data variables.product.prodname_copilot_short %} posts comments to the pull request. | | [{% data variables.copilot.copilot_extensions_short %}](/copilot/building-copilot-extensions/about-building-copilot-extensions) | {% data variables.copilot.copilot_extensions_short %} uses **one premium request** per user prompt, multiplied by the model's rate. | diff --git a/src/frame/tests/pages.js b/src/frame/tests/pages.js index 5deda9849e68..486af4cae232 100644 --- a/src/frame/tests/pages.js +++ b/src/frame/tests/pages.js @@ -50,30 +50,42 @@ describe('pages module', () => { const englishPages = chain(pages) .filter(['languageCode', 'en']) .filter('redirect_from') - .map((pages) => pick(pages, ['redirect_from', 'applicableVersions'])) + .map((pages) => pick(pages, ['redirect_from', 'applicableVersions', 'fullPath'])) .value() + // Map from redirect path to Set of file paths + const redirectToFiles = new Map() const versionedRedirects = [] englishPages.forEach((page) => { page.redirect_from.forEach((redirect) => { page.applicableVersions.forEach((version) => { - versionedRedirects.push(removeFPTFromPath(path.posix.join('/', version, redirect))) + const versioned = removeFPTFromPath(path.posix.join('/', version, redirect)) + versionedRedirects.push({ path: versioned, file: page.fullPath }) + if (!redirectToFiles.has(versioned)) { + redirectToFiles.set(versioned, new Set()) + } + redirectToFiles.get(versioned).add(page.fullPath) }) }) }) - const duplicates = versionedRedirects.reduce((acc, el, i, arr) => { - if (arr.indexOf(el) !== i && acc.indexOf(el) < 0) acc.push(el) - return acc - }, []) - - const message = `Found ${duplicates.length} duplicate redirect_from ${ - duplicates.length === 1 ? 'path' : 'paths' - }. - Ensure that you don't define the same path more than once in the redirect_from property in a single file and across all English files. - You may also receive this error if you have defined the same children property more than once.\n - ${duplicates.join('\n')}` + // Only consider as duplicate if more than one unique file defines the same redirect + const duplicates = Array.from(redirectToFiles.entries()) + .filter(([_, files]) => files.size > 1) + .map(([path]) => path) + + // Build a detailed message with sources for each duplicate + const message = + `Found ${duplicates.length} duplicate redirect_from path${duplicates.length === 1 ? '' : 's'}. + Ensure that you don't define the same path more than once in the redirect_from property in a single file and across all English files. + You may also receive this error if you have defined the same children property more than once.\n` + + duplicates + .map((dup) => { + const files = Array.from(redirectToFiles.get(dup) || []) + return `${dup}\n Defined in:\n ${files.join('\n ')}` + }) + .join('\n\n') expect(duplicates.length, message).toBe(0) }) diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 169358bf434a..a8d6b1829def 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -2511,13 +2511,13 @@ } ], "previews": [], - "descriptionHTML": "
Creates a GitHub-hosted runner for an enterprise.\nOAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a GitHub-hosted runner for an enterprise.\nOAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
Created
" } - ], - "descriptionHTML": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
Get the list of partner images available for GitHub-hosted runners for an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the list of partner images available for GitHub-hosted runners for an organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -5129,13 +5129,13 @@ } ], "previews": [], + "descriptionHTML": "Get the list of machine specs available for GitHub-hosted runners for an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the list of machine specs available for GitHub-hosted runners for an organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -5209,13 +5209,13 @@ } ], "previews": [], + "descriptionHTML": "Get the list of platforms available for GitHub-hosted runners for an organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the list of platforms available for GitHub-hosted runners for an organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -6138,13 +6138,13 @@ } ], "previews": [], + "descriptionHTML": "Deletes a GitHub-hosted runner for an organization.
", "statusCodes": [ { "httpStatusCode": "202", "description": "Accepted
" } - ], - "descriptionHTML": "Deletes a GitHub-hosted runner for an organization.
" + ] } ], "oidc": [ @@ -7016,13 +7016,13 @@ } ], "previews": [], + "descriptionHTML": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists all self-hosted runner groups for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all self-hosted runner groups for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Created
" } - ] + ], + "descriptionHTML": "Creates a new self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
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.
Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ], - "descriptionHTML": "Deletes a self-hosted runner group for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists the organizations with access to a self-hosted runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the organizations with access to a self-hosted runner group.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Adds a self-hosted runner to a runner group 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": "Adds a self-hosted runner to a runner group configured in an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Updates the name and visibility of a self-hosted runner group in an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Updates the name and visibility of a self-hosted runner group in an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists the repositories with access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists the repositories with access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Lists all self-hosted runners configured for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists all self-hosted runners configured for an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\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.
OK
" } - ], - "descriptionHTML": "Lists all self-hosted runners configured in an organization.
\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.
Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
OK
" } - ] + ], + "descriptionHTML": "Lists all organization variables.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth 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 creating a variable
" } - ], - "descriptionHTML": "Creates an organization variable that you can reference in a GitHub Actions workflow.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth 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.
Gets a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\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.
OK
" } - ] + ], + "descriptionHTML": "Gets a specific variable in an organization.
\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.
\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.
Deletes an organization variable using the variable name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\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.
No Content
" } - ] + ], + "descriptionHTML": "Deletes an organization variable using the variable name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.
\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.
Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Response when the visibility of the variable is not set to selected
Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.
Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for Location: in the response header to find the URL for the download.
Anyone 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.
Found
" } - ] + ], + "descriptionHTML": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for Location: in the response header to find the URL for the download.
Anyone 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.
Get all deployment environments for a workflow run that are waiting for protection rules to pass.
\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 all deployment environments for a workflow run that are waiting for protection rules to pass.
\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.
List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
This 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": "List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
This 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.
Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.
OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
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 the announcement banner to display for the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Sets the announcement banner to display for the organization.
" }, { "serverUrl": "https://api.github.com", @@ -97445,13 +97445,13 @@ } ], "previews": [], + "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.
You must use a JWT to access this endpoint.
" + ] }, { "serverUrl": "https://api.github.com", @@ -118535,13 +118535,13 @@ } ], "previews": [], - "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Gets the summary of the free and paid GitHub Actions minutes used.
\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
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": "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.
" + ] }, { "serverUrl": "https://api.github.com", @@ -139516,6 +139516,7 @@ } ], "previews": [], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
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 who has access to this protected branch.
\nNote
\n\nUsers, apps, and teams restrictions are only available for organization-owned repositories.
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": "https://api.github.com", @@ -142051,7 +142051,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 teams who have push access to this branch. The list includes child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -142061,7 +142060,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 teams who have push access to this branch. The list includes child teams.
" }, { "serverUrl": "https://api.github.com", @@ -143296,7 +143296,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", @@ -143306,7 +143305,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": "https://api.github.com", @@ -143583,6 +143583,7 @@ } ], "previews": [], + "descriptionHTML": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can 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.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
Lists annotations for a check run using the annotation id.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
OK
" } - ], - "descriptionHTML": "Lists annotations for a check run using the annotation id.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.
Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.
\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Accepted
" } - ] + ], + "descriptionHTML": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.
\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.
\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.
Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
OAuth 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.
Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
" + ] } ] }, @@ -283259,13 +283259,13 @@ } ], "previews": [], - "descriptionHTML": "Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", "description": "The audit log stream configuration was created successfully.
" } - ] + ], + "descriptionHTML": "Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" }, { "serverUrl": "https://api.github.com", @@ -283845,7 +283845,6 @@ } ], "previews": [], - "descriptionHTML": "Updates an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -283855,7 +283854,8 @@ "httpStatusCode": "422", "description": "Validation error
" } - ] + ], + "descriptionHTML": "Updates an existing audit log stream configuration for an enterprise.
\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"
" }, { "serverUrl": "https://api.github.com", @@ -288515,13 +288515,13 @@ } ], "previews": [], - "descriptionHTML": "Deletes a hosted compute network configuration from an enterprise.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Deletes a hosted compute network configuration from an enterprise.
" }, { "serverUrl": "https://api.github.com", @@ -288631,13 +288631,13 @@ } ], "previews": [], + "descriptionHTML": "Gets a hosted compute network settings resource configured for an enterprise.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Gets a hosted compute network settings resource configured for an enterprise.
" + ] } ], "organization-installations": [ @@ -288749,13 +288749,13 @@ } ], "previews": [], + "descriptionHTML": "List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "A list of organizations owned by the enterprise on which the authenticated GitHub App is installed.
" } - ], - "descriptionHTML": "List the organizations owned by the enterprise, intended for use by GitHub Apps that are managing applications across the enterprise.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -290576,6 +290576,7 @@ } ], "previews": [], + "descriptionHTML": "Installs any valid GitHub App on the specified organization owned by the enterprise. If the app is already installed on the organization, and is suspended, it will be unsuspended.\nIf the app has a pending installation request, they will all be approved.
\nIf the app is already installed and has a pending update request, it will be updated to the latest version. If the app is now requesting repository permissions, it will be given access to the repositories listed in the request or fail if no repository_selection is provided.
This API can only be called by a GitHub App installed on the enterprise that owns the organization.
", "statusCodes": [ { "httpStatusCode": "200", @@ -290585,8 +290586,7 @@ "httpStatusCode": "201", "description": "A GitHub App installation.
" } - ], - "descriptionHTML": "Installs any valid GitHub App on the specified organization owned by the enterprise. If the app is already installed on the organization, and is suspended, it will be unsuspended.\nIf the app has a pending installation request, they will all be approved.
\nIf the app is already installed and has a pending update request, it will be updated to the latest version. If the app is now requesting repository permissions, it will be given access to the repositories listed in the request or fail if no repository_selection is provided.
This API can only be called by a GitHub App installed on the enterprise that owns the organization.
" + ] }, { "serverUrl": "https://api.github.com", @@ -290816,13 +290816,13 @@ } ], "previews": [], - "descriptionHTML": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "A list of repositories owned by the enterprise organization to which the installation has access.
" } - ] + ], + "descriptionHTML": "Lists the repositories accessible to a given GitHub App installation on an enterprise-owned organization.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
" }, { "serverUrl": "https://api.github.com", @@ -292102,13 +292102,13 @@ } ], "previews": [], - "descriptionHTML": "Grant repository access to an organization installation. You can add up to 50 repositories at a time. If the installation already has access to the repository, it will not be added again.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
", "statusCodes": [ { "httpStatusCode": "200", "description": "A list of repositories which the authenticated GitHub App should be granted access to.
" } - ] + ], + "descriptionHTML": "Grant repository access to an organization installation. You can add up to 50 repositories at a time. If the installation already has access to the repository, it will not be added again.
\nThis API can only be called by a GitHub App installed on the enterprise that owns the organization.
" }, { "serverUrl": "https://api.github.com", @@ -322551,13 +322551,13 @@ } ], "previews": [], - "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.
", "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", @@ -411264,6 +411264,7 @@ } ], "previews": [], + "descriptionHTML": "You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
Not modified
" } - ], - "descriptionHTML": "You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Not modified
" } - ], - "descriptionHTML": "Lists all organizations, in the order that they were created.
\nNote
\n\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nBy default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"
\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.
OK
" } - ], - "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nBy default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"
\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"
\nThe authenticated user must be an organization owner to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.
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", @@ -432767,13 +432767,13 @@ } ], "previews": [], + "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.
" + ] }, { "serverUrl": "https://api.github.com", @@ -432912,13 +432912,13 @@ } ], "previews": [], + "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ], - "descriptionHTML": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
" + ] }, { "serverUrl": "https://api.github.com", @@ -433911,6 +433911,7 @@ } ], "previews": [], + "descriptionHTML": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.
", "statusCodes": [ { "httpStatusCode": "204", @@ -433920,8 +433921,7 @@ "httpStatusCode": "422", "description": "Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.
" + ] }, { "serverUrl": "https://api.github.com", @@ -434614,6 +434614,7 @@ } ], "previews": [], + "descriptionHTML": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.
", "statusCodes": [ { "httpStatusCode": "200", @@ -434627,8 +434628,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.
" + ] }, { "serverUrl": "https://api.github.com", @@ -436045,13 +436045,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.
Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -438958,8 +438959,7 @@ "httpStatusCode": "404", "description": "Resource not found
" } - ], - "descriptionHTML": "Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
" + ] }, { "serverUrl": "https://api.github.com", @@ -442810,13 +442810,13 @@ } ], "previews": [], + "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ], - "descriptionHTML": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
" + ] }, { "serverUrl": "https://api.github.com", @@ -444674,13 +444674,13 @@ } ], "previews": [], - "descriptionHTML": "Gets a hosted compute network configuration configured in 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 configuration configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.
Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nread_organization_custom_org_role in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Validation failed, or the endpoint has been spammed.
" } - ], - "descriptionHTML": "Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"
\nTo use this endpoint, the authenticated user must be one of:
\nread_organization_custom_org_role in the organization.OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" } - ] + ], + "descriptionHTML": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"
\nThe authenticated user must be an administrator for the organization to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.
\nOnly GitHub Apps can use this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -450852,7 +450851,8 @@ "httpStatusCode": "500", "description": "Internal Error
" } - ] + ], + "descriptionHTML": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.
\nOnly GitHub Apps can use this endpoint.
" }, { "serverUrl": "https://api.github.com", @@ -460897,13 +460897,13 @@ } ], "previews": [], - "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nOK
" } - ] + ], + "descriptionHTML": "Warning
\n\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.
\nLists builts of a GitHub Enterprise Cloud Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Lists builts of a GitHub Enterprise Cloud Pages site.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Resource not found
" } - ], - "descriptionHTML": "Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Edits the content of a specified review comment.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.OK
" } - ], - "descriptionHTML": "Edits the content of a specified review comment.
\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"
\napplication/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.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", @@ -580457,13 +580457,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.
\nFind topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Not modified
" } - ], - "descriptionHTML": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\nWhen searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:
\nq=ruby+is:featured
This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
Get a specific discussion on a team's page.
\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}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Get a specific discussion on a team's page.
\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}.
OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
OK
" } - ] + ], + "descriptionHTML": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.
Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
" }, { "serverUrl": "https://api.github.com", @@ -666396,13 +666396,13 @@ } ], "previews": [], - "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", "description": "No Content
" } - ] + ], + "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
" } ], "members": [ @@ -667031,13 +667031,13 @@ } ], "previews": [], - "descriptionHTML": "Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "200", "description": "OK
" } - ] + ], + "descriptionHTML": "Team members will include the members of child teams.
\nTo list members in a team, the team must be visible to the authenticated user.
" }, { "serverUrl": "https://api.github.com", @@ -668757,13 +668757,13 @@ } ], "previews": [], - "descriptionHTML": "List IdP groups connected to a team on GitHub Enterprise Cloud.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
OK
" } - ] + ], + "descriptionHTML": "List IdP groups connected to a team on GitHub Enterprise Cloud.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.
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 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": [ @@ -680214,13 +680214,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/secret-scanning/data/public-docs.yml b/src/secret-scanning/data/public-docs.yml index 18b04a8f66c5..dd42acc1f5d7 100644 --- a/src/secret-scanning/data/public-docs.yml +++ b/src/secret-scanning/data/public-docs.yml @@ -604,6 +604,17 @@ hasPushProtection: false hasValidityCheck: false isduplicate: false +- provider: Azure + supportedSecret: Azure ML Inference Key + secretType: azure_ml_inference_identifiable_key + versions: + fpt: '*' + ghec: '*' + isPublic: true + isPrivateWithGhas: true + hasPushProtection: true + hasValidityCheck: false + isduplicate: false - provider: Azure supportedSecret: Azure ML Internal Service Principal Key secretType: azure_ml_internal_service_principal_identifiable_key diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index bc449cdeb798..023b2906d220 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,5 +1,5 @@ { - "sha": "59459195f898490f26f8aa6417cf54df23aa6ff7", - "blob-sha": "e59d91b6e8d5c9dd3c8496286421b8915efb0d5c", + "sha": "868a7bf9e6f78223a431bab1b3631fdc3a63a4e1", + "blob-sha": "a25a2857965bcebecb4646ce854a78042c4b599e", "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file