diff --git a/assets/images/help/copilot/mcp-icon-in-dropdown.png b/assets/images/help/copilot/mcp-icon-in-dropdown.png new file mode 100644 index 000000000000..431cdc82d384 Binary files /dev/null and b/assets/images/help/copilot/mcp-icon-in-dropdown.png differ diff --git a/content/copilot/concepts/context/mcp.md b/content/copilot/concepts/context/mcp.md index 0a865051db82..d6dc84e2090a 100644 --- a/content/copilot/concepts/context/mcp.md +++ b/content/copilot/concepts/context/mcp.md @@ -45,6 +45,13 @@ Running the {% data variables.product.github %} MCP server locally requires a bi To learn how to set up and use the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server). +## About the {% data variables.product.github %} MCP Registry + +The {% data variables.product.github %} MCP Registry is a curated list of MCP servers from partners and the community. You can use the registry to discover new MCP servers and find ones that meet your specific needs. See [the {% data variables.product.github %} MCP Registry](https://github.com/mcp). + +>[!NOTE] +> The {% data variables.product.github %} MCP Registry is currently in {% data variables.release-phases.public_preview %} and subject to change. + ## Availability There is currently broad support for local MCP servers in clients such as {% data variables.product.prodname_vscode %}, JetBrains IDEs, XCode, and others. diff --git a/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md b/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md index e26defea2a09..e717567b9db8 100644 --- a/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md +++ b/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md @@ -35,6 +35,25 @@ For information on currently available MCP servers, see [the MCP servers reposit ## Configuring MCP servers in {% data variables.product.prodname_vscode %} +MCP servers can be configured manually in a configuration file, or through the {% data variables.product.github %} MCP Registry. The {% data variables.product.github %} MCP Registry provides a curated list of MCP servers that you can easily add to your {% data variables.product.prodname_vscode %} instance. + +### Using the {% data variables.product.github %} MCP Registry + +>[!NOTE] +> The {% data variables.product.github %} MCP Registry is in {% data variables.release-phases.public_preview %} and may change. + +Only MCP servers listed in the {% data variables.product.github %} MCP Registry can be added through the registry. Other servers can be configured manually. See [Configuring MCP servers manually](#configuring-mcp-servers-manually). + +1. Visit the [{% data variables.product.github %} MCP Registry](https://github.com/mcp). +1. In the search bar, search for the MCP server you want to add, then click the MCP server in the list of matches. +1. On the MCP server page, read the description for details on installation requirements and other important usage information. This may vary between servers. +1. Click **Install server**, then select **Install in {% data variables.product.prodname_vscode_shortname %}**. +1. {% data variables.product.prodname_vscode %} will open, on the server's Marketplace page. Click **Install** to add the MCP server to your {% data variables.product.prodname_vscode %} instance. +1. If further configuration is required, follow the instructions on the MCP server page in the {% data variables.product.github %} MCP Registry. +1. To check that the MCP server has been added, in the **agent mode** of {% data variables.copilot.copilot_chat_short %}, click the tools icon. A dropdown list will appear, showing all the MCP servers and associated tools that are currently available in your {% data variables.product.prodname_vscode %} instance. + +### Configuring MCP servers manually + To configure MCP servers in {% data variables.product.prodname_vscode %}, you need to set up a configuration script that specifies the details of the MCP servers you want to use. You can configure MCP servers for either: {% data reusables.copilot.mcp.mcp-configuration-location %} diff --git a/data/reusables/profile/copilot_settings.md b/data/reusables/profile/copilot_settings.md new file mode 100644 index 000000000000..49d581592a9c --- /dev/null +++ b/data/reusables/profile/copilot_settings.md @@ -0,0 +1 @@ +1. In the top right corner of {% data variables.product.prodname_dotcom %}, click your profile picture, then click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %} settings**. diff --git a/data/reusables/two_fa/sms-warning.md b/data/reusables/two_fa/sms-warning.md index 52dc7c50dbb5..42f2bc2d0ed3 100644 --- a/data/reusables/two_fa/sms-warning.md +++ b/data/reusables/two_fa/sms-warning.md @@ -1,4 +1,4 @@ Before using this method, be sure that you can receive text messages. Carrier rates may apply. > [!WARNING] -> We **strongly recommend** using a TOTP application for two-factor authentication instead of SMS, and security keys as backup methods instead of SMS. {% data variables.product.github %} doesn't support sending SMS messages to phones in every country. Before configuring authentication via text message, review the list of countries where {% data variables.product.github %} supports authentication via SMS. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported). +> We **strongly recommend** using a TOTP application for two-factor authentication instead of SMS, and using security keys as backup methods instead of SMS. SMS is susceptible to interception, does not provide resistance against phishing attacks, has unreliable deliverability, and is not supported in all countries. Before configuring authentication via text message, review the list of countries where {% data variables.product.github %} supports authentication via SMS. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported). diff --git a/src/audit-logs/data/fpt/organization.json b/src/audit-logs/data/fpt/organization.json index a4b2cc2f4a4e..f88dd26bd6b5 100644 --- a/src/audit-logs/data/fpt/organization.json +++ b/src/audit-logs/data/fpt/organization.json @@ -9313,7 +9313,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", diff --git a/src/audit-logs/data/fpt/user.json b/src/audit-logs/data/fpt/user.json index 1476221d55d7..f344231a33b8 100644 --- a/src/audit-logs/data/fpt/user.json +++ b/src/audit-logs/data/fpt/user.json @@ -4083,7 +4083,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -8086,7 +8086,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghec/enterprise.json b/src/audit-logs/data/ghec/enterprise.json index 412feee4555b..aae8bba4971f 100644 --- a/src/audit-logs/data/ghec/enterprise.json +++ b/src/audit-logs/data/ghec/enterprise.json @@ -12644,7 +12644,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", diff --git a/src/audit-logs/data/ghec/organization.json b/src/audit-logs/data/ghec/organization.json index a4b2cc2f4a4e..f88dd26bd6b5 100644 --- a/src/audit-logs/data/ghec/organization.json +++ b/src/audit-logs/data/ghec/organization.json @@ -9313,7 +9313,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", diff --git a/src/audit-logs/data/ghec/user.json b/src/audit-logs/data/ghec/user.json index 1476221d55d7..f344231a33b8 100644 --- a/src/audit-logs/data/ghec/user.json +++ b/src/audit-logs/data/ghec/user.json @@ -4083,7 +4083,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -8086,7 +8086,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.14/enterprise.json b/src/audit-logs/data/ghes-3.14/enterprise.json index 6f9666ee55fa..83e7df922dbd 100644 --- a/src/audit-logs/data/ghes-3.14/enterprise.json +++ b/src/audit-logs/data/ghes-3.14/enterprise.json @@ -8793,7 +8793,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -15569,7 +15569,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.14/organization.json b/src/audit-logs/data/ghes-3.14/organization.json index 7d04af529477..d27bb8920bc6 100644 --- a/src/audit-logs/data/ghes-3.14/organization.json +++ b/src/audit-logs/data/ghes-3.14/organization.json @@ -8456,7 +8456,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", diff --git a/src/audit-logs/data/ghes-3.14/user.json b/src/audit-logs/data/ghes-3.14/user.json index 8b506d1c4f05..a14400b3331d 100644 --- a/src/audit-logs/data/ghes-3.14/user.json +++ b/src/audit-logs/data/ghes-3.14/user.json @@ -3757,7 +3757,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -7644,7 +7644,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.15/enterprise.json b/src/audit-logs/data/ghes-3.15/enterprise.json index 30d1de1c0f45..5cd39ba45899 100644 --- a/src/audit-logs/data/ghes-3.15/enterprise.json +++ b/src/audit-logs/data/ghes-3.15/enterprise.json @@ -8876,7 +8876,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -15768,7 +15768,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.15/organization.json b/src/audit-logs/data/ghes-3.15/organization.json index cd0d4e22edb0..4b36d8c64a99 100644 --- a/src/audit-logs/data/ghes-3.15/organization.json +++ b/src/audit-logs/data/ghes-3.15/organization.json @@ -8565,7 +8565,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", diff --git a/src/audit-logs/data/ghes-3.15/user.json b/src/audit-logs/data/ghes-3.15/user.json index cfb0080e0a93..0d328c4eeb5f 100644 --- a/src/audit-logs/data/ghes-3.15/user.json +++ b/src/audit-logs/data/ghes-3.15/user.json @@ -3840,7 +3840,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -7843,7 +7843,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.16/enterprise.json b/src/audit-logs/data/ghes-3.16/enterprise.json index 18f1f2ad3a8f..da1d3639b6f2 100644 --- a/src/audit-logs/data/ghes-3.16/enterprise.json +++ b/src/audit-logs/data/ghes-3.16/enterprise.json @@ -9231,7 +9231,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -16482,7 +16482,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.16/organization.json b/src/audit-logs/data/ghes-3.16/organization.json index e061faf96dd4..a07015de5c15 100644 --- a/src/audit-logs/data/ghes-3.16/organization.json +++ b/src/audit-logs/data/ghes-3.16/organization.json @@ -8907,7 +8907,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", diff --git a/src/audit-logs/data/ghes-3.16/user.json b/src/audit-logs/data/ghes-3.16/user.json index da7a07bee2e2..0c21912c94e1 100644 --- a/src/audit-logs/data/ghes-3.16/user.json +++ b/src/audit-logs/data/ghes-3.16/user.json @@ -3994,7 +3994,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -7997,7 +7997,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.17/enterprise.json b/src/audit-logs/data/ghes-3.17/enterprise.json index ec958b05c3bb..41ad6afc1bd3 100644 --- a/src/audit-logs/data/ghes-3.17/enterprise.json +++ b/src/audit-logs/data/ghes-3.17/enterprise.json @@ -9609,7 +9609,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -16929,7 +16929,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.17/organization.json b/src/audit-logs/data/ghes-3.17/organization.json index 9a187a452c72..1c294a17cc48 100644 --- a/src/audit-logs/data/ghes-3.17/organization.json +++ b/src/audit-logs/data/ghes-3.17/organization.json @@ -9097,7 +9097,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", diff --git a/src/audit-logs/data/ghes-3.17/user.json b/src/audit-logs/data/ghes-3.17/user.json index 6dd03cca704b..d8f80000e775 100644 --- a/src/audit-logs/data/ghes-3.17/user.json +++ b/src/audit-logs/data/ghes-3.17/user.json @@ -4057,7 +4057,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -8060,7 +8060,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.18/enterprise.json b/src/audit-logs/data/ghes-3.18/enterprise.json index 37e61c45eff8..706c6a8ec582 100644 --- a/src/audit-logs/data/ghes-3.18/enterprise.json +++ b/src/audit-logs/data/ghes-3.18/enterprise.json @@ -9658,7 +9658,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -17032,7 +17032,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.18/organization.json b/src/audit-logs/data/ghes-3.18/organization.json index db63bbe2a581..812b787ee78f 100644 --- a/src/audit-logs/data/ghes-3.18/organization.json +++ b/src/audit-logs/data/ghes-3.18/organization.json @@ -9288,7 +9288,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", diff --git a/src/audit-logs/data/ghes-3.18/user.json b/src/audit-logs/data/ghes-3.18/user.json index 1476221d55d7..f344231a33b8 100644 --- a/src/audit-logs/data/ghes-3.18/user.json +++ b/src/audit-logs/data/ghes-3.18/user.json @@ -4083,7 +4083,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "project.access", @@ -8086,7 +8086,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "Personalizing your profile" + "docs_reference_titles": "Personalize your profile" }, { "action": "user.suspend", diff --git a/src/content-linter/lib/default-markdownlint-options.js b/src/content-linter/lib/default-markdownlint-options.js deleted file mode 100644 index ccdda0329a94..000000000000 --- a/src/content-linter/lib/default-markdownlint-options.js +++ /dev/null @@ -1,3 +0,0 @@ -export const defaultConfig = { - default: false, -} diff --git a/src/content-linter/lib/default-markdownlint-options.ts b/src/content-linter/lib/default-markdownlint-options.ts new file mode 100644 index 000000000000..d21f286179b2 --- /dev/null +++ b/src/content-linter/lib/default-markdownlint-options.ts @@ -0,0 +1,5 @@ +import type { Configuration } from 'markdownlint' + +export const defaultConfig: Configuration = { + default: false, +} diff --git a/src/content-linter/lib/helpers/get-rules.d.ts b/src/content-linter/lib/helpers/get-rules.d.ts deleted file mode 100644 index 694e3ec21464..000000000000 --- a/src/content-linter/lib/helpers/get-rules.d.ts +++ /dev/null @@ -1,8 +0,0 @@ -// get-rules.d.ts -// This is a declaration file for get-rules.js - -import type { Rule, RuleConfig } from '../../types' - -export const customRules: Rule[] -export const allRules: Rule[] -export const allConfig: RuleConfig diff --git a/src/content-linter/lib/helpers/get-rules.js b/src/content-linter/lib/helpers/get-rules.js deleted file mode 100644 index efa98024f5ad..000000000000 --- a/src/content-linter/lib/helpers/get-rules.js +++ /dev/null @@ -1,8 +0,0 @@ -import rules from '../../../../node_modules/markdownlint/lib/rules' -import { gitHubDocsMarkdownlint } from '../linting-rules/index' -import { baseConfig } from '../../style/base' -import { customConfig } from '../../style/github-docs' - -export const customRules = gitHubDocsMarkdownlint.rules -export const allRules = [...rules, ...gitHubDocsMarkdownlint.rules] -export const allConfig = { ...baseConfig, ...customConfig } diff --git a/src/content-linter/lib/helpers/get-rules.ts b/src/content-linter/lib/helpers/get-rules.ts new file mode 100644 index 000000000000..eaeaf8660aa9 --- /dev/null +++ b/src/content-linter/lib/helpers/get-rules.ts @@ -0,0 +1,12 @@ +import { gitHubDocsMarkdownlint } from '@/content-linter/lib/linting-rules/index' +import { baseConfig } from '@/content-linter/style/base' +import { customConfig } from '@/content-linter/style/github-docs' +import type { Rule } from '@/content-linter/types' + +// Import markdownlint rules - external library without TypeScript declarations +// @ts-ignore - markdownlint doesn't provide TypeScript declarations +import markdownlintRules from '../../../../node_modules/markdownlint/lib/rules' + +export const customRules: Rule[] = gitHubDocsMarkdownlint.rules +export const allRules: any[] = [...markdownlintRules, ...gitHubDocsMarkdownlint.rules] +export const allConfig: Record = { ...baseConfig, ...customConfig } diff --git a/src/content-linter/lib/helpers/unified-formatter-options.js b/src/content-linter/lib/helpers/unified-formatter-options.js deleted file mode 100644 index d5efae175118..000000000000 --- a/src/content-linter/lib/helpers/unified-formatter-options.js +++ /dev/null @@ -1,9 +0,0 @@ -export const MARKDOWN_OPTIONS = { - bullet: '*', - emphasis: '_', - closeAtx: false, - fence: '`', - fences: true, - incrementListMarker: false, - strong: '*', -} diff --git a/src/content-linter/lib/helpers/unified-formatter-options.ts b/src/content-linter/lib/helpers/unified-formatter-options.ts new file mode 100644 index 000000000000..a4d20e8daa6e --- /dev/null +++ b/src/content-linter/lib/helpers/unified-formatter-options.ts @@ -0,0 +1,19 @@ +interface MarkdownFormatterOptions { + bullet: string + emphasis: string + closeAtx: boolean + fence: string + fences: boolean + incrementListMarker: boolean + strong: string +} + +export const MARKDOWN_OPTIONS: MarkdownFormatterOptions = { + bullet: '*', + emphasis: '_', + closeAtx: false, + fence: '`', + fences: true, + incrementListMarker: false, + strong: '*', +} diff --git a/src/content-render/liquid/error-handling.js b/src/content-render/liquid/error-handling.ts similarity index 70% rename from src/content-render/liquid/error-handling.js rename to src/content-render/liquid/error-handling.ts index d131cb7dd5ef..c37e1a4b2ec2 100644 --- a/src/content-render/liquid/error-handling.js +++ b/src/content-render/liquid/error-handling.ts @@ -1,9 +1,9 @@ // If 'THROW_ON_EMPTY' is set and it's value is '0' or 'false' it becomes // false. Or true if it's 'true' or '1'. -export const THROW_ON_EMPTY = Boolean( +export const THROW_ON_EMPTY: boolean = Boolean( process.env.THROW_ON_EMPTY ? JSON.parse(process.env.THROW_ON_EMPTY) - : JSON.parse(process.env.CI || process.env.NODE_ENV !== 'production'), + : JSON.parse(String(process.env.CI || process.env.NODE_ENV !== 'production')), ) export class DataReferenceError extends Error {} diff --git a/src/content-render/liquid/ifversion-supported-operators.js b/src/content-render/liquid/ifversion-supported-operators.js deleted file mode 100644 index 03234759e50e..000000000000 --- a/src/content-render/liquid/ifversion-supported-operators.js +++ /dev/null @@ -1 +0,0 @@ -export default ['=', '<', '>', '!='] diff --git a/src/content-render/liquid/ifversion-supported-operators.ts b/src/content-render/liquid/ifversion-supported-operators.ts new file mode 100644 index 000000000000..735c32f40c41 --- /dev/null +++ b/src/content-render/liquid/ifversion-supported-operators.ts @@ -0,0 +1,5 @@ +const ifversionSupportedOperators = ['=', '<', '>', '!='] as const + +export type IfversionSupportedOperator = (typeof ifversionSupportedOperators)[number] + +export default ifversionSupportedOperators diff --git a/src/content-render/liquid/index.js b/src/content-render/liquid/index.ts similarity index 69% rename from src/content-render/liquid/index.js rename to src/content-render/liquid/index.ts index 412d11b75c23..ec46b21a7d2a 100644 --- a/src/content-render/liquid/index.js +++ b/src/content-render/liquid/index.ts @@ -1,7 +1,7 @@ import { processLiquidPost } from './post' import { engine } from './engine' -export async function renderLiquid(template, context) { +export async function renderLiquid(template: string, context: any): Promise { template = await engine.parseAndRender(template, context) template = processLiquidPost(template) return template diff --git a/src/data-directory/lib/data-schemas/code-languages.js b/src/data-directory/lib/data-schemas/code-languages.js deleted file mode 100644 index e3c89a434f91..000000000000 --- a/src/data-directory/lib/data-schemas/code-languages.js +++ /dev/null @@ -1,16 +0,0 @@ -export default { - type: 'object', - additionalProperties: { - type: 'object', - required: ['name', 'comment'], - properties: { - name: { - type: 'string', - }, - comment: { - type: 'string', - enum: ['number', 'slash', 'percent', 'hyphen', 'xml', 'none'], - }, - }, - }, -} diff --git a/src/data-directory/lib/data-schemas/code-languages.ts b/src/data-directory/lib/data-schemas/code-languages.ts new file mode 100644 index 000000000000..aa7f48e996e6 --- /dev/null +++ b/src/data-directory/lib/data-schemas/code-languages.ts @@ -0,0 +1,37 @@ +interface CodeLanguageProperties { + name: { + type: 'string' + } + comment: { + type: 'string' + enum: ['number', 'slash', 'percent', 'hyphen', 'xml', 'none'] + } +} + +interface CodeLanguageSchema { + type: 'object' + additionalProperties: { + type: 'object' + required: ['name', 'comment'] + properties: CodeLanguageProperties + } +} + +const codeLanguagesSchema: CodeLanguageSchema = { + type: 'object', + additionalProperties: { + type: 'object', + required: ['name', 'comment'], + properties: { + name: { + type: 'string', + }, + comment: { + type: 'string', + enum: ['number', 'slash', 'percent', 'hyphen', 'xml', 'none'], + }, + }, + }, +} + +export default codeLanguagesSchema diff --git a/src/data-directory/lib/data-schemas/index.ts b/src/data-directory/lib/data-schemas/index.ts index e8d58ceb5ed4..160483e39d6d 100644 --- a/src/data-directory/lib/data-schemas/index.ts +++ b/src/data-directory/lib/data-schemas/index.ts @@ -4,10 +4,10 @@ interface DataSchemas { const dataSchemas: DataSchemas = { 'data/features': '@/data-directory/lib/data-schemas/features.js', - 'data/variables': '@/data-directory/lib/data-schemas/variables.js', + 'data/variables': '@/data-directory/lib/data-schemas/variables', 'data/learning-tracks': '@/data-directory/lib/data-schemas/learning-tracks.js', 'data/release-notes': '@/data-directory/lib/data-schemas/release-notes.js', - 'data/code-languages.yml': '@/data-directory/lib/data-schemas/code-languages.js', + 'data/code-languages.yml': '@/data-directory/lib/data-schemas/code-languages', 'data/glossaries/candidates.yml': '@/data-directory/lib/data-schemas/glossaries-candidates.js', 'data/glossaries/external.yml': '@/data-directory/lib/data-schemas/glossaries-external.js', } diff --git a/src/data-directory/lib/data-schemas/variables.js b/src/data-directory/lib/data-schemas/variables.js deleted file mode 100644 index 3cec2cc6ff4a..000000000000 --- a/src/data-directory/lib/data-schemas/variables.js +++ /dev/null @@ -1,7 +0,0 @@ -export default { - type: 'object', - additionalProperties: { - type: 'string', - lintable: true, - }, -} diff --git a/src/data-directory/lib/data-schemas/variables.ts b/src/data-directory/lib/data-schemas/variables.ts new file mode 100644 index 000000000000..62ba9e1937cd --- /dev/null +++ b/src/data-directory/lib/data-schemas/variables.ts @@ -0,0 +1,17 @@ +interface VariableSchema { + type: 'object' + additionalProperties: { + type: 'string' + lintable: boolean + } +} + +const variablesSchema: VariableSchema = { + type: 'object', + additionalProperties: { + type: 'string', + lintable: true, + }, +} + +export default variablesSchema diff --git a/src/frame/lib/encode-bracketed-parentheses.js b/src/frame/lib/encode-bracketed-parentheses.ts similarity index 69% rename from src/frame/lib/encode-bracketed-parentheses.js rename to src/frame/lib/encode-bracketed-parentheses.ts index e3e4b3040375..d0df9a4a12ae 100644 --- a/src/frame/lib/encode-bracketed-parentheses.js +++ b/src/frame/lib/encode-bracketed-parentheses.ts @@ -1,6 +1,6 @@ // prevent `[foo] (bar)` strings with a space between from being interpreted as markdown links // by encoding the space character -export default function encodeBracketedParentheses(input) { +export default function encodeBracketedParentheses(input: string): string { return input.replace(/] \(/g, '] (') } diff --git a/src/frame/lib/read-file-contents.js b/src/frame/lib/read-file-contents.ts similarity index 55% rename from src/frame/lib/read-file-contents.js rename to src/frame/lib/read-file-contents.ts index 9b3aefc698c0..299efed569a7 100644 --- a/src/frame/lib/read-file-contents.js +++ b/src/frame/lib/read-file-contents.ts @@ -6,8 +6,9 @@ import fm from './frontmatter' /** * Read only the frontmatter from file */ -export default async function fmfromf(filepath) { - let fileContent = await fs.readFile(filepath, 'utf8') +// Using any type for return value because frontmatter structure is complex and varies +export default async function fmfromf(filepath: string): Promise { + let fileContent: string = await fs.readFile(filepath, 'utf8') fileContent = encodeBracketedParentheses(fileContent) diff --git a/src/frame/tests/gitignore.js b/src/frame/tests/gitignore.ts similarity index 57% rename from src/frame/tests/gitignore.js rename to src/frame/tests/gitignore.ts index 989f42e63ac8..760ac36341a7 100644 --- a/src/frame/tests/gitignore.js +++ b/src/frame/tests/gitignore.ts @@ -3,9 +3,9 @@ import path from 'path' import { describe, expect, test } from 'vitest' -const gitignorePath = path.join(process.cwd(), '.gitignore') -const gitignore = await fs.readFile(gitignorePath, 'utf8') -const entries = gitignore.split(/\r?\n/) +const gitignorePath: string = path.join(process.cwd(), '.gitignore') +const gitignore: string = await fs.readFile(gitignorePath, 'utf8') +const entries: string[] = gitignore.split(/\r?\n/) describe('.gitignore file', () => { test('includes an entry for .env', () => { diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 74d5560d37d0..03576fcaf487 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -960,51 +960,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index d7c5f158fbbe..39ad24261576 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -3348,36 +3348,6 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index 6307a3699961..2eaa98e7cfb8 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -1166,61 +1166,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 3d4f16446107..aee06408a35b 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -3302,36 +3302,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 607762fac6ec..4ee0b61c6d28 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -3782,36 +3782,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index 62d97266e55e..c06ea676a55f 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -1278,51 +1278,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index b12b697c99be..43de873d6a9f 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -3706,36 +3706,6 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index d810ca9e4b05..d95bd21c6b44 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -1718,61 +1718,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 87a0215e9f4d..073670ccc0eb 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -3714,36 +3714,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 1f561cb65928..54a0de0289cd 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -4194,36 +4194,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json index a0e2431d73c3..aaa6365caee7 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json @@ -489,51 +489,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json index b51afcee950f..5e94c8abffda 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json @@ -2494,36 +2494,6 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json index ef851ab28ee4..e9d402fb5def 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json @@ -593,61 +593,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json index e7827f370f74..49976d0f3cca 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json @@ -2664,36 +2664,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json index 529e412ccfe2..0f43b26d176b 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json @@ -2852,36 +2852,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json index 7d5b83f52882..a3af5e5c3b06 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json @@ -579,51 +579,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json index 8ae5ea1d09a8..1672a5dadd13 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json @@ -2562,36 +2562,6 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json index 38df7513e92e..f17e6d35085b 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json @@ -703,61 +703,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json index bc97965188ba..33c779631da9 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json @@ -2732,36 +2732,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json index 2baeff7e9912..9c4ed4683e2d 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json @@ -2920,36 +2920,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json index 99e811b8da8a..f38934f606d2 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json @@ -579,51 +579,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json index 46f1ba7fd921..3eee3fc38e02 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json @@ -2562,36 +2562,6 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json index 6c6c55ecc737..0d08cc22b4af 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json @@ -703,61 +703,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json index 3b45f9e67810..8bd98b94c7b2 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json @@ -2732,36 +2732,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json index 3c5539380384..b2445798471d 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json @@ -2920,36 +2920,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json index 2c9a3a6bbcf3..adec1a449b4a 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json @@ -588,51 +588,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "read" - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "additional-permissions": false, - "access": "admin" - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json index f4f32f3469f4..1fd635a9152c 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json @@ -2568,36 +2568,6 @@ "verb": "delete", "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json index 768cd588acf4..285e3ed8a2c0 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json @@ -714,61 +714,6 @@ "title": "Custom properties", "displayTitle": "Organization permissions for \"Custom properties\"", "permissions": [ - { - "category": "orgs", - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "orgs", - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", - "access": "admin", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, { "category": "orgs", "slug": "list-custom-property-values-for-organization-repositories", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json index 66735be1dbc2..83414ae2b83e 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json @@ -2738,36 +2738,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json index a1241a0fbf21..367243f9d56e 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json @@ -2926,36 +2926,6 @@ "verb": "get", "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, - { - "slug": "get-all-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "create-or-update-custom-properties-for-an-organization", - "subcategory": "custom-properties", - "verb": "patch", - "requestPath": "/orgs/{org}/properties/schema" - }, - { - "slug": "get-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "get", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "create-or-update-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "put", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, - { - "slug": "remove-a-custom-property-for-an-organization", - "subcategory": "custom-properties", - "verb": "delete", - "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" - }, { "slug": "list-custom-property-values-for-organization-repositories", "subcategory": "custom-properties", diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index bd6ce479bfd7..8dbc38772e7c 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,21 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Type CopilotCodeReviewParameters was added

", + "

Type CopilotCodeReviewParametersInput was added

", + "

Enum value 'COPILOT_CODE_REVIEWwas added to enumRepositoryRuleType'

", + "

Member CopilotCodeReviewParameters was added to Union type RuleParameters

", + "

Input field copilotCodeReview of type CopilotCodeReviewParametersInput was added to input object type RuleParametersInput

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2025-09-16" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index f44cad4cede4..b4737f6059fc 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -7250,6 +7250,36 @@ type ConvertedToDiscussionEvent implements Node { id: ID! } +""" +Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. +""" +type CopilotCodeReviewParameters { + """ + Copilot automatically reviews draft pull requests before they are marked as ready for review. + """ + reviewDraftPullRequests: Boolean! + + """ + Copilot automatically reviews each new push to the pull request. + """ + reviewOnPush: Boolean! +} + +""" +Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. +""" +input CopilotCodeReviewParametersInput { + """ + Copilot automatically reviews draft pull requests before they are marked as ready for review. + """ + reviewDraftPullRequests: Boolean + + """ + Copilot automatically reviews each new push to the pull request. + """ + reviewOnPush: Boolean +} + """ Copilot endpoint information """ @@ -52909,6 +52939,11 @@ enum RepositoryRuleType { """ COMMIT_MESSAGE_PATTERN + """ + Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. + """ + COPILOT_CODE_REVIEW + """ Only allow users with bypass permission to create matching refs. """ @@ -54874,6 +54909,7 @@ union RuleParameters = | CommitAuthorEmailPatternParameters | CommitMessagePatternParameters | CommitterEmailPatternParameters + | CopilotCodeReviewParameters | FileExtensionRestrictionParameters | FilePathRestrictionParameters | MaxFilePathLengthParameters @@ -54915,6 +54951,11 @@ input RuleParametersInput { """ committerEmailPattern: CommitterEmailPatternParametersInput + """ + Parameters used for the `copilot_code_review` rule type + """ + copilotCodeReview: CopilotCodeReviewParametersInput + """ Parameters used for the `file_extension_restriction` rule type """ diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index b0ea2c548730..d2a5402ed2c7 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -17432,6 +17432,31 @@ } ] }, + { + "name": "CopilotCodeReviewParameters", + "kind": "objects", + "id": "copilotcodereviewparameters", + "href": "/graphql/reference/objects#copilotcodereviewparameters", + "description": "

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.

", + "fields": [ + { + "name": "reviewDraftPullRequests", + "description": "

Copilot automatically reviews draft pull requests before they are marked as ready for review.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "reviewOnPush", + "description": "

Copilot automatically reviews each new push to the pull request.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + ] + }, { "name": "CopilotEndpoints", "kind": "objects", @@ -92881,6 +92906,10 @@ "name": "COMMIT_MESSAGE_PATTERN", "description": "

Commit message pattern.

" }, + { + "name": "COPILOT_CODE_REVIEW", + "description": "

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.

" + }, { "name": "CREATION", "description": "

Only allow users with bypass permission to create matching refs.

" @@ -97143,6 +97172,11 @@ "id": "committeremailpatternparameters", "href": "/graphql/reference/objects#committeremailpatternparameters" }, + { + "name": "CopilotCodeReviewParameters", + "id": "copilotcodereviewparameters", + "href": "/graphql/reference/objects#copilotcodereviewparameters" + }, { "name": "FileExtensionRestrictionParameters", "id": "fileextensionrestrictionparameters", @@ -99886,6 +99920,31 @@ } ] }, + { + "name": "CopilotCodeReviewParametersInput", + "kind": "inputObjects", + "id": "copilotcodereviewparametersinput", + "href": "/graphql/reference/input-objects#copilotcodereviewparametersinput", + "description": "

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.

", + "inputFields": [ + { + "name": "reviewDraftPullRequests", + "description": "

Copilot automatically reviews draft pull requests before they are marked as ready for review.

", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "reviewOnPush", + "description": "

Copilot automatically reviews each new push to the pull request.

", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + ] + }, { "name": "CopyProjectV2Input", "kind": "inputObjects", @@ -107134,6 +107193,14 @@ "kind": "input-objects", "href": "/graphql/reference/input-objects#committeremailpatternparametersinput" }, + { + "name": "copilotCodeReview", + "description": "

Parameters used for the copilot_code_review rule type.

", + "type": "CopilotCodeReviewParametersInput", + "id": "copilotcodereviewparametersinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#copilotcodereviewparametersinput" + }, { "name": "fileExtensionRestriction", "description": "

Parameters used for the file_extension_restriction rule type.

", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index f44cad4cede4..b4737f6059fc 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -7250,6 +7250,36 @@ type ConvertedToDiscussionEvent implements Node { id: ID! } +""" +Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. +""" +type CopilotCodeReviewParameters { + """ + Copilot automatically reviews draft pull requests before they are marked as ready for review. + """ + reviewDraftPullRequests: Boolean! + + """ + Copilot automatically reviews each new push to the pull request. + """ + reviewOnPush: Boolean! +} + +""" +Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. +""" +input CopilotCodeReviewParametersInput { + """ + Copilot automatically reviews draft pull requests before they are marked as ready for review. + """ + reviewDraftPullRequests: Boolean + + """ + Copilot automatically reviews each new push to the pull request. + """ + reviewOnPush: Boolean +} + """ Copilot endpoint information """ @@ -52909,6 +52939,11 @@ enum RepositoryRuleType { """ COMMIT_MESSAGE_PATTERN + """ + Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. + """ + COPILOT_CODE_REVIEW + """ Only allow users with bypass permission to create matching refs. """ @@ -54874,6 +54909,7 @@ union RuleParameters = | CommitAuthorEmailPatternParameters | CommitMessagePatternParameters | CommitterEmailPatternParameters + | CopilotCodeReviewParameters | FileExtensionRestrictionParameters | FilePathRestrictionParameters | MaxFilePathLengthParameters @@ -54915,6 +54951,11 @@ input RuleParametersInput { """ committerEmailPattern: CommitterEmailPatternParametersInput + """ + Parameters used for the `copilot_code_review` rule type + """ + copilotCodeReview: CopilotCodeReviewParametersInput + """ Parameters used for the `file_extension_restriction` rule type """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index b0ea2c548730..d2a5402ed2c7 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -17432,6 +17432,31 @@ } ] }, + { + "name": "CopilotCodeReviewParameters", + "kind": "objects", + "id": "copilotcodereviewparameters", + "href": "/graphql/reference/objects#copilotcodereviewparameters", + "description": "

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.

", + "fields": [ + { + "name": "reviewDraftPullRequests", + "description": "

Copilot automatically reviews draft pull requests before they are marked as ready for review.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "reviewOnPush", + "description": "

Copilot automatically reviews each new push to the pull request.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + ] + }, { "name": "CopilotEndpoints", "kind": "objects", @@ -92881,6 +92906,10 @@ "name": "COMMIT_MESSAGE_PATTERN", "description": "

Commit message pattern.

" }, + { + "name": "COPILOT_CODE_REVIEW", + "description": "

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.

" + }, { "name": "CREATION", "description": "

Only allow users with bypass permission to create matching refs.

" @@ -97143,6 +97172,11 @@ "id": "committeremailpatternparameters", "href": "/graphql/reference/objects#committeremailpatternparameters" }, + { + "name": "CopilotCodeReviewParameters", + "id": "copilotcodereviewparameters", + "href": "/graphql/reference/objects#copilotcodereviewparameters" + }, { "name": "FileExtensionRestrictionParameters", "id": "fileextensionrestrictionparameters", @@ -99886,6 +99920,31 @@ } ] }, + { + "name": "CopilotCodeReviewParametersInput", + "kind": "inputObjects", + "id": "copilotcodereviewparametersinput", + "href": "/graphql/reference/input-objects#copilotcodereviewparametersinput", + "description": "

Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.

", + "inputFields": [ + { + "name": "reviewDraftPullRequests", + "description": "

Copilot automatically reviews draft pull requests before they are marked as ready for review.

", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "reviewOnPush", + "description": "

Copilot automatically reviews each new push to the pull request.

", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + ] + }, { "name": "CopyProjectV2Input", "kind": "inputObjects", @@ -107134,6 +107193,14 @@ "kind": "input-objects", "href": "/graphql/reference/input-objects#committeremailpatternparametersinput" }, + { + "name": "copilotCodeReview", + "description": "

Parameters used for the copilot_code_review rule type.

", + "type": "CopilotCodeReviewParametersInput", + "id": "copilotcodereviewparametersinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#copilotcodereviewparametersinput" + }, { "name": "fileExtensionRestriction", "description": "

Parameters used for the file_extension_restriction rule type.

", diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 9c77ca94594b..358f900a0c22 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -419776,16 +419776,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -420044,16 +420034,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -420275,16 +420255,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -420511,16 +420481,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -420709,16 +420669,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 7cbe6e7bd0c3..541dfc904b65 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -459537,16 +459537,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -459805,16 +459795,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -460036,16 +460016,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -460272,16 +460242,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -460470,16 +460430,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index df16f6128079..e05b08b69e71 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -1152,13 +1152,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the GitHub Actions cache usage policy for an enterprise.

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

Sets the GitHub Actions cache usage policy 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", @@ -1554,13 +1554,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets GitHub Actions cache usage policy for a repository.

\n

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

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

OK

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

Gets GitHub Actions cache usage policy for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo 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", @@ -3178,13 +3178,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

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

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

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

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

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

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

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

No Content

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

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

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

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

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

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

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

\n

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

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

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

\n

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

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

OK

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

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

\n

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

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

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

\n

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

\n

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

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

No Content

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

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

\n

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

\n

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

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

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

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

\n

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

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

OK

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

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

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

\n

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

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

Gets a single organization secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets

\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": "200", "description": "

OK

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

Gets a single organization secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets

\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", @@ -9238,13 +9238,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runner groups 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": "

Lists all self-hosted runner groups 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", @@ -9421,13 +9421,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": "http(s)://HOSTNAME/api/v3", @@ -10665,13 +10665,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", @@ -12699,13 +12699,13 @@ } ], "previews": [], - "descriptionHTML": "

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

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

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

\n

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

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

Replaces the list of self-hosted runners that are part of an organization runner group.

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

Replaces the list of self-hosted runners that are part of an organization runner group.

\n

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

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

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

\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 a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

\n

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

" } ], "self-hosted-runners": [ @@ -17223,13 +17223,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

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

\n

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

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

OK

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

Lists all self-hosted runners configured in an organization.

\n

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

\n

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

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

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

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

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -20418,7 +20417,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

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

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

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

\n

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

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

Lists all organization variables.

\n

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

\n

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

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

OK

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

Lists all organization variables.

\n

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

\n

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

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

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).

\n

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.

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

OK

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

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).

\n

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.

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

Revokes the installation token you're using to authenticate as an installation and access this endpoint.

\n

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.

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

No Content

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

Revokes the installation token you're using to authenticate as an installation and access this endpoint.

\n

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.

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

OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

", "statusCodes": [ { "httpStatusCode": "204", @@ -107101,7 +107100,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

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

OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

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

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

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

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

OK

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

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

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

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

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\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 your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

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

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

Gets the GitHub Advanced Security active committers for an enterprise per repository. The authenticated user must be an enterprise admin or billing manager.

\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. The authenticated user must be an enterprise admin or billing manager.

\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": [ @@ -205035,13 +205035,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

Created

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

OK

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

List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.

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

OK

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

List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.

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

OK

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

No Content

" } - ] + ], + "descriptionHTML": "" } ], "repo-pre-receive-hooks": [ @@ -222444,13 +222444,13 @@ } ], "previews": [], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

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

No Content

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

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

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

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -239974,7 +239973,8 @@ "httpStatusCode": "304", "description": "

Not modified

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

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
" } ] }, @@ -317368,13 +317368,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", @@ -340883,16 +340883,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -341151,16 +341141,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -341382,16 +341362,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -341618,16 +341588,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -341816,16 +341776,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -342475,13 +342425,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", @@ -344944,7 +344894,6 @@ } ], "previews": [], - "descriptionHTML": "

In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

", "statusCodes": [ { "httpStatusCode": "200", @@ -344958,7 +344907,8 @@ "httpStatusCode": "404", "description": "

Resource not found

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

In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

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

Revokes all assigned organization roles from a user. 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": "

Revokes all assigned organization roles from a user. 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": "http(s)://HOSTNAME/api/v3", @@ -358000,7 +357950,6 @@ } ], "previews": [], - "descriptionHTML": "

Create a repository ruleset for an organization.

", "statusCodes": [ { "httpStatusCode": "201", @@ -358014,7 +357963,8 @@ "httpStatusCode": "500", "description": "

Internal Error

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

Create a repository ruleset for an organization.

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

Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

\n

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

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

OK

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

Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

\n

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

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

Lists builts of a GitHub Enterprise Server Pages site.

\n

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

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

OK

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

Lists builts of a GitHub Enterprise Server Pages site.

\n

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

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

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

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

No Content

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

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

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

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", "statusCodes": [ { "httpStatusCode": "204", @@ -460253,7 +460202,8 @@ "httpStatusCode": "404", "description": "

Not Found if repository is not enabled with vulnerability alerts

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

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

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

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes.

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

Found

" } - ] + ], + "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.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes.

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

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

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

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

OK

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

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

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

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

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

\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}/projects/{project_id}.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -513235,7 +513184,8 @@ "httpStatusCode": "404", "description": "

Not Found if project is not managed by this team

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

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

\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}/projects/{project_id}.

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

Lists a team's repositories visible to the authenticated user.

\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}/repos.

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

OK

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

Lists a team's repositories visible to the authenticated user.

\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}/repos.

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

\n
\n

Delete a discussion from a team's page.

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

\n
\n

Delete a discussion from a team's page.

\n

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

" } ], "external-groups": [ @@ -536235,7 +536185,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.

\n

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

", "statusCodes": [ { "httpStatusCode": "200", @@ -536245,7 +536194,8 @@ "httpStatusCode": "304", "description": "

Not modified

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

Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.

\n

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 0083f7ece70e..5437a72bde65 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -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", @@ -5461,13 +5461,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

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

OK

" } - ], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

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

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\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": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\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", @@ -9433,13 +9433,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": "http(s)://HOSTNAME/api/v3", @@ -9563,13 +9563,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", @@ -10008,13 +10008,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the organizations with access to a self-hosted runner 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 organizations with access to a self-hosted runner 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", @@ -10083,13 +10083,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces the list of organizations that have access to a 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": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Replaces the list of organizations that have access to a 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", @@ -10677,13 +10677,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", @@ -16427,6 +16427,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists all labels for a 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", @@ -16436,8 +16437,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Lists all labels for a 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", @@ -20966,13 +20966,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin 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": "

Lists all self-hosted runners configured in a repository.

\n

Authenticated users must have admin 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", @@ -38534,13 +38534,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", @@ -98300,6 +98300,7 @@ } ], "previews": [], + "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -98309,8 +98310,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

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

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

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

OK

" } - ], - "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

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

\n

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

\n

Disables the ability to restrict who can push to this branch.

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

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

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

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

Parameters that are not provided will be overwritten with the default value or removed if no default exists.

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

OK

" } - ], - "descriptionHTML": "

Parameters that are not provided will be overwritten with the default value or removed if no default exists.

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

Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.

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

Created

" } - ], - "descriptionHTML": "

Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.

" + ] } ], "license": [ @@ -214223,13 +214223,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

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

OK

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

Created

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -225150,6 +225150,7 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -225159,8 +225160,7 @@ "httpStatusCode": "201", "description": "

Response when creating a new impersonation OAuth token

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

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -242894,8 +242895,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
" + ] } ] }, @@ -246250,6 +246250,7 @@ } ], "previews": [], + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -246267,8 +246268,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -269594,13 +269594,13 @@ } ], "previews": [], + "descriptionHTML": "

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

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

Created

" } - ], - "descriptionHTML": "

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

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

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -298508,8 +298509,7 @@ "httpStatusCode": "410", "description": "

Gone

" } - ], - "descriptionHTML": "

Lists all events for an issue.

" + ] } ], "labels": [ @@ -301736,6 +301736,7 @@ } ], "previews": [], + "descriptionHTML": "

Gets a milestone using the given milestone number.

", "statusCodes": [ { "httpStatusCode": "200", @@ -301745,8 +301746,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Gets a milestone using the given milestone number.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -320595,13 +320595,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", @@ -344212,16 +344212,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -344480,16 +344470,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -344711,16 +344691,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -344947,16 +344917,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -345145,16 +345105,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -345804,13 +345754,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", @@ -350285,6 +350235,7 @@ } ], "previews": [], + "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -350298,8 +350249,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

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

Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.

\n

Only GitHub Apps can use this endpoint.

", "statusCodes": [ { "httpStatusCode": "202", @@ -356467,8 +356418,7 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ], - "descriptionHTML": "

Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.

\n

Only GitHub Apps can use this endpoint.

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

Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"

\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 write:org scope to use this endpoint.

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

No Content

" } - ], - "descriptionHTML": "

Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"

\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 write:org scope to use this endpoint.

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

Lists packages owned by the authenticated user within the user's namespace.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -374438,8 +374389,7 @@ "httpStatusCode": "400", "description": "

The value of per_page multiplied by page cannot be greater than 10000.

" } - ], - "descriptionHTML": "

Lists packages owned by the authenticated user within the user's namespace.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

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

Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.

", "statusCodes": [ { "httpStatusCode": "204", @@ -411037,8 +410988,7 @@ "httpStatusCode": "404", "description": "

Not Found if pull request has not been merged

" } - ], - "descriptionHTML": "

Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.

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

List the reactions to a pull request review comment.

", "statusCodes": [ { "httpStatusCode": "200", @@ -435626,8 +435577,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

List the reactions to a pull request review comment.

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

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

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

No Content

" } - ], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

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

OK

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

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

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

Created

" } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

", "previews": [ "

Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json\n
" ] @@ -487788,6 +487738,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -487801,8 +487752,7 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ], - "descriptionHTML": "

Lists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"

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

Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -497725,8 +497676,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for a repository.\"

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -523957,6 +523907,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", @@ -523970,8 +523921,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "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": "http(s)://HOSTNAME/api/v3", @@ -533750,13 +533700,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 discussions endpoint.

\n
\n

List all discussions on a team's page.

\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 discussions endpoint.

\n
\n

List all discussions on a team's page.

\n

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

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

Creates a connection between a team and an external group. Only one external group can be linked to a team.

\n

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

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -537003,6 +536953,7 @@ } ], "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 team members endpoint.

\n
\n

Team members will include the members of child teams.

", "statusCodes": [ { "httpStatusCode": "200", @@ -537012,8 +536963,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "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 team members endpoint.

\n
\n

Team members will include the members of child teams.

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

The \"Get team member\" endpoint (described below) is closing down.

\n

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

\n

To list members in a team, the team must be visible to the authenticated user.

", "statusCodes": [ { "httpStatusCode": "204", @@ -537080,8 +537031,7 @@ "httpStatusCode": "404", "description": "

if user is not a member

" } - ], - "descriptionHTML": "

The \"Get team member\" endpoint (described below) is closing down.

\n

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

\n

To list members in a team, the team must be visible to the authenticated user.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index cb708d1062ae..8a28e2fdad4a 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -349567,16 +349567,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -349835,16 +349825,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -350066,16 +350046,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -350302,16 +350272,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -350500,16 +350460,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index 42a12088cb40..9df8e2713678 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -350950,16 +350950,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -351218,16 +351208,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -351449,16 +351429,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -351685,16 +351655,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", @@ -351883,16 +351843,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "admin" - } - ] - }, "codeExamples": [ { "key": "default", diff --git a/src/rest/pages/category.tsx b/src/rest/pages/category.tsx index e14eaf70fcd2..0a7f1d5701d2 100644 --- a/src/rest/pages/category.tsx +++ b/src/rest/pages/category.tsx @@ -62,7 +62,7 @@ export default function Category({ export const getServerSideProps: GetServerSideProps = async (context) => { const { default: getRest, getRestMiniTocItems } = await import('@/rest/lib/index') const nonEnterpriseDefaultVersionModule = await import( - 'src/versions/lib/non-enterprise-default-version.js' + '@/versions/lib/non-enterprise-default-version' ) const nonEnterpriseDefaultVersion = nonEnterpriseDefaultVersionModule.default as string diff --git a/src/tests/helpers/script-data.js b/src/tests/helpers/script-data.js deleted file mode 100644 index b7bc3f0070ad..000000000000 --- a/src/tests/helpers/script-data.js +++ /dev/null @@ -1,13 +0,0 @@ -const NEXT_DATA_QUERY = 'script#__NEXT_DATA__' -const PRIMER_DATA_QUERY = 'script#__PRIMER_DATA__' - -function getScriptData($, key) { - const data = $(key) - if (!data.length === 1) { - throw new Error(`Not exactly 1 element match for '${key}'. Found ${data.length}`) - } - return JSON.parse(data.get()[0].children[0].data) -} - -export const getNextData = ($) => getScriptData($, NEXT_DATA_QUERY) -export const getPrimerData = ($) => getScriptData($, PRIMER_DATA_QUERY) diff --git a/src/tests/helpers/script-data.ts b/src/tests/helpers/script-data.ts new file mode 100644 index 000000000000..ec028b852382 --- /dev/null +++ b/src/tests/helpers/script-data.ts @@ -0,0 +1,15 @@ +const NEXT_DATA_QUERY = 'script#__NEXT_DATA__' +const PRIMER_DATA_QUERY = 'script#__PRIMER_DATA__' + +// Using any type for $ parameter as it represents a jQuery-like selector (cheerio) +function getScriptData($: any, key: string): any { + const data = $(key) + if (data.length !== 1) { + throw new Error(`Not exactly 1 element match for '${key}'. Found ${data.length}`) + } + return JSON.parse(data.get()[0].children[0].data) +} + +// Using any types for cheerio/jQuery-like objects and parsed JSON data +export const getNextData = ($: any): any => getScriptData($, NEXT_DATA_QUERY) +export const getPrimerData = ($: any): any => getScriptData($, PRIMER_DATA_QUERY) diff --git a/src/types/markdownlint-rules.d.ts b/src/types/markdownlint-rules.d.ts new file mode 100644 index 000000000000..7e7204208e76 --- /dev/null +++ b/src/types/markdownlint-rules.d.ts @@ -0,0 +1,7 @@ +// Simple type declaration for markdownlint external library +// Using any types to avoid complex typing for external dependencies + +declare module '../../../../node_modules/markdownlint/lib/rules' { + const rules: any[] + export = rules +} diff --git a/src/versions/lib/non-enterprise-default-version.js b/src/versions/lib/non-enterprise-default-version.ts similarity index 94% rename from src/versions/lib/non-enterprise-default-version.js rename to src/versions/lib/non-enterprise-default-version.ts index 5a438f0bf61d..23edb112520c 100644 --- a/src/versions/lib/non-enterprise-default-version.js +++ b/src/versions/lib/non-enterprise-default-version.ts @@ -1,6 +1,7 @@ import { allVersions } from '@/versions/lib/all-versions' + const nonEnterpriseDefaultVersion = Object.values(allVersions).find( (version) => version.nonEnterpriseDefault, -).version +)!.version export default nonEnterpriseDefaultVersion diff --git a/src/versions/lib/remove-fpt-from-path.js b/src/versions/lib/remove-fpt-from-path.ts similarity index 86% rename from src/versions/lib/remove-fpt-from-path.js rename to src/versions/lib/remove-fpt-from-path.ts index d93a9a29a1d7..32ee9ded6ff7 100644 --- a/src/versions/lib/remove-fpt-from-path.js +++ b/src/versions/lib/remove-fpt-from-path.ts @@ -4,6 +4,6 @@ import nonEnterpriseDefaultVersion from './non-enterprise-default-version' // This is a convenience function to remove free-pro-team@latest from all // **user-facing** aspects of the site (particularly URLs) while continuing to support // free-pro-team@latest as a version both in the codebase and in content/data files. -export default function removeFPTFromPath(path) { +export default function removeFPTFromPath(path: string): string { return slash(path.replace(`/${nonEnterpriseDefaultVersion}`, '')) }