diff --git a/content/contributing/writing-for-github-docs/creating-screenshots.md b/content/contributing/writing-for-github-docs/creating-screenshots.md index 2fafc7ccb7cb..902ff5db2357 100644 --- a/content/contributing/writing-for-github-docs/creating-screenshots.md +++ b/content/contributing/writing-for-github-docs/creating-screenshots.md @@ -130,7 +130,7 @@ If the primary goal in showing a dropdown menu is to help the reader distinguish ## Highlighting elements in screenshots -To highlight a specific UI element in a screenshot, use our special theme for [Snagit](https://www.techsmith.com/screen-capture.html) to apply a contrasting stroke around the element. +To highlight a specific UI element in a screenshot, use our special theme for [Snagit](https://www.techsmith.com/snagit/) to apply a contrasting stroke around the element. The stroke is the color `fg.severe` in the [Primer Design System](https://primer.style/design/) (HEX #BC4C00 or RGB 188, 76, 0). This dark orange has good color contrast on both white and black. To check contrast on other background colors, use the [Color Contrast Analyzer](https://www.tpgi.com/color-contrast-checker/). diff --git a/data/reusables/advanced-security/delegated-alert-dismissal-beta.md b/data/reusables/advanced-security/delegated-alert-dismissal-beta.md deleted file mode 100644 index 84c112be346a..000000000000 --- a/data/reusables/advanced-security/delegated-alert-dismissal-beta.md +++ /dev/null @@ -1,6 +0,0 @@ -{% ifversion security-delegated-alert-dismissal %} - -> [!NOTE] -> Delegated alert dismissal is currently in {% data variables.release-phases.public_preview %} and subject to change. - -{% endif %} diff --git a/data/reusables/gated-features/security-features-basic.md b/data/reusables/gated-features/security-features-basic.md deleted file mode 100644 index 8636f3dc2277..000000000000 --- a/data/reusables/gated-features/security-features-basic.md +++ /dev/null @@ -1,5 +0,0 @@ -The availability of security features mentioned in this article varies: - -* {% data variables.product.prodname_dependabot %} is available for all repository types. -* {% data variables.product.prodname_secret_scanning_caps %} and push protection are available for public repositories, or private repositories with [{% data variables.product.prodname_GH_secret_protection %}](/get-started/learning-about-github/about-github-advanced-security) enabled. -* Branch protection rules are available for public repositories, or private repositories on a {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %} plan. diff --git a/src/content-render/tests/link-error-line-numbers.js b/src/content-render/tests/link-error-line-numbers.js new file mode 100644 index 000000000000..2afb5a6a491b --- /dev/null +++ b/src/content-render/tests/link-error-line-numbers.js @@ -0,0 +1,154 @@ +import { describe, expect, test, beforeEach, afterEach } from 'vitest' +import { renderContent } from '#src/content-render/index.js' +import { TitleFromAutotitleError } from '#src/content-render/unified/rewrite-local-links.js' + +describe('link error line numbers', () => { + let fs + let originalReadFileSync + let originalExistsSync + let mockContext + + beforeEach(async () => { + // Set up file system mocking + fs = await import('fs') + originalReadFileSync = fs.default.readFileSync + originalExistsSync = fs.default.existsSync + + fs.default.existsSync = () => true + + // Set up basic mock context + mockContext = { + currentLanguage: 'en', + currentVersion: 'free-pro-team@latest', + pages: new Map(), + redirects: new Map(), + page: { + fullPath: '/fake/test-file.md', + }, + } + }) + + afterEach(() => { + // Restore original functions + fs.default.readFileSync = originalReadFileSync + fs.default.existsSync = originalExistsSync + }) + + test('reports correct line numbers for broken AUTOTITLE links', async () => { + // Test content with frontmatter followed by content with a broken link + const template = `--- +title: Test Page +version: 1.0 +--- + +# Introduction + +This is some content. + +Here is a broken link: [AUTOTITLE](/nonexistent/page). + +More content here.` + + fs.default.readFileSync = () => template + + try { + await renderContent(template, mockContext) + expect.fail('Expected TitleFromAutotitleError to be thrown') + } catch (error) { + expect(error).toBeInstanceOf(TitleFromAutotitleError) + + // The broken link is on line 10 in the original file + // (3 lines of frontmatter + 1 blank line + 1 title + 1 blank + 1 content + 1 blank + 1 link line) + // The error message should reference the correct line number + expect(error.message).toContain('/nonexistent/page') + expect(error.message).toContain('could not be resolved') + expect(error.message).toContain('(Line: 10)') + } + }) + + test('reports correct line numbers with different frontmatter sizes', async () => { + mockContext.page.fullPath = '/fake/test-file-2.md' + + // Test with more extensive frontmatter + const template = `--- +title: Another Test Page +description: This is a test +author: Test Author +date: 2024-01-01 +tags: + - test + - documentation +version: 2.0 +--- + +# Main Title + +Some introductory text here. + +## Section + +Content with a [AUTOTITLE](/another/nonexistent/page) link.` + + fs.default.readFileSync = () => template + + try { + await renderContent(template, mockContext) + expect.fail('Expected TitleFromAutotitleError to be thrown') + } catch (error) { + expect(error).toBeInstanceOf(TitleFromAutotitleError) + expect(error.message).toContain('/another/nonexistent/page') + expect(error.message).toContain('could not be resolved') + } + }) + + test('handles files without frontmatter correctly', async () => { + mockContext.page.fullPath = '/fake/no-frontmatter.md' + + // Test content without frontmatter + const template = `# Simple Title + +This is content without frontmatter. + +Here is a broken link: [AUTOTITLE](/missing/page).` + + fs.default.readFileSync = () => template + + try { + await renderContent(template, mockContext) + expect.fail('Expected TitleFromAutotitleError to be thrown') + } catch (error) { + expect(error).toBeInstanceOf(TitleFromAutotitleError) + expect(error.message).toContain('/missing/page') + expect(error.message).toContain('could not be resolved') + } + }) + + test('error message format is improved', async () => { + mockContext.page.fullPath = '/fake/message-test.md' + + const template = `--- +title: Message Test +--- + +[AUTOTITLE](/test/broken/link) +` + + fs.default.readFileSync = () => template + + try { + await renderContent(template, mockContext) + expect.fail('Expected TitleFromAutotitleError to be thrown') + } catch (error) { + expect(error).toBeInstanceOf(TitleFromAutotitleError) + + // Check that the new error message format is used + expect(error.message).toContain('could not be resolved in one or more versions') + expect(error.message).toContain('Make sure that this link can be reached from all versions') + expect(error.message).toContain('/test/broken/link') + + // Check that the old error message format is NOT used + expect(error.message).not.toContain('Unable to find Page by') + expect(error.message).not.toContain('To fix it, look at') + } + }) +}) diff --git a/src/content-render/unified/rewrite-local-links.js b/src/content-render/unified/rewrite-local-links.js index 2afed4a28ef3..1e68cda98f0d 100644 --- a/src/content-render/unified/rewrite-local-links.js +++ b/src/content-render/unified/rewrite-local-links.js @@ -1,5 +1,4 @@ import path from 'path' -import fs from 'fs' import stripAnsi from 'strip-ansi' import { visit } from 'unist-util-visit' @@ -46,36 +45,6 @@ function logError(file, line, message, title = 'Error') { } } -function getFrontmatterOffset(filePath) { - if (!fs.existsSync(filePath)) return 0 - const rawContent = fs.readFileSync(filePath, 'utf-8') - let delimiters = 0 - let count = 0 - // The frontmatter is wedged between two `---` lines. But the content - // doesn't necessarily start after the second `---`. If the `.md` file looks - // like this: - // - // 1) --- - // 2) title: Foo - // 3) --- - // 4) - // 5) # Introduction - // 6) Bla bla - // - // Then line one of the *content* that is processed, starts at line 5. - // because after the matter and content is separated, the content portion - // is whitespace trimmed. - for (const line of rawContent.split(/\n/g)) { - count++ - if (line === '---') { - delimiters++ - } else if (delimiters === 2 && line) { - return count - } - } - return 0 -} - // Meaning it can be 'AUTOTITLE ' or ' AUTOTITLE' or 'AUTOTITLE' const AUTOTITLE = /^\s*AUTOTITLE\s*$/ @@ -204,12 +173,13 @@ async function getNewTitleSetter(child, href, context, originalHref) { async function getNewTitle(href, context, child, originalHref) { const page = findPage(href, context.pages, context.redirects) if (!page) { - const line = child.position.start.line + getFrontmatterOffset(context.page.fullPath) - const message = `Unable to find Page by '${originalHref || href}'. - To fix it, look at ${ - context.page.fullPath - } on line ${line} and see if the link is correct and active.` - logError(context.page.fullPath, line, message) + // The child.position.start.line is 1-based and already represents the line number + // in the original file (including frontmatter), so no offset adjustment is needed + const line = child.position.start.line + + const linkText = originalHref || href + const message = `The link '${linkText}' could not be resolved in one or more versions of the documentation. Make sure that this link can be reached from all versions of the documentation it appears in. (Line: ${line})` + logError(context.page.fullPath, line, message, 'Link Resolution Error') throw new TitleFromAutotitleError(message) } return await page.renderProp('title', context, { textOnly: true }) diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 0e16264cf593..ff41e428b1e0 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -6670,13 +6670,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -6951,13 +6951,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -9402,13 +9402,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -13610,13 +13610,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -13749,13 +13749,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -14663,13 +14663,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -118382,13 +118382,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

\n

Paid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

\n

Paid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use 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.

\n

Paid 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\".

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the summary of the free and paid GitHub Actions minutes used.

\n

Paid 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\".

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -135889,13 +135889,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.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

" + ] }, { "serverUrl": "https://api.github.com", @@ -142699,6 +142699,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.

\n

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

", "statusCodes": [ { "httpStatusCode": "200", @@ -142708,8 +142709,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

" + ] }, { "serverUrl": "https://api.github.com", @@ -151194,13 +151194,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single check run using its id.

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a single check run using its id.

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -267190,6 +267190,7 @@ } ], "previews": [], + "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.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -267199,8 +267200,7 @@ "httpStatusCode": "204", "description": "

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.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -268872,13 +268872,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -269652,13 +269652,13 @@ } ], "previews": [], + "descriptionHTML": "

Create a new snapshot of a repository's dependencies.

\n

The authenticated user must have access to the repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Create a new snapshot of a repository's dependencies.

\n

The authenticated user must have access to the repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] } ], "sboms": [ @@ -283845,6 +283845,7 @@ } ], "previews": [], + "descriptionHTML": "

Updates an existing audit log stream configuration for an enterprise.

\n

When 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", @@ -283854,8 +283855,7 @@ "httpStatusCode": "422", "description": "

Validation error

" } - ], - "descriptionHTML": "

Updates an existing audit log stream configuration for an enterprise.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

" + ] }, { "serverUrl": "https://api.github.com", @@ -283909,13 +283909,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes an existing audit log stream configuration for an enterprise.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

", "statusCodes": [ { "httpStatusCode": "204", "description": "

The audit log stream configuration was deleted successfully.

" } - ], - "descriptionHTML": "

Deletes an existing audit log stream configuration for an enterprise.

\n

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"Encrypting secrets for the REST API.\"

" + ] } ], "billing": [ @@ -287853,13 +287853,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets information about the status of a license sync job for an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

License Sync Status Response

" } - ], - "descriptionHTML": "

Gets information about the status of a license sync job for an enterprise.

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:enterprise scope to use this endpoint.

" + ] } ], "network-configurations": [ @@ -288297,13 +288297,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a hosted compute network configuration configured in an enterprise.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a hosted compute network configuration configured in an enterprise.

" + ] }, { "serverUrl": "https://api.github.com", @@ -322353,6 +322353,7 @@ } ], "previews": [], + "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -322362,8 +322363,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -322679,6 +322679,7 @@ } ], "previews": [], + "descriptionHTML": "

Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -322688,8 +322689,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.

" + ] }, { "serverUrl": "https://api.github.com", @@ -413522,6 +413522,7 @@ } ], "previews": [], + "descriptionHTML": "

Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

", "statusCodes": [ { "httpStatusCode": "200", @@ -413531,8 +413532,7 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ], - "descriptionHTML": "

Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

" + ] }, { "serverUrl": "https://api.github.com", @@ -432132,13 +432132,13 @@ } ], "previews": [], + "descriptionHTML": "

Get API request count statistics for an actor broken down by route within a specified time frame.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get API request count statistics for an actor broken down by route within a specified time frame.

" + ] }, { "serverUrl": "https://api.github.com", @@ -438712,13 +438712,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.

\n
\n

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.

\n
\n

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -444836,13 +444836,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

OAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -446120,13 +446120,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -448175,13 +448175,13 @@ } ], "previews": [], + "descriptionHTML": "

List all users who are outside collaborators of an organization.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

List all users who are outside collaborators of an organization.

" + ] }, { "serverUrl": "https://api.github.com", @@ -462546,6 +462546,7 @@ } ], "previews": [], + "descriptionHTML": "

You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks\nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", @@ -462559,8 +462560,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks\nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" + ] }, { "serverUrl": "https://api.github.com", @@ -513409,13 +513409,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", @@ -535166,13 +535166,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n
\n

List the reactions to a team discussion comment.

\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

\n
\n

List the reactions to a team discussion comment.

\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -648567,6 +648567,7 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", "statusCodes": [ { "httpStatusCode": "204", @@ -648576,8 +648577,7 @@ "httpStatusCode": "403", "description": "

Forbidden if the project is not owned by the organization

" } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
" + ] }, { "serverUrl": "https://api.github.com", @@ -661572,13 +661572,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 Delete a discussion comment endpoint.

\n
\n

Deletes a comment on a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "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 Delete a discussion comment endpoint.

\n
\n

Deletes a comment on a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" + ] } ], "discussions": [ diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 5627e7969b01..fb02b71526eb 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -553,13 +553,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -1000,13 +1000,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3021,13 +3021,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes an organization from 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.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes an organization from 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.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3254,13 +3254,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Success response

" } - ] + ], + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3326,13 +3326,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

Success response

" } - ] + ], + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -8224,13 +8224,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9550,13 +9550,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9783,13 +9783,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10449,13 +10449,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10664,13 +10664,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16034,13 +16034,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16210,13 +16210,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19719,13 +19719,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth 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.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

\n
./config.sh remove --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth 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.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -26860,13 +26860,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific variable in a repository.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific variable in a repository.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -27026,13 +27026,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28105,13 +28105,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32202,13 +32202,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

\n

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.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

\n

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.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -35029,13 +35029,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a specific workflow run.

\n

Anyone with write access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a specific workflow run.

\n

Anyone with write access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -38417,13 +38417,13 @@ } ], "previews": [], - "descriptionHTML": "

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"

\n

Note

\n

\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"

\n

Note

\n

\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -39276,13 +39276,13 @@ } ], "previews": [], - "descriptionHTML": "

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -40144,13 +40144,13 @@ } ], "previews": [], - "descriptionHTML": "

Approve or reject pending deployments that are waiting on approval by a required reviewer.

\n

Required reviewers with read access to the repository contents and deployments can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Approve or reject pending deployments that are waiting on approval by a required reviewer.

\n

Required reviewers with read access to the repository contents and deployments can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -43870,13 +43870,13 @@ } ], "previews": [], - "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.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

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.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" } ] }, @@ -80708,13 +80708,13 @@ } ], "previews": [], - "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server 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 Server as done: https://github.com/notifications.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -90650,13 +90650,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the announcement banner to display for the organization.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Sets the announcement banner to display for the organization.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -125614,13 +125614,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.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -136790,13 +136790,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new check run for a specific commit in a repository.

\n

To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.

\n

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Creates a new check run for a specific commit in a repository.

\n

To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.

\n

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -185721,13 +185721,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -188769,13 +188769,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -195624,13 +195624,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

A list of custom deployment rule integrations available for this environment.

" } - ] + ], + "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -200689,13 +200689,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -201382,13 +201382,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the statistics about security products for a GitHub Enterprise Server instance.

\n

To use this endpoint, you must be a site admin.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the statistics about security products for a GitHub Enterprise Server instance.

\n

To use this endpoint, you must be a site admin.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -201445,13 +201445,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" } ], "announcement": [ @@ -201643,13 +201643,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the message and expiration time for the global announcement banner in your enterprise.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Sets the message and expiration time for the global announcement banner in your enterprise.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -202309,13 +202309,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an enterprise per repository.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

\n

The total number of repositories with committer information is tracked by the total_count field.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Success

" } - ] + ], + "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an enterprise per repository.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

\n

The total number of repositories with committer information is tracked by the total_count field.

" } ], "code-security-and-analysis": [ @@ -206707,7 +206707,6 @@ } ], "previews": [], - "descriptionHTML": "

Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"GitHub Enterprise Server releases.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -206721,7 +206720,8 @@ "httpStatusCode": "500", "description": "

Internal error

" } - ] + ], + "descriptionHTML": "

Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"GitHub Enterprise Server releases.\"

" } ], "management-console": [ @@ -260113,7 +260113,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists the available assignees for issues in a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -260123,7 +260122,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Lists the available assignees for issues in a repository.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -268888,7 +268888,6 @@ } ], "previews": [], - "descriptionHTML": "

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -268898,7 +268897,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -313396,13 +313396,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", @@ -313639,13 +313639,13 @@ } ], "previews": [], - "descriptionHTML": "

Get the octocat as ASCII art

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get the octocat as ASCII art

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -338489,13 +338489,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

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.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -356291,7 +356291,6 @@ } ], "previews": [], - "descriptionHTML": "

Redeliver a delivery for a webhook configured in an organization.

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "202", @@ -356305,7 +356304,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Redeliver a delivery for a webhook configured in an organization.

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -371327,13 +371327,13 @@ } ], "previews": [], - "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.

\n

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

", "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.

\n

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -400934,13 +400934,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -420187,13 +420187,13 @@ } ], "previews": [], - "descriptionHTML": "

List the reactions to a team discussion.

\n

Note

\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/reactions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

List the reactions to a team discussion.

\n

Note

\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/reactions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -420885,13 +420885,13 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n
\n

Delete a reaction to a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Note

\n

\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n
\n

Delete a reaction to a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -430132,13 +430132,13 @@ } ], "previews": [], - "descriptionHTML": "

View the latest published full release for the repository.

\n

The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

View the latest published full release for the repository.

\n

The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -450763,13 +450763,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -515662,13 +515662,13 @@ } ], "previews": [], - "descriptionHTML": "

Get a specific comment on a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get a specific comment on a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -520045,13 +520045,13 @@ } ], "previews": [], - "descriptionHTML": "

Delete a discussion from a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Delete a discussion from a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -522837,13 +522837,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a connection between a team and an external group.

\n

You 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.

\n

You 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": [