diff --git a/assets/images/help/copilot/custom-instruction-ref-visual-studio.png b/assets/images/help/copilot/custom-instruction-ref-visual-studio.png new file mode 100644 index 000000000000..2c4b1c2c9662 Binary files /dev/null and b/assets/images/help/copilot/custom-instruction-ref-visual-studio.png differ diff --git a/assets/images/help/copilot/custom-instructions-ref-in-github.png b/assets/images/help/copilot/custom-instructions-ref-in-github.png new file mode 100644 index 000000000000..60af86af6a43 Binary files /dev/null and b/assets/images/help/copilot/custom-instructions-ref-in-github.png differ diff --git a/assets/images/help/copilot/custom-instructions-vscode.png b/assets/images/help/copilot/custom-instructions-vscode.png index 8a938f83134d..6e0d1954a694 100644 Binary files a/assets/images/help/copilot/custom-instructions-vscode.png and b/assets/images/help/copilot/custom-instructions-vscode.png differ diff --git a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md index 950009168246..0d62a9171d20 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/about-troubleshooting-workflows.md @@ -12,6 +12,16 @@ shortTitle: About troubleshooting ## Troubleshooting your workflows +There are several ways you can troubleshoot failed workflow runs. + +{% ifversion copilot %} + +### Using {% data variables.product.prodname_copilot %} + +If a workflow run fails, you can open a chat with {% data variables.product.prodname_copilot %} for assistance resolving the error. See [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/using-copilot-to-troubleshoot-workflows). + +{% endif %} + ### Using workflow run logs Each workflow run generates activity logs that you can view, search, and download. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs). @@ -31,8 +41,6 @@ If you attempt to cancel a workflow and the cancellation doesn't succeed, make s To analyze the inefficiencies and reliability of your workflows using metrics, see [AUTOTITLE](/actions/administering-github-actions/viewing-github-actions-metrics). {% endif %} -## Monitoring self-hosted runners - ## Troubleshooting self-hosted runners If you use self-hosted runners, you can view their activity and diagnose common issues. diff --git a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md index 749f5a8f7278..c23957ba278d 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/index.md @@ -8,6 +8,7 @@ versions: ghec: '*' children: - /about-troubleshooting-workflows + - /using-copilot-to-troubleshoot-workflows - /enabling-debug-logging - /working-with-support-for-github-actions --- diff --git a/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/using-copilot-to-troubleshoot-workflows.md b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/using-copilot-to-troubleshoot-workflows.md new file mode 100644 index 000000000000..09b606cea244 --- /dev/null +++ b/content/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/using-copilot-to-troubleshoot-workflows.md @@ -0,0 +1,19 @@ +--- +title: Using Copilot to troubleshoot workflows +intro: 'You can use {% data variables.product.prodname_copilot %} to help resolve failed workflow runs.' +versions: + feature: copilot +shortTitle: Use Copilot +permissions: This feature is available for users on all {% data variables.product.prodname_copilot %} subscription tiers. +--- + +If a workflow run fails, you can open a chat with {% data variables.product.prodname_copilot %} for assistance resolving the error. + +To open a chat about a failed workflow run, you can either: + +* Next to the failed check in the merge box, click **{% octicon "kebab-horizontal" aria-hidden="true" %}**, then click **{% octicon "copilot" aria-hidden="true" %} Explain error**. +* In the merge box, click on the failed check. At the top of the workflow run summary page, click **{% octicon "copilot" aria-hidden="true" %} Explain error**. + +This opens a chat window with {% data variables.product.prodname_copilot %}, where it will provide instructions to resolve the issue. + +>[!NOTE] If you are on a {% data variables.product.prodname_copilot_free %} subscription, this will count towards your monthly chat message limit. diff --git a/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md b/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md index d29efc191bc9..696d7629dd35 100644 --- a/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md +++ b/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md @@ -207,11 +207,14 @@ If your appliance averages more than 70% CPU utilization, {% data variables.prod As part of upgrading GitHub Enterprise Server to version 3.13 or later, the Elasticsearch service will be upgraded. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/preparing-for-the-elasticsearch-upgrade). {% endif %} -{% ifversion ghes > 3.14 and ghes < 3.17 %} +{% ifversion ghes > 3.14 %} ## Required root disk size increased to 400GB -New installations of 3.15 or later, or upgrades to 3.15 or later require root disk size of at least 400GB. This capacity is an enforced requirement for the system to boot successfully. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity). +> [!Note] +> The previous root disk size requirement of 400GB for versions 3.15.2 and later has been removed. This requirement was based on analysis of support bundles and support tickets. Some factors, such as logs, put excessive pressure on the root disk which caused appliance issues. After receiving feedback that it's challenging for many customers to procure new hardware, we rolled back the requirement in favor of a gradual approach. We still recommend customers, especially those using standalone or standalone high-availability topologies, upgrade the root disk to 400GB. When you are able to upgrade the root disk to 400GB, see the following instructions. + +To customers using standalone or HA topologies, it is recommended that new installations of 3.15 or later, or upgrades to 3.15 to use root disk size of at least 400GB. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity). {% endif %} diff --git a/content/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot.md b/content/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot.md index ceac2eff7237..43399d5f944a 100644 --- a/content/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot.md +++ b/content/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot.md @@ -8,20 +8,57 @@ topics: - Copilot --- -> [!NOTE] -> * This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change. -> * Custom instructions are currently only supported for {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %} and {% data variables.product.prodname_vs %}. -## About custom instructions for {% data variables.product.prodname_copilot %} +{% webui %} + +{% data reusables.copilot.custom-instructions-note %} +> +> This version of this article is for using custom instructions on the {% data variables.product.github %} website. Click the tabs above for information on using custom instructions in other environments. + +{% endwebui %} + +{% vscode %} + +{% data reusables.copilot.custom-instructions-note %} +> +> This version of this article is for using custom instructions in {% data variables.product.prodname_vscode_shortname %}. Click the tabs above for instructions on using custom instructions in other environments. + +{% endvscode %} + +{% visualstudio %} + +{% data reusables.copilot.custom-instructions-note %} +> +> This version of this article is for using custom instructions in {% data variables.product.prodname_vs %}. Click the tabs above for instructions on using custom instructions in other environments. + +{% endvisualstudio %} + +## About custom instructions for {% data variables.product.prodname_copilot_chat %} {% data variables.product.prodname_copilot %} can provide chat responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create a file that automatically adds this information for you. The additional information is not displayed in the chat, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. ## Prerequisites * A custom instructions file (see the instructions below). -* The **Use Instruction Files** ({% data variables.product.prodname_vscode_shortname %}) or **Enable custom instructions** ({% data variables.product.prodname_vs %}) option enabled in your settings. See [Enabling or disabling custom instructions](#enabling-or-disabling-custom-instructions) later in this article. - > [!NOTE] The setting is enabled by default in {% data variables.product.prodname_vscode_shortname %} and disabled by default in {% data variables.product.prodname_vs %}. +{% webui %} + +* Your personal choice of whether to use custom instructions must be set to enabled. This is enabled by default. See [Enabling or disabling custom instructions](#enabling-or-disabling-custom-instructions) later in this article. +* During the {% data variables.release-phases.public_preview %}, if you have a {% data variables.product.prodname_copilot_business_short %} {% ifversion ghec %}or {% data variables.product.prodname_copilot_enterprise_short %}{% endif %} subscription, then the organization {% ifversion ghec %}or enterprise{% endif %} from which you receive your subscription must have the **Opt in to preview features** setting enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization){% ifversion ghec %} and [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom){% endif %}. + +{% endwebui %} + +{% vscode %} + +* The **Use Instruction Files** option must be enabled in your settings. This is enabled by default. See [Enabling or disabling custom instructions](#enabling-or-disabling-custom-instructions) later in this article. + +{% endvscode %} + +{% visualstudio %} + +* The **Enable custom instructions** option must be enabled in your settings. This is disabled by default. See [Enabling or disabling custom instructions](#enabling-or-disabling-custom-instructions) later in this article. + +{% endvisualstudio %} ## Creating a custom instructions file @@ -69,23 +106,58 @@ Answer all questions in less than 1000 characters, and words of no more than 12 ## Custom instructions in use -The instructions in the `.github/copilot-instructions.md` file are available for use by {% data variables.product.prodname_copilot_chat_short %} as soon as you save the file. The complete set of instructions will be automatically attached to requests that you submit in either the {% data variables.product.prodname_copilot_chat_short %} view, or in inline chat, in {% data variables.product.prodname_vscode_shortname %} and {% data variables.product.prodname_vs %}. +{% webui %} + +The instructions in the `.github/copilot-instructions.md` file are available for use by {% data variables.product.prodname_copilot_chat_short %} as soon as you save the file. The complete set of instructions will be automatically added to chat prompts that relate to the repository containing the instructions file. -Custom instructions are not visible in the Chat view or inline chat, but you can verify that they are being used by {% data variables.product.prodname_copilot_short %} by looking at the References list of a response. If custom instructions were added to the prompt that was sent to the model, the `.github/copilot-instructions.md` file is listed as a reference. You can click the reference to open the file. +In immersive mode (the [https://github.com/copilot](https://github.com/copilot) page), you can start a conversation that uses custom instructions by adding, as an attachment, the repository that contains the instructions file. -![Screenshot of the {% data variables.product.prodname_copilot_chat_short %} view in {% data variables.product.prodname_vscode_shortname %} with a reference for the copilot-instructions.md file.](/assets/images/help/copilot/custom-instructions-vscode.png) +Custom instructions are not visible in {% data variables.product.prodname_copilot_chat_short %}, but you can verify that they are being used by {% data variables.product.prodname_copilot_short %} by expanding the list of references at the top of a chat response in the Chat panel. If custom instructions were added to the prompt that was sent to the model, the `.github/copilot-instructions.md` file is listed as a reference. + +![Screenshot of an expanded References list, showing the 'copilot-instructions.md' file highlighted with a dark organge outline.](/assets/images/help/copilot/custom-instructions-ref-in-github.png) + +You can click the reference to open the file. + +{% endwebui %} + +{% vscode %} + +{% data reusables.copilot.custom-instructions-reference %} + +![Screenshot of an expanded References list, showing the 'copilot-instructions.md' file highlighted with a dark organge outline.](/assets/images/help/copilot/custom-instructions-vscode.png) + +{% endvscode %} + +{% visualstudio %} + +{% data reusables.copilot.custom-instructions-reference %} + +![Screenshot of the References popup, showing the 'copilot-instructions.md' file highlighted with a dark organge outline.](/assets/images/help/copilot/custom-instruction-ref-visual-studio.png) + +{% endvisualstudio %} ## Enabling or disabling custom instructions -You can choose whether or not to have custom instructions added to your chat questions. To do this, select or clear the option in the settings for the {% data variables.product.prodname_copilot_short %} extension. +You can choose whether or not to have custom instructions added to your chat questions. + +{% webui %} + +1. Click the {% octicon "kebab-horizontal" aria-label="Conversation options" %} button at the top of the Chat panel, or the top right of the immersive page. +1. Click **Disable custom instructions** or **Enable custom instructions**. -### In {% data variables.product.prodname_vscode_shortname %} +Your choice persists until you change it. + +{% endwebui %} + +{% vscode %} 1. Open the Setting editor by using the keyboard shortcut Command+, (Mac) / Ctrl+, (Linux/Windows). 1. Type `instruction file` in the search box. 1. Select or clear the checkbox under **Code Generation: Use Instruction Files**. -### In {% data variables.product.prodname_vs %} +{% endvscode %} + +{% visualstudio %} 1. In the {% data variables.product.prodname_vs %} menu bar, under **Tools**, click **Options**. @@ -93,3 +165,5 @@ You can choose whether or not to have custom instructions added to your chat que 1. In the "Options" dialog, type `custom instructions` in the search box. 1. Select or clear the checkbox for **(Preview) Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests**. + +{% endvisualstudio %} diff --git a/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/content/packages/learn-github-packages/about-permissions-for-github-packages.md index d99086095eed..dc4462d62ace 100644 --- a/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -65,7 +65,7 @@ To use or manage a package hosted by a package registry, you must use a {% data For example: * To download and install packages from a repository, your {% data variables.product.pat_v1 %} must have the `read:packages` scope, and your user account must have read permission. -* To delete a package on {% data variables.product.product_name %}, your {% data variables.product.pat_v1 %} must at least have the `delete:packages` and `read:packages` scope. For more information, see [AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package). +* To delete a package, your {% data variables.product.pat_v1 %} must at least have the `delete:packages` and `read:packages` scope. For more information, see [AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package). | Scope | Description | Required permission | | --- | --- | --- | diff --git a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index 032ed0fdb250..6ad1c05a77bb 100644 --- a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -87,7 +87,7 @@ To find all of the private packages you have published to {% data variables.prod For more information about the `deletePackageVersion` mutation, see [AUTOTITLE](/graphql/reference/mutations#deletepackageversion). -You cannot directly delete an entire package using GraphQL, but if you delete every version of a package, the package will no longer show on {% data variables.product.product_name %}. +You cannot directly delete an entire package using GraphQL, but if you delete every version of a package, the package will no longer show on {% data variables.product.github %}. {% ifversion fpt or ghec %} diff --git a/content/packages/learn-github-packages/introduction-to-github-packages.md b/content/packages/learn-github-packages/introduction-to-github-packages.md index 40e8068e408e..f217821a0bc9 100644 --- a/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -21,17 +21,17 @@ shortTitle: Introduction ## About {% data variables.product.prodname_registry %} -{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% ifversion fpt or ghec %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.product_name %}. +{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% ifversion fpt or ghec %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.github %}. -You can integrate {% data variables.product.prodname_registry %} with {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions. +You can integrate {% data variables.product.prodname_registry %} with {% data variables.product.github %}'s APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions. {% data variables.product.prodname_registry %} offers different package registries for commonly used package managers, such as npm, RubyGems, Apache Maven, Gradle, Docker, and NuGet. {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}'s {% data variables.product.prodname_container_registry %} is optimized for containers and supports Docker and OCI images.{% endif %} For more information on the different package registries that {% data variables.product.prodname_registry %} supports, see [AUTOTITLE](/packages/working-with-a-github-packages-registry). -You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/packages/learn-github-packages/viewing-packages). +You can view a package's README, as well as metadata such as licensing, download statistics, version history, and more on {% data variables.product.github %}. For more information, see [AUTOTITLE](/packages/learn-github-packages/viewing-packages). {% ifversion ghes %} -For more information about the configuration of {% data variables.product.prodname_registry %} on {% data variables.product.product_name %}, see [AUTOTITLE](/admin/packages/getting-started-with-github-packages-for-your-enterprise). +For more information about the configuration of {% data variables.product.prodname_registry %} on {% data variables.product.prodname_ghe_server %}, see [AUTOTITLE](/admin/packages/getting-started-with-github-packages-for-your-enterprise). {% endif %} diff --git a/content/packages/learn-github-packages/publishing-a-package.md b/content/packages/learn-github-packages/publishing-a-package.md index 86dec98f5f4a..fbf1f5006c6e 100644 --- a/content/packages/learn-github-packages/publishing-a-package.md +++ b/content/packages/learn-github-packages/publishing-a-package.md @@ -16,7 +16,7 @@ versions: ## About published packages -You can help people understand and use your package by providing a description and other details like installation and usage instructions on the package page. {% data variables.product.product_name %} provides metadata for each version, such as the publication date, download activity, and recent versions. For an example package page, see [@Codertocat/hello-world-npm](https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.1). +You can help people understand and use your package by providing a description and other details like installation and usage instructions on the package page. {% data variables.product.github %} provides metadata for each version, such as the publication date, download activity, and recent versions. For an example package page, see [@Codertocat/hello-world-npm](https://github.com/Codertocat/hello-world-npm/packages/10696?version=1.0.1). {% data reusables.package_registry.public-or-private-packages %} A repository can be connected to more than one package. To prevent confusion, make sure the README and description clearly provide information about each package. diff --git a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index 33dd60e67e11..3c893be7ddb2 100644 --- a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -32,7 +32,7 @@ Some {% data variables.product.prodname_registry %} registries support granular Some {% data variables.product.prodname_registry %} registries only support repository-scoped permissions, and do not support granular permissions. For a list of these registries, see [AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages). -If you want your workflow to access a {% data variables.product.prodname_registry %} registry that does not support granular permissions, then we recommend using the `GITHUB_TOKEN` that {% data variables.product.product_name %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %}. You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. For forks, the `GITHUB_TOKEN` is granted read access for the parent repository. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). +If you want your workflow to access a {% data variables.product.prodname_registry %} registry that does not support granular permissions, then we recommend using the `GITHUB_TOKEN` that {% data variables.product.github %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %}. You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. For forks, the `GITHUB_TOKEN` is granted read access for the parent repository. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} context. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). diff --git a/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md b/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md index ea486774569d..e4a3f43f6307 100644 --- a/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md +++ b/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md @@ -30,7 +30,7 @@ topics: {% ifversion ghes %} > [!NOTE] -> {% data reusables.package_registry.container-registry-ghes-migration-availability %} For more information about finding the version of {% data variables.product.product_name %} that you use, see [AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server). +> {% data reusables.package_registry.container-registry-ghes-migration-availability %} For more information about finding the version of {% data variables.product.prodname_ghe_server %} that you use, see [AUTOTITLE](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server). {% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 3697cc663a17..e6e9bb1cc348 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -27,7 +27,7 @@ shortTitle: Container registry {% ifversion ghes %} -To use the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_name %}, your site administrator must first configure {% data variables.product.prodname_registry %} for your instance **and** enable subdomain isolation. For more information, see [AUTOTITLE](/admin/packages/getting-started-with-github-packages-for-your-enterprise) and [AUTOTITLE](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation). +To use the {% data variables.product.prodname_container_registry %} on {% data variables.product.prodname_ghe_server %}, your site administrator must first configure {% data variables.product.prodname_registry %} for your instance **and** enable subdomain isolation. For more information, see [AUTOTITLE](/admin/packages/getting-started-with-github-packages-for-your-enterprise) and [AUTOTITLE](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation). {% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md index 5e33cd696f25..c088c710a00d 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -85,7 +85,7 @@ cat ~/TOKEN.txt | docker login HOSTNAME -u USERNAME --password-stdin {% endif %} -To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% ifversion ghes %}, `HOSTNAME` with the URL for {% data variables.location.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your {% data variables.product.pat_generic %} for {% data variables.product.product_name %}. +To use this example login command, replace `USERNAME` with your {% data variables.product.github %} username{% ifversion ghes %}, `HOSTNAME` with the URL for {% data variables.location.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your {% data variables.product.pat_generic %} for {% data variables.product.github %}. For more information, see [Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin). diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md index 78dfa19e919a..aa9d7e4fb4f9 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages.md @@ -55,7 +55,7 @@ Subdomains are configured with a `CNAME` record through your DNS provider. For m A `www` subdomain is the most commonly used type of subdomain. For example, `www.example.com` includes a `www` subdomain. -`www` subdomains are the most stable type of custom domain because `www` subdomains are not affected by changes to the IP addresses of {% data variables.product.product_name %}'s servers. +`www` subdomains are the most stable type of custom domain because `www` subdomains are not affected by changes to the IP addresses of {% data variables.product.github %}'s servers. ### Custom subdomains diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index 889b803b6b89..dbec0d3001b8 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -26,7 +26,7 @@ People with admin permissions for a repository can configure a custom domain for {% data reusables.pages.custom-domain-warning %} -Make sure you add your custom domain to your {% data variables.product.prodname_pages %} site before configuring your custom domain with your DNS provider. Configuring your custom domain with your DNS provider without adding your custom domain to {% data variables.product.product_name %} could result in someone else being able to host a site on one of your subdomains. +Make sure you add your custom domain to your {% data variables.product.prodname_pages %} site before configuring your custom domain with your DNS provider. Configuring your custom domain with your DNS provider without adding your custom domain to {% data variables.product.github %} could result in someone else being able to host a site on one of your subdomains. {% windows %} @@ -139,7 +139,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl ## DNS records for your custom domain -If you are familiar with the process of configuring your domain for a {% data variables.product.prodname_pages %} site, you can use the table below to find the DNS values for your specific scenario and the DNS record types that your DNS provider supports. For more information, including how to configure your {% data variables.product.prodname_pages %} site on {% data variables.product.product_name %} and how to verify the configuration using the `dig` command, refer to the sections above. +If you are familiar with the process of configuring your domain for a {% data variables.product.prodname_pages %} site, you can use the table below to find the DNS values for your specific scenario and the DNS record types that your DNS provider supports. For more information, including how to configure your {% data variables.product.prodname_pages %} site on {% data variables.product.github %} and how to verify the configuration using the `dig` command, refer to the sections above. To configure an apex domain, you only need to pick a single DNS record type from the table below. To configure an apex domain and `www` subdomain (for example, `example.com` and `www.example.com`), configure the apex domain and then the subdomain. For more information, see [Configuring an apex domain and the `www` subdomain variant](#configuring-an-apex-domain-and-the-www-subdomain-variant). diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md index 63cf74a6d414..566c69dd3a2d 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages.md @@ -22,7 +22,7 @@ If you are publishing from a custom {% data variables.product.prodname_actions % If you are publishing from a branch, custom domains are stored in a CNAME file in the root of your publishing source. You can add or update this file through your repository settings or manually. For more information, see [AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site). -For your site to render at the correct domain, make sure your CNAME file still exists in the repository. For example, many static site generators force push to your repository, which can overwrite the CNAME file that was added to your repository when you configured your custom domain. If you build your site locally and push generated files to {% data variables.product.product_name %}, make sure to pull the commit that added the CNAME file to your local repository first, so the file will be included in the build. +For your site to render at the correct domain, make sure your CNAME file still exists in the repository. For example, many static site generators force push to your repository, which can overwrite the CNAME file that was added to your repository when you configured your custom domain. If you build your site locally and push generated files to {% data variables.product.github %}, make sure to pull the commit that added the CNAME file to your local repository first, so the file will be included in the build. Then, make sure the CNAME file is formatted correctly. @@ -65,7 +65,7 @@ If you're using Certification Authority Authorization (CAA) records, at least on ## URL formatting on Linux -If the URL for your site contains a username or organization name that begins or ends with a dash, or contains consecutive dashes, people browsing with Linux will receive a server error when they attempt to visit your site. To fix this, change your {% data variables.product.product_name %} username to remove non-alphanumeric characters. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username). +If the URL for your site contains a username or organization name that begins or ends with a dash, or contains consecutive dashes, people browsing with Linux will receive a server error when they attempt to visit your site. To fix this, change your {% data variables.product.github %} username to remove non-alphanumeric characters. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username). ## Browser cache diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index 124da7cc4d53..9149f97cc9d3 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -22,7 +22,7 @@ topics: ## About {% data variables.product.prodname_pages %} -{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on {% data variables.product.product_name %}, optionally runs the files through a build process, and publishes a website. You can see examples of {% data variables.product.prodname_pages %} sites in the [{% data variables.product.prodname_pages %} examples collection](https://github.com/collections/github-pages-examples). +{% data variables.product.prodname_pages %} is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on {% data variables.product.github %}, optionally runs the files through a build process, and publishes a website. You can see examples of {% data variables.product.prodname_pages %} sites in the [{% data variables.product.prodname_pages %} examples collection](https://github.com/collections/github-pages-examples). {% ifversion fpt or ghec %} You can host your site on {% data variables.product.prodname_dotcom %}'s `github.io` domain or your own custom domain. For more information, see [AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site). @@ -38,7 +38,7 @@ Organization owners can disable the publication of {% data variables.product.pro ## Types of {% data variables.product.prodname_pages %} sites -There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.product_name %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific account on {% data variables.location.product_location %}. +There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.github %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific account on {% data variables.location.product_location %}. To publish a user site, you must create a repository owned by your personal account that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% endif %} @@ -52,7 +52,7 @@ If you publish your site privately, the URL for your site will be different. For For more information about how custom domains affect the URL for your site, see [AUTOTITLE](/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages#using-a-custom-domain-across-multiple-repositories). {% endif %} -You can only create one user or organization site for each account on {% data variables.product.product_name %}. Project sites, whether owned by an organization or a personal account, are unlimited. +You can only create one user or organization site for each account on {% data variables.product.github %}. Project sites, whether owned by an organization or a personal account, are unlimited. {% ifversion ghes %} The URL where your site is available depends on whether subdomain isolation is enabled for {% data variables.location.product_location %}. @@ -92,7 +92,7 @@ For more information about {% data variables.product.prodname_emus %}, see [AUTO {% data variables.product.prodname_pages %} publishes any static files that you push to your repository. You can create your own static files or use a static site generator to build your site for you. You can also customize your own build process locally or on another server. -If you use a custom build process or a static site generator other than Jekyll, you can write a {% data variables.product.prodname_actions %} to build and publish your site. {% data variables.product.product_name %} provides workflow templates for several static site generators. For more information, see [AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). +If you use a custom build process or a static site generator other than Jekyll, you can write a {% data variables.product.prodname_actions %} to build and publish your site. {% data variables.product.github %} provides workflow templates for several static site generators. For more information, see [AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). If you publish your site from a source branch, {% data variables.product.prodname_pages %} will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, we recommend that you write a {% data variables.product.prodname_actions %} to build and publish your site instead. Otherwise, disable the Jekyll build process by creating an empty file called `.nojekyll` in the root of your publishing source, then follow your static site generator's instructions to build your site locally. diff --git a/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index 8fe65f883e3c..8f0daa08a502 100644 --- a/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -59,7 +59,7 @@ To configure your site to publish with {% data variables.product.prodname_action {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 1. Under "Build and deployment", under "Source", select **{% data variables.product.prodname_actions %}**. -1. {% data variables.product.product_name %} will suggest several workflow templates. If you already have a workflow to publish your site, you can skip this step. Otherwise, choose one of the options to create a {% data variables.product.prodname_actions %} workflow. For more information about creating your custom workflow, see [Creating a custom {% data variables.product.prodname_actions %} workflow to publish your site](#creating-a-custom-github-actions-workflow-to-publish-your-site). +1. {% data variables.product.github %} will suggest several workflow templates. If you already have a workflow to publish your site, you can skip this step. Otherwise, choose one of the options to create a {% data variables.product.prodname_actions %} workflow. For more information about creating your custom workflow, see [Creating a custom {% data variables.product.prodname_actions %} workflow to publish your site](#creating-a-custom-github-actions-workflow-to-publish-your-site). {% data variables.product.prodname_pages %} does not associate a specific workflow to the {% data variables.product.prodname_pages %} settings. However, the {% data variables.product.prodname_pages %} settings will link to the workflow run that most recently deployed your site. @@ -67,7 +67,7 @@ To configure your site to publish with {% data variables.product.prodname_action For more information about {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions). -When you configure your site to publish with {% data variables.product.prodname_actions %}, {% data variables.product.product_name %} will suggest workflow templates for common publishing scenarios. The general flow of a workflow is to: +When you configure your site to publish with {% data variables.product.prodname_actions %}, {% data variables.product.github %} will suggest workflow templates for common publishing scenarios. The general flow of a workflow is to: 1. Trigger whenever there is a push to the default branch of the repository or whenever the workflow is run manually from the Actions tab. 1. Use the [`actions/checkout`](https://github.com/actions/checkout) action to check out the repository contents. diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index 40a407842b71..c98be324fba8 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -52,7 +52,7 @@ Assets are commonly found in the following locations: * Images are often found in the `` section. > [!TIP] -> If you can't find your assets in your site's source files, try searching your site's source files for `http` in your text editor or on {% data variables.product.product_name %}. +> If you can't find your assets in your site's source files, try searching your site's source files for `http` in your text editor or on {% data variables.product.github %}. ### Examples of assets referenced in an HTML file diff --git a/content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md b/content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md index ed047f7a52a8..97464a26f988 100644 --- a/content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md +++ b/content/pages/getting-started-with-github-pages/troubleshooting-404-errors-for-github-pages-sites.md @@ -39,7 +39,7 @@ If your {% data variables.product.prodname_pages %} site is private and you see {% data variables.product.prodname_pages %} will look for an `index.html` file as the entry file for your site. -* Make sure you have an `index.html` file in the repository for your site on {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site). +* Make sure you have an `index.html` file in the repository for your site on {% data variables.product.github %}. For more information, see [AUTOTITLE](/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site). * The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the `/docs` directory on the `main` branch, your entry file must be located in the `/docs` directory on a branch called `main`. If your publishing source is a branch and directory, the entry file must be at the top level of the source directory on the source branch. For example, if your publishing source is the `/docs` directory on the `main` branch, your entry file must be located in the `/docs` directory on a branch called `main`. diff --git a/content/pages/quickstart.md b/content/pages/quickstart.md index 7b8fcf0f975d..8868bc5a22d0 100644 --- a/content/pages/quickstart.md +++ b/content/pages/quickstart.md @@ -15,7 +15,7 @@ product: '{% data reusables.gated-features.pages %}' ## Introduction -{% data variables.product.prodname_pages %} are public webpages hosted and published through {% data variables.product.product_name %}. The quickest way to get up and running is by using the Jekyll Theme Chooser to load a pre-made theme. You can then modify your {% data variables.product.prodname_pages %}' content and style. +{% data variables.product.prodname_pages %} are public webpages hosted and published through {% data variables.product.github %}. The quickest way to get up and running is by using the Jekyll Theme Chooser to load a pre-made theme. You can then modify your {% data variables.product.prodname_pages %}' content and style. This guide will lead you through creating a user site at `username.github.io`. @@ -24,8 +24,8 @@ This guide will lead you through creating a user site at `username.github.io`. {% data reusables.repositories.create_new %} 1. Enter `username.github.io` as the repository name. Replace `username` with your {% data variables.product.prodname_dotcom %} username. For example, if your username is `octocat`, the repository name should be `octocat.github.io`. ![Screenshot of {% data variables.product.prodname_pages %} settings in a repository. The repository name field contains the text "octocat.github.io" and is outlined in dark orange.](/assets/images/help/pages/create-repository-name-pages.png) -{% data reusables.repositories.choose-repo-visibility %} -{% data reusables.repositories.initialize-with-readme %} +{% data reusables.repositories.choose-repo-visibility %} +{% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} @@ -33,7 +33,7 @@ This guide will lead you through creating a user site at `username.github.io`. 1. Under "Build and deployment", under "Branch", use the branch dropdown menu and select a publishing source. ![Screenshot of Pages settings in a {% data variables.product.prodname_dotcom %} repository. A menu to select a branch for a publishing source, labeled "None," is outlined in dark orange.](/assets/images/help/pages/publishing-source-drop-down.png) 1. Optionally, open the `README.md` file of your repository. The `README.md` file is where you will write the content for your site. You can edit the file or keep the default content for now. -1. Visit `username.github.io` to view your new website. Note that it can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. +1. Visit `username.github.io` to view your new website. Note that it can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.github %}. ## Changing the title and description diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index da923660e358..327341b8d098 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -102,11 +102,11 @@ For a list of supported plugins, see [Dependency versions](https://pages.github. > [!TIP] > You can make sure you're using the latest version of all plugins by keeping the {% data variables.product.prodname_pages %} gem updated. For more information, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll#updating-the-github-pages-gem) and [Dependency versions](https://pages.github.com/versions/) on the {% data variables.product.prodname_pages %} site. -{% data variables.product.prodname_pages %} cannot build sites using unsupported plugins. If you want to use unsupported plugins, generate your site locally and then push your site's static files to {% data variables.product.product_name %}. +{% data variables.product.prodname_pages %} cannot build sites using unsupported plugins. If you want to use unsupported plugins, generate your site locally and then push your site's static files to {% data variables.product.github %}. ## Syntax highlighting -To make your site easier to read, code snippets are highlighted on {% data variables.product.prodname_pages %} sites the same way they're highlighted on {% data variables.product.product_name %}. For more information about syntax highlighting on {% data variables.product.product_name %}, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). +To make your site easier to read, code snippets are highlighted on {% data variables.product.prodname_pages %} sites the same way they're highlighted on {% data variables.product.github %}. For more information about syntax highlighting, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the [Rouge](https://github.com/rouge-ruby/rouge) highlighter (which is compatible with [Pygments](https://pygments.org/)). If you specify Pygments in your `_config.yml` file, Rouge will be used as the fallback instead. Jekyll cannot use any other syntax highlighter, and you'll get a page build warning if you specify another syntax highlighter in your `_config.yml` file. For more information, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites). diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 2bc75d9bcd69..a5f906b54c01 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -1,6 +1,6 @@ --- title: About Jekyll build errors for GitHub Pages sites -intro: 'If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you''ll receive an error message with more information.' +intro: 'If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.github %}, you''ll receive an error message with more information.' redirect_from: - /articles/viewing-jekyll-build-error-messages - /articles/generic-jekyll-build-failures @@ -24,7 +24,7 @@ If you are publishing from a branch, sometimes {% data variables.product.prodnam * You're using a CI service that isn't configured to build your publishing source. For example, Travis CI won't build the `gh-pages` branch unless you add the branch to a safe list. For more information, see [Customizing the build](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches) on Travis CI, or your CI service's documentation. > [!NOTE] -> It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.product_name %}. +> It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.github %}. {% ifversion build-pages-with-actions %} If Jekyll does attempt to build your site and encounters an error, you will receive a build error message. @@ -45,24 +45,24 @@ By default, your {% data variables.product.prodname_pages %} site is built and d {% ifversion build-pages-with-actions %}{% else %} -## Viewing your repository's build failures on {% data variables.product.product_name %} +## Viewing your repository's build failures on {% data variables.product.github %} -You can see build failures (but not build warnings) for your site on {% data variables.product.product_name %} in the **Settings** tab of your site's repository. +You can see build failures (but not build warnings) for your site in the **Settings** tab of your site's repository. {% endif %} ## Viewing Jekyll build error messages locally -We recommend testing your site locally, which allows you to see build error messages on the command line, and addressing any build failures before pushing changes to {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). +We recommend testing your site locally, which allows you to see build error messages on the command line, and addressing any build failures before pushing changes to {% data variables.product.github %}. For more information, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). ## Viewing Jekyll build error messages in your pull request -If you are publishing from a branch, when you create a pull request to update your publishing source on {% data variables.product.product_name %}, you can see build error messages on the **Checks** tab of the pull request. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks). +If you are publishing from a branch, when you create a pull request to update your publishing source on {% data variables.product.github %}, you can see build error messages on the **Checks** tab of the pull request. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks). If you are publishing with a custom {% data variables.product.prodname_actions %} workflow, in order to see build error messages in your pull request, you must configure your workflow to run on the `pull_request` trigger. When you do this, we recommend that you skip any deploy steps if the workflow was triggered by the `pull_request` event. This will allow you to see any build errors without deploying the changes from your pull request to your site. For more information, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request) and [AUTOTITLE](/actions/learn-github-actions/expressions). ## Viewing Jekyll build errors by email -If you are publishing from a branch, when you push changes to your publishing source on {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} will attempt to build your site. If the build fails, you'll receive an email at your primary email address. {% data reusables.pages.build-failure-email-server %} +If you are publishing from a branch, when you push changes to your publishing source on {% data variables.product.github %}, {% data variables.product.prodname_pages %} will attempt to build your site. If the build fails, you'll receive an email at your primary email address. {% data reusables.pages.build-failure-email-server %} If you are publishing with a custom {% data variables.product.prodname_actions %} workflow, in order to receive emails about build errors in your pull request, you must configure your workflow to run on the `pull_request` trigger. When you do this, we recommend that you skip any deploy steps if the workflow was triggered by the `pull_request` event. This will allow you to see any build errors without deploying the changes from your pull request to your site. For more information, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request) and [AUTOTITLE](/actions/learn-github-actions/expressions). diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md index f6fe1557bdbf..001014962bb5 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md @@ -134,7 +134,7 @@ Before you can use Jekyll to create a {% data variables.product.prodname_pages % {% endif %} ``` -1. Push the repository to {% data variables.product.product_name %}, replacing BRANCH with the name of the branch you're working on. +1. Push the repository to {% data variables.product.github %}, replacing BRANCH with the name of the branch you're working on. ```shell git push -u origin BRANCH diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md index b5318dc329a8..3fdc3333b721 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md @@ -18,7 +18,7 @@ shortTitle: Set Markdown processor People with write permissions for a repository can set the Markdown processor for a {% data variables.product.prodname_pages %} site. -{% data variables.product.prodname_pages %} supports two Markdown processors: [kramdown](http://kramdown.gettalong.org/) and {% data variables.product.prodname_dotcom %}'s own Markdown processor, which is used to render [{% data variables.product.prodname_dotcom %} Flavored Markdown (GFM)](https://github.github.com/gfm/) throughout {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github). +{% data variables.product.prodname_pages %} supports two Markdown processors: [kramdown](http://kramdown.gettalong.org/) and {% data variables.product.github %}'s own Markdown processor, which is used to render [{% data variables.product.prodname_dotcom %} Flavored Markdown (GFM)](https://github.github.com/gfm/) throughout {% data variables.product.github %}. For more information, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github). You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with either processor. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md index 9042ab6f6930..3b7c5c59e707 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll.md @@ -64,7 +64,7 @@ Before you can use Jekyll to test a site, you must: ## Updating the {% data variables.product.prodname_pages %} gem -Jekyll is an active open source project that is updated frequently. If the `github-pages` gem on your computer is out of date with the `github-pages` gem on the {% data variables.product.prodname_pages %} server, your site may look different when built locally than when published on {% data variables.product.product_name %}. To avoid this, regularly update the `github-pages` gem on your computer. +Jekyll is an active open source project that is updated frequently. If the `github-pages` gem on your computer is out of date with the `github-pages` gem on the {% data variables.product.prodname_pages %} server, your site may look different when built locally than when published on {% data variables.product.github %}. To avoid this, regularly update the `github-pages` gem on your computer. {% data reusables.command_line.open_the_multi_os_terminal %} 1. Update the `github-pages` gem. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index 1329083eee28..c132d428b4c7 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -37,7 +37,7 @@ shortTitle: Troubleshoot Jekyll errors ## Troubleshooting build errors -If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you can use error messages to troubleshoot. For more information about error messages and how to view them, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites). +If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.github %}, you can use error messages to troubleshoot. For more information about error messages and how to view them, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites). If you received a generic error message, check for common issues. * You're using unsupported plugins. For more information, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins).{% ifversion fpt or ghec %} @@ -180,4 +180,4 @@ This error means that your code contains an unrecognized Liquid tag. To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default variables, see [Variables](https://jekyllrb.com/docs/variables/) in the Jekyll documentation. -Unsupported plugins are a common source of unrecognized tags. If you use an unsupported plugin in your site by generating your site locally and pushing your static files to {% data variables.product.product_name %}, make sure the plugin is not introducing tags that are not in Jekyll's default variables. For a list of supported plugins, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins). +Unsupported plugins are a common source of unrecognized tags. If you use an unsupported plugin in your site by generating your site locally and pushing your static files to {% data variables.product.github %}, make sure the plugin is not introducing tags that are not in Jekyll's default variables. For a list of supported plugins, see [AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins). diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index 75b0432ca632..1a3aac673780 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -24,6 +24,7 @@ children: - /license - /manage-ghes - /management-console + - /network-configurations - /org-pre-receive-hooks - /orgs - /pre-receive-environments diff --git a/content/rest/enterprise-admin/network-configurations.md b/content/rest/enterprise-admin/network-configurations.md new file mode 100644 index 000000000000..ef9ad6050143 --- /dev/null +++ b/content/rest/enterprise-admin/network-configurations.md @@ -0,0 +1,13 @@ +--- +title: REST API endpoints for enterprise network configurations +shortTitle: Network configurations +intro: Use the REST API to interact with enterprise network configurations. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/index.md b/content/rest/index.md index 9987a9f92c42..39cfab744fb2 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -86,6 +86,7 @@ children: - /search - /secret-scanning - /security-advisories + - /settings - /teams - /users autogenerated: rest diff --git a/content/rest/settings/index.md b/content/rest/settings/index.md new file mode 100644 index 000000000000..6af2c1cf2ae0 --- /dev/null +++ b/content/rest/settings/index.md @@ -0,0 +1,13 @@ +--- +title: settings +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +children: + - /network-configurations +versions: + fpt: '*' + ghec: '*' +--- + diff --git a/content/rest/settings/network-configurations.md b/content/rest/settings/network-configurations.md new file mode 100644 index 000000000000..a5f20f96a76a --- /dev/null +++ b/content/rest/settings/network-configurations.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for network configurations +shortTitle: Network configurations +intro: Use the REST API to interact with network configurations. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/data/release-notes/enterprise-server/3-12/14.yml b/data/release-notes/enterprise-server/3-12/14.yml new file mode 100644 index 000000000000..7fa5173d288a --- /dev/null +++ b/data/release-notes/enterprise-server/3-12/14.yml @@ -0,0 +1,50 @@ +date: '2025-01-21' +sections: + security_fixes: + - | + **HIGH:** An attacker could forge a SAML response to provision and/or gain access to an account with administrator privileges for GitHub Enterprise Server instances that use SAML single sign-on authentication. Instances not utilizing SAML single sign-on or where the attacker is not already an existing user are not impacted. Exploitation of this vulnerability would allow for signature spoofing by improper validation. GitHub has requested CVE ID [CVE-2025-23369](https://www.cve.org/cverecord?id=CVE-2025-23369) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). + - | + Packages have been updated to the latest security versions. + bugs: + - | + Restore failed silently on incremental MySQL backups. + - | + On an instance with GitHub Actions enabled, a configuration run could hang if the blob storage was inaccessible. + - | + After an initial reboot, the appliance sometimes altered the ownership permissions of `gitmon` directories. As a result, the Management Console could hang at the "Starting" phase. + - | + Repository archive exports failed when the archive was more than 5 GiB. + - | + `ghe-migrator` imports could fail due to attachments with invalid model types. + changes: + - | + To avoid service disruption, the bundled action `actions/setup-dotnet` uses new .NET CDN URLs. See https://github.com/dotnet/core/issues/9671. + - | + To avoid unnecessary error messages when users attempt to create a ruleset in evaluate mode in a repository that is user owned, we removed the evaluate mode option on the ruleset. + known_issues: + - | + Custom firewall rules are removed during the upgrade process. + - | + During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. + - | + If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." + - | + The `mbind: Operation not permitted` error in the `/var/log/mysql/mysql.err` file can be ignored. MySQL 8 does not gracefully handle when the `CAP_SYS_NICE` capability isn't required, and outputs an error instead of a warning. + - | + {% data reusables.release-notes.2023-11-aws-system-time %} + - | + On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. + - | + {% data reusables.release-notes.large-adoc-files-issue %} + - | + Repositories originally imported using ghe-migrator will not correctly track Advanced Security contributions. + - | + The `reply.[hostname]` subdomain is falsely always displaying as having no ssl and dns record, when testing the domain settings via management console **without subdomain isolation**. When regenerating the certificates with management console, the `subdomain reply.[hostname]` is missing from the ssl certification. + - | + Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. + - | + {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} + - | + When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. + - | + Some customers upgrading from 3.11.x or 3.12.x may experience a bug with the feature "Automatic update checks", filling the root disk with logs causing a system degradation. To prevent this, you can turn off the feature "[Enable automatic update check](/admin/upgrading-your-instance/preparing-to-upgrade/enabling-automatic-update-checks#enabling-automatic-update-checks)" in the management console. diff --git a/data/release-notes/enterprise-server/3-13/10.yml b/data/release-notes/enterprise-server/3-13/10.yml new file mode 100644 index 000000000000..7b7e35c70756 --- /dev/null +++ b/data/release-notes/enterprise-server/3-13/10.yml @@ -0,0 +1,54 @@ +date: '2025-01-21' +sections: + security_fixes: + - | + **HIGH:** An attacker could forge a SAML response to provision and/or gain access to an account with administrator privileges for GitHub Enterprise Server instances that use SAML single sign-on authentication. Instances not utilizing SAML single sign-on or where the attacker is not already an existing user are not impacted. Exploitation of this vulnerability would allow for signature spoofing by improper validation. GitHub has requested CVE ID [CVE-2025-23369](https://www.cve.org/cverecord?id=CVE-2025-23369) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). + - | + Packages have been updated to the latest security versions. + bugs: + - | + Restore failed silently on incremental MySQL backups. + - | + On an instance with GitHub Actions enabled, a configuration run could hang if the blob storage was inaccessible. + - | + Site administrators using `ghe-config-apply` saw `rm cannot remove DIRECTORY` errors. Old log directories are now removed without reporting errors. + - | + After an initial reboot, the appliance sometimes altered the ownership permissions of `gitmon` directories. As a result, the Management Console could hang at the "Starting" phase. + - | + The view for a repository's "top contributors" failed to render when when it received invalid parameters. + - | + Repository archive exports failed when the archive was more than 5 GiB. + - | + The SAML SSO and SCIM identity of the user (actor) who performed the action, `external_identity_nameid`, was omitted from the metadata for audit log entries. + - | + If you unarchived a repository with secret scanning enabled and then enabled GitHub Advanced Security, the feature settings were incorrectly reported by security overview. Secret scanning was shown as disabled. + - | + `ghe-migrator` imports could fail due to attachments with invalid model types. + changes: + - | + To avoid service disruption, the bundled action `actions/setup-dotnet` uses new .NET CDN URLs. See https://github.com/dotnet/core/issues/9671. + - | + To avoid unnecessary error messages when users attempt to create a ruleset in evaluate mode in a repository that is user owned, we removed the evaluate mode option on the ruleset. + - | + Log output for git maintenance now includes the time taken to complete the maintenance process. + known_issues: + - | + During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. + - | + If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." + - | + On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. + - | + Repositories originally imported using ghe-migrator will not correctly track Advanced Security contributions. + - | + For an instance in a cluster configuration and with GitHub Actions enabled, restoring a cluster from backup requires targeting the primary DB node. + - | + When following the steps for [Replacing the primary MySQL node](/enterprise-server@3.12/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. + - | + Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. + - | + {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} + - | + When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. + - | + When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. diff --git a/data/release-notes/enterprise-server/3-14/7.yml b/data/release-notes/enterprise-server/3-14/7.yml new file mode 100644 index 000000000000..aecbdeb98cf2 --- /dev/null +++ b/data/release-notes/enterprise-server/3-14/7.yml @@ -0,0 +1,64 @@ +date: '2025-01-21' +sections: + security_fixes: + - | + **HIGH:** An attacker could forge a SAML response to provision and/or gain access to an account with administrator privileges for GitHub Enterprise Server instances that use SAML single sign-on authentication. Instances not utilizing SAML single sign-on or where the attacker is not already an existing user are not impacted. Exploitation of this vulnerability would allow for signature spoofing by improper validation. GitHub has requested CVE ID [CVE-2025-23369](https://www.cve.org/cverecord?id=CVE-2025-23369) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). + - | + Packages have been updated to the latest security versions. + bugs: + - | + Restore failed silently on incremental MySQL backups. + - | + On an instance with GitHub Actions enabled, a configuration run could hang if the blob storage was inaccessible. + - | + Site administrators using `ghe-config-apply` saw `rm cannot remove DIRECTORY` errors. Old log directories are now removed without reporting errors. + - | + After an initial reboot, the appliance sometimes altered the ownership permissions of `gitmon` directories. As a result, the Management Console could hang at the "Starting" phase. + - | + The view for a repository's "top contributors" failed to render when when it received invalid parameters. + - | + Repository archive exports failed when the archive was more than 5 GiB. + - | + When users bypassed push protections for a file upload but did not re-add the file after the bypass was created, an incorrect error message displayed. + - | + The SAML SSO and SCIM identity of the user (actor) who performed the action, `external_identity_nameid`, was omitted from the metadata for audit log entries. + - | + If you unarchived a repository with secret scanning enabled and then enabled GitHub Advanced Security, the feature settings were incorrectly reported by security overview. Secret scanning was shown as disabled. + - | + `ghe-migrator` imports could fail due to attachments with invalid model types. + changes: + - | + To avoid service disruption, the bundled action `actions/setup-dotnet` uses new .NET CDN URLs. See https://github.com/dotnet/core/issues/9671. + - | + To avoid unnecessary error messages when users attempt to create a ruleset in evaluate mode in a repository that is user owned, we removed the evaluate mode option on the ruleset. + known_issues: + - | + During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. + - | + If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." + - | + On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. + - | + {% data reusables.release-notes.large-adoc-files-issue %} + - | + Repositories originally imported using ghe-migrator will not correctly track Advanced Security contributions. + - | + Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. + - | + When following the steps for [Replacing the primary MySQL node](/enterprise-server@3.12/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. + - | + Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. + - | + {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} + - | + When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. + - | + An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. + - | + When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. + - | + In the header bar displayed to site administrators, some icons are not available. + - | + When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. + - | + When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. diff --git a/data/release-notes/enterprise-server/3-15/2.yml b/data/release-notes/enterprise-server/3-15/2.yml new file mode 100644 index 000000000000..1ffbf5af8e5a --- /dev/null +++ b/data/release-notes/enterprise-server/3-15/2.yml @@ -0,0 +1,79 @@ +date: '2025-01-21' +sections: + security_fixes: + - | + **HIGH:** An attacker could forge a SAML response to provision and/or gain access to an account with administrator privileges for GitHub Enterprise Server instances that use SAML single sign-on authentication. Instances not utilizing SAML single sign-on or where the attacker is not already an existing user are not impacted. Exploitation of this vulnerability would allow for signature spoofing by improper validation. GitHub has requested CVE ID [CVE-2025-23369](https://www.cve.org/cverecord?id=CVE-2025-23369) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com/). + - | + Packages have been updated to the latest security versions. + bugs: + - | + Restore failed silently on incremental MySQL backups. + - | + On an instance with GitHub Actions enabled, a configuration run could hang if the blob storage was inaccessible. + - | + Site administrators using `ghe-config-apply` saw `rm cannot remove DIRECTORY` errors. Old log directories are now removed without reporting errors. + - | + Syntax highlighting did not work on the "Code" view of a file. + - | + After an initial reboot, the appliance sometimes altered the ownership permissions of `gitmon` directories. As a result, the Management Console got stuck at the "Starting" phase. + - | + The view for a repository's "top contributors" failed to render when when it received invalid parameters. + - | + Repository archive exports failed when the archive was more than 5 GiB. + - | + When users bypassed push protections for a file upload but did not re-add the file after the bypass was created, an incorrect error message displayed. + - | + The SAML SSO and SCIM identity of the user (actor) who performed the action, the `external_identity_nameid`, was omitted from the metadata for audit log entries. + - | + If you unarchived a repository with secret scanning enabled and then enabled GitHub Advanced Security, the feature settings were incorrectly reported by security overview. Secret scanning was shown as disabled. + - | + `ghe-migrator` imports could fail due to attachments with invalid model types. + - | + In some cases, `ghe-spokesctl status`(without `--live`) displayed entries that no longer existed. + changes: + - | + New installations of GitHub Enterprise Server version 3.15 and upgrades to 3.15 recommend a root disk size of at least 400GB. Previously the system would not boot with a smaller disk size, see [Enterprise Server 3.15.0](/enterprise-server@3.15/admin/release-notes#3.15.0-features). Customers on standalone or standalone HA topologies should plan to upgrade their root disk size to 400GB. + - | + To avoid service disruption, the bundled action `actions/setup-dotnet` uses new .NET CDN URLs. See https://github.com/dotnet/core/issues/9671. + - | + To avoid unnecessary error messages when users attempt to create a ruleset in evaluate mode in a repository that is user owned, we removed the evaluate mode option on the ruleset. + closing_down: + - | + All users should be aware that GitHub Projects (classic) are closing down. They should migrate to new Projects powered by GitHub Issues. See [AUTOTITLE](/enterprise-server@3.15/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic). + + GitHub Projects (classic) will be retired in GitHub Enterprise Server 3.17. For more information, see the [Projects (classic) sunset](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) blog post. + known_issues: + - | + During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start. + - | + If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." + - | + On an instance with the HTTP `X-Forwarded-For` header configured for use behind a load balancer, all client IP addresses in the instance's audit log erroneously appear as 127.0.0.1. + - | + {% data reusables.release-notes.large-adoc-files-issue %} + - | + Repositories originally imported using ghe-migrator will not correctly track Advanced Security contributions. + - | + Admin stats REST API endpoints may timeout on appliances with many users or repositories. Retrying the request until data is returned is advised. + - | + When following the steps for [Replacing the primary MySQL node](/enterprise-server@3.12/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. + - | + Running a config apply as part of the steps for [Replacing a node in an emergency](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-a-node-in-an-emergency) may fail with errors if the node being replaced is still reachable. If this occurs, shutdown the node and repeat the steps. + - | + {% data reusables.release-notes.2024-06-possible-frontend-5-minute-outage-during-hotpatch-upgrade %} + - | + When restoring data originally backed up from a 3.13 appliance onto a 3.13 appliance, the elasticsearch indices need to be reindexed before some of the data will show up. This happens via a nightly scheduled job. It can also be forced by running `/usr/local/share/enterprise/ghe-es-search-repair`. + - | + An organization-level code scanning configuration page is displayed on instances that do not use GitHub Advanced Security or code scanning. + - | + When following the steps for [Replacing the primary MySQL node](/admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node#replacing-the-primary-mysql-node), step 14 (running `ghe-cluster-config-apply`) might fail with errors. If this occurs, re-running `ghe-cluster-config-apply` is expected to succeed. + - | + In the header bar displayed to site administrators, some icons are not available. + - | + When enabling automatic update checks for the first time in the Management Console, the status is not dynamically reflected until the "Updates" page is reloaded. + - | + When restoring from a backup snapshot, a large number of `mapper_parsing_exception` errors may be displayed. + - | + When initializing a new GHES cluster, nodes with the `consul-server` role should be added to the cluster before adding additional nodes. Adding all nodes simultaneously creates a race condition between nomad server registration and nomad client registration. + - | + Admins setting up cluster high availability (HA) may encounter a spokes error when running ghe-cluster-repl-status if a new organization and repositories are created before using the ghe-cluster-repl-bootstrap command. To avoid this issue, complete the cluster HA setup with ghe-cluster-repl-bootstrap before creating new organizations and repositories. diff --git a/data/reusables/copilot/custom-instructions-note.md b/data/reusables/copilot/custom-instructions-note.md new file mode 100644 index 000000000000..4bf351da36fa --- /dev/null +++ b/data/reusables/copilot/custom-instructions-note.md @@ -0,0 +1,3 @@ +> [!NOTE] +> * This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change. +> * Custom instructions are currently supported for {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode_shortname %} and on the {% data variables.product.github %} website. diff --git a/data/reusables/copilot/custom-instructions-reference.md b/data/reusables/copilot/custom-instructions-reference.md new file mode 100644 index 000000000000..e034c1d6964a --- /dev/null +++ b/data/reusables/copilot/custom-instructions-reference.md @@ -0,0 +1,3 @@ +The instructions in the `.github/copilot-instructions.md` file are available for use by {% data variables.product.prodname_copilot_chat_short %} as soon as you save the file. The complete set of instructions will be automatically attached to requests that you submit in either the {% data variables.product.prodname_copilot_chat_short %} view, or in inline chat. + +Custom instructions are not visible in the Chat view or inline chat, but you can verify that they are being used by {% data variables.product.prodname_copilot_short %} by looking at the References list of a response in the Chat view. If custom instructions were added to the prompt that was sent to the model, the `.github/copilot-instructions.md` file is listed as a reference. You can click the reference to open the file. 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 850a13922734..4ee3c190c7e0 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 @@ -1244,6 +1244,66 @@ } ] }, + "organization_network_configurations": { + "title": "Network configurations", + "displayTitle": "Organization permissions for \"Network configurations\"", + "permissions": [ + { + "category": "settings", + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations", + "additional-permissions": false, + "access": "read" + }, + { + "category": "settings", + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations", + "additional-permissions": false, + "access": "write" + }, + { + "category": "settings", + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "settings", + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "settings", + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "settings", + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}", + "additional-permissions": false, + "access": "read" + } + ] + }, "organization_codespaces_secrets": { "title": "Organization codespaces secrets", "displayTitle": "Organization permissions for \"Organization codespaces secrets\"", 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 545be54ed0d2..8447cfed50a1 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 @@ -4967,6 +4967,44 @@ "requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks" } ], + "settings": [ + { + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}" + } + ], "teams": [ { "slug": "list-teams", 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 4620ee9da577..452cf917a98e 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 @@ -1510,6 +1510,78 @@ } ] }, + "organization_network_configurations": { + "title": "Network configurations", + "displayTitle": "Organization permissions for \"Network configurations\"", + "permissions": [ + { + "category": "settings", + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "organization_codespaces_secrets": { "title": "Organization codespaces secrets", "displayTitle": "Organization permissions for \"Organization codespaces secrets\"", 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 8b4121c46979..b16a71da8365 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 @@ -4475,6 +4475,44 @@ "requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks" } ], + "settings": [ + { + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}" + } + ], "teams": [ { "slug": "list-teams", 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 545be54ed0d2..8447cfed50a1 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 @@ -4967,6 +4967,44 @@ "requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks" } ], + "settings": [ + { + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}" + } + ], "teams": [ { "slug": "list-teams", 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 86796d53ea83..d028cd78bdce 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 @@ -1661,6 +1661,66 @@ } ] }, + "organization_network_configurations": { + "title": "Network configurations", + "displayTitle": "Organization permissions for \"Network configurations\"", + "permissions": [ + { + "category": "settings", + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations", + "additional-permissions": false, + "access": "read" + }, + { + "category": "settings", + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations", + "additional-permissions": false, + "access": "write" + }, + { + "category": "settings", + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "settings", + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "settings", + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "settings", + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}", + "additional-permissions": false, + "access": "read" + } + ] + }, "organization_announcement_banners": { "title": "Organization announcement banners", "displayTitle": "Organization permissions for \"Organization announcement banners\"", 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 21051f5ff4a6..5ec44ce641ae 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 @@ -5351,6 +5351,44 @@ "requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks" } ], + "settings": [ + { + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}" + } + ], "teams": [ { "slug": "get-an-external-group", 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 0e2f566294fc..4032443a0abb 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 @@ -2017,6 +2017,78 @@ } ] }, + "organization_network_configurations": { + "title": "Network configurations", + "displayTitle": "Organization permissions for \"Network configurations\"", + "permissions": [ + { + "category": "settings", + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "settings", + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "organization_announcement_banners": { "title": "Organization announcement banners", "displayTitle": "Organization permissions for \"Organization announcement banners\"", 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 d79759917913..22501e8af1f2 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 @@ -4859,6 +4859,44 @@ "requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks" } ], + "settings": [ + { + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}" + } + ], "teams": [ { "slug": "get-an-external-group", 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 21051f5ff4a6..5ec44ce641ae 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 @@ -5351,6 +5351,44 @@ "requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks" } ], + "settings": [ + { + "slug": "list-hosted-compute-network-configurations-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "create-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations" + }, + { + "slug": "get-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "update-a-hosted-compute-network-configuration-for-an-organization", + "subcategory": "network-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "delete-a-hosted-compute-network-configuration-from-an-organization", + "subcategory": "network-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}" + }, + { + "slug": "get-a-hosted-compute-network-settings-resource-for-an-organization", + "subcategory": "network-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}" + } + ], "teams": [ { "slug": "get-an-external-group", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index c32c859e3a53..b0edf2f3c642 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "b42313397697ee856b4effdcc2727a5dbe6cbd6d" + "sha": "7509e549b11bd1aeebf531fc527c542a70cf944b" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index d6f1d74a28a1..1883890c1a31 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -238895,6 +238895,14 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
  • \n
  • Comparators such as >n, <n, >=n, <=n
  • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
  • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", + "schema": { + "type": "string" + } + }, { "name": "scope", "in": "query", @@ -240759,6 +240767,14 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
  • \n
  • Comparators such as >n, <n, >=n, <=n
  • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
  • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", + "schema": { + "type": "string" + } + }, { "name": "scope", "in": "query", @@ -242648,6 +242664,14 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
  • \n
  • Comparators such as >n, <n, >=n, <=n
  • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
  • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", + "schema": { + "type": "string" + } + }, { "name": "scope", "in": "query", @@ -337175,7 +337199,7 @@ "type": "integer", "name": "sub_issue_id", "in": "body", - "description": "

The sub-issue to remove

", + "description": "

The id of the sub-issue to remove

", "isRequired": true } ], @@ -343131,7 +343155,7 @@ "type": "integer", "name": "sub_issue_id", "in": "body", - "description": "

The sub-issue to add

", + "description": "

The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue

", "isRequired": true }, { @@ -582490,6 +582514,810 @@ } ] }, + "settings": { + "network-configurations": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations", + "title": "List hosted compute network configurations for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "network_configurations": [ + { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + { + "id": "456789ABDCEF123", + "name": "My other configuration", + "compute_service": "none", + "network_settings_ids": [ + "56789ABDCEF1234", + "6789ABDCEF12345" + ], + "created_on": "2023-04-26T15:23:37Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "network_configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "network_configurations": { + "type": "array", + "items": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all hosted compute network configurations configured in an organization.

\n

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

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations", + "title": "Create a hosted compute network configuration for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.

", + "isRequired": true + }, + { + "type": "string", + "name": "compute_service", + "in": "body", + "description": "

The hosted compute service to use for the network configuration.

", + "enum": [ + "none", + "actions" + ] + }, + { + "type": "array of strings", + "name": "network_settings_ids", + "in": "body", + "description": "

The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates a hosted compute network configuration for an organization.

\n

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

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

Created

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "title": "Get a hosted compute network configuration for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a hosted compute network configuration configured in an organization.

\n

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

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "title": "Update a hosted compute network configuration for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.

" + }, + { + "type": "string", + "name": "compute_service", + "in": "body", + "description": "

The hosted compute service to use for the network configuration.

", + "enum": [ + "none", + "actions" + ] + }, + { + "type": "array of strings", + "name": "network_settings_ids", + "in": "body", + "description": "

The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + }, + "parameters": { + "org": "ORG", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

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

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "title": "Delete a hosted compute network configuration from an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Deletes a hosted compute network configuration from an organization.

\n

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

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

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}", + "title": "Get a hosted compute network settings resource for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_settings_id", + "description": "

Unique identifier of the hosted compute network settings.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "network_settings_id": "NETWORK_SETTINGS_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D", + "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562", + "name": "my_network_settings", + "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet", + "region": "eastus" + }, + "schema": { + "title": "Hosted compute network settings resource", + "description": "A hosted compute network settings resource.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network settings resource.", + "type": "string", + "examples": [ + "220F78DACB92BBFBC5E6F22DE1CCF52309D" + ] + }, + "network_configuration_id": { + "description": "The identifier of the network configuration that is using this settings resource.", + "type": "string", + "examples": [ + "934E208B3EE0BD60CF5F752C426BFB53562" + ] + }, + "name": { + "description": "The name of the network settings resource.", + "type": "string", + "examples": [ + "my-network-settings" + ] + }, + "subnet_id": { + "description": "The subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + ] + }, + "region": { + "description": "The location of the subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "eastus" + ] + } + }, + "required": [ + "id", + "name", + "subnet_id", + "region" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a hosted compute network settings resource configured for an organization.

\n

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

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

OK

" + } + ] + } + ] + }, "teams": { "teams": [ { diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 3f68e6bb9294..0910c5cab9a1 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -252602,6 +252602,14 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
  • \n
  • Comparators such as >n, <n, >=n, <=n
  • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
  • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", + "schema": { + "type": "string" + } + }, { "name": "scope", "in": "query", @@ -254466,6 +254474,14 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
  • \n
  • Comparators such as >n, <n, >=n, <=n
  • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
  • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", + "schema": { + "type": "string" + } + }, { "name": "scope", "in": "query", @@ -256355,6 +256371,14 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "

CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:

\n
    \n
  • An exact number (n)
  • \n
  • Comparators such as >n, <n, >=n, <=n
  • \n
  • A range like n..n, where n is a number from 0.0 to 1.0
  • \n
\n

Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.

", + "schema": { + "type": "string" + } + }, { "name": "scope", "in": "query", @@ -279406,6 +279430,784 @@ ] } ], + "network-configurations": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/network-configurations", + "title": "List hosted compute network configurations for an enterprise", + "category": "enterprise-admin", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "network_configurations": [ + { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + { + "id": "456789ABDCEF123", + "name": "My other configuration", + "compute_service": "none", + "network_settings_ids": [ + "56789ABDCEF1234", + "6789ABDCEF12345" + ], + "created_on": "2023-04-26T15:23:37Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "network_configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "network_configurations": { + "type": "array", + "items": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all hosted compute network configurations configured in an enterprise.

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/enterprises/{enterprise}/network-configurations", + "title": "Create a hosted compute network configuration for an enterprise", + "category": "enterprise-admin", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, ., -, and _.

", + "isRequired": true + }, + { + "type": "string", + "name": "compute_service", + "in": "body", + "description": "

The hosted compute service to use for the network configuration.

", + "enum": [ + "none", + "actions" + ] + }, + { + "type": "array of strings", + "name": "network_settings_ids", + "in": "body", + "description": "

The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates a hosted compute network configuration for an enterprise.

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

Created

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/network-configurations/{network_configuration_id}", + "title": "Get a hosted compute network configuration for an enterprise", + "category": "enterprise-admin", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a hosted compute network configuration configured in an enterprise.

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/enterprises/{enterprise}/network-configurations/{network_configuration_id}", + "title": "Update a hosted compute network configuration for an enterprise", + "category": "enterprise-admin", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, ., -, and _.

" + }, + { + "type": "string", + "name": "compute_service", + "in": "body", + "description": "

The hosted compute service to use for the network configuration.

", + "enum": [ + "none", + "actions" + ] + }, + { + "type": "array of strings", + "name": "network_settings_ids", + "in": "body", + "description": "

The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.

" + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + }, + "parameters": { + "enterprise": "ENTERPRISE", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Updates a hosted compute network configuration for an enterprise.

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/network-configurations/{network_configuration_id}", + "title": "Delete a hosted compute network configuration from an enterprise", + "category": "enterprise-admin", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Deletes a hosted compute network configuration from an enterprise.

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

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/network-settings/{network_settings_id}", + "title": "Get a hosted compute network settings resource for an enterprise", + "category": "enterprise-admin", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "enterprise", + "description": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_settings_id", + "description": "

Unique identifier of the hosted compute network settings.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "network_settings_id": "NETWORK_SETTINGS_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D", + "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562", + "name": "my_network_settings", + "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet", + "region": "eastus" + }, + "schema": { + "title": "Hosted compute network settings resource", + "description": "A hosted compute network settings resource.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network settings resource.", + "type": "string", + "examples": [ + "220F78DACB92BBFBC5E6F22DE1CCF52309D" + ] + }, + "network_configuration_id": { + "description": "The identifier of the network configuration that is using this settings resource.", + "type": "string", + "examples": [ + "934E208B3EE0BD60CF5F752C426BFB53562" + ] + }, + "name": { + "description": "The name of the network settings resource.", + "type": "string", + "examples": [ + "my-network-settings" + ] + }, + "subnet_id": { + "description": "The subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + ] + }, + "region": { + "description": "The location of the subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "eastus" + ] + } + }, + "required": [ + "id", + "name", + "subnet_id", + "region" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a hosted compute network settings resource configured for an enterprise.

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

OK

" + } + ] + } + ], "rules": [ { "serverUrl": "https://api.github.com", @@ -367889,7 +368691,7 @@ "type": "integer", "name": "sub_issue_id", "in": "body", - "description": "

The sub-issue to remove

", + "description": "

The id of the sub-issue to remove

", "isRequired": true } ], @@ -373845,7 +374647,7 @@ "type": "integer", "name": "sub_issue_id", "in": "body", - "description": "

The sub-issue to add

", + "description": "

The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue

", "isRequired": true }, { @@ -622070,6 +622872,810 @@ } ] }, + "settings": { + "network-configurations": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations", + "title": "List hosted compute network configurations for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "total_count": 2, + "network_configurations": [ + { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + { + "id": "456789ABDCEF123", + "name": "My other configuration", + "compute_service": "none", + "network_settings_ids": [ + "56789ABDCEF1234", + "6789ABDCEF12345" + ], + "created_on": "2023-04-26T15:23:37Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "network_configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "network_configurations": { + "type": "array", + "items": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all hosted compute network configurations configured in an organization.

\n

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

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/settings/network-configurations", + "title": "Create a hosted compute network configuration for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.

", + "isRequired": true + }, + { + "type": "string", + "name": "compute_service", + "in": "body", + "description": "

The hosted compute service to use for the network configuration.

", + "enum": [ + "none", + "actions" + ] + }, + { + "type": "array of strings", + "name": "network_settings_ids", + "in": "body", + "description": "

The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates a hosted compute network configuration for an organization.

\n

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

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

Created

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "title": "Get a hosted compute network configuration for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a hosted compute network configuration configured in an organization.

\n

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

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "title": "Update a hosted compute network configuration for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.

" + }, + { + "type": "string", + "name": "compute_service", + "in": "body", + "description": "

The hosted compute service to use for the network configuration.

", + "enum": [ + "none", + "actions" + ] + }, + { + "type": "array of strings", + "name": "network_settings_ids", + "in": "body", + "description": "

The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + }, + "parameters": { + "org": "ORG", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + "schema": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "examples": [ + "123ABC456DEF789" + ] + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "examples": [ + "my-network-configuration" + ] + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "123ABC456DEF789" + ] + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2024-04-26T11:31:07Z" + ] + } + }, + "required": [ + "id", + "name", + "created_on" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Updates a hosted compute network configuration for an organization.

\n

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

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

OK

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}", + "title": "Delete a hosted compute network configuration from an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_configuration_id", + "description": "

Unique identifier of the hosted compute network configuration.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "network_configuration_id": "NETWORK_CONFIGURATION_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Deletes a hosted compute network configuration from an organization.

\n

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

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

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}", + "title": "Get a hosted compute network settings resource for an organization", + "category": "settings", + "subcategory": "network-configurations", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "network_settings_id", + "description": "

Unique identifier of the hosted compute network settings.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Network configurations\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "network_settings_id": "NETWORK_SETTINGS_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D", + "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562", + "name": "my_network_settings", + "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet", + "region": "eastus" + }, + "schema": { + "title": "Hosted compute network settings resource", + "description": "A hosted compute network settings resource.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network settings resource.", + "type": "string", + "examples": [ + "220F78DACB92BBFBC5E6F22DE1CCF52309D" + ] + }, + "network_configuration_id": { + "description": "The identifier of the network configuration that is using this settings resource.", + "type": "string", + "examples": [ + "934E208B3EE0BD60CF5F752C426BFB53562" + ] + }, + "name": { + "description": "The name of the network settings resource.", + "type": "string", + "examples": [ + "my-network-settings" + ] + }, + "subnet_id": { + "description": "The subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + ] + }, + "region": { + "description": "The location of the subnet this network settings resource is configured for.", + "type": "string", + "examples": [ + "eastus" + ] + } + }, + "required": [ + "id", + "name", + "subnet_id", + "region" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets a hosted compute network settings resource configured for an organization.

\n

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

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

OK

" + } + ] + } + ] + }, "teams": { "teams": [ { diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 7947c73f9cb2..a5da3d8cdfe6 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -177326,13 +177326,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -179190,13 +179189,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181079,13 +181077,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181103,67 +181100,6 @@ ], "default": "desc" } - }, - { - "name": "page", - "description": "

Closing down notice. Page number of the results to fetch. Use cursor-based pagination with before or after instead.

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "bodyParameters": [], diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 83285dfe62ec..98fe41b56dbc 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -177362,13 +177362,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -179226,13 +179225,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181115,13 +181113,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181139,67 +181136,6 @@ ], "default": "desc" } - }, - { - "name": "page", - "description": "

Closing down notice. Page number of the results to fetch. Use cursor-based pagination with before or after instead.

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "bodyParameters": [], diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 34640c2c85bb..76365e9a5d0d 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -177682,13 +177682,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -179546,13 +179545,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181435,13 +181433,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181459,67 +181456,6 @@ ], "default": "desc" } - }, - { - "name": "page", - "description": "

Closing down notice. Page number of the results to fetch. Use cursor-based pagination with before or after instead.

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "bodyParameters": [], diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 7f328fbb83e7..6132778011c0 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -177826,13 +177826,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -179690,13 +179689,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181579,13 +181577,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181603,67 +181600,6 @@ ], "default": "desc" } - }, - { - "name": "page", - "description": "

Closing down notice. Page number of the results to fetch. Use cursor-based pagination with before or after instead.

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "bodyParameters": [], 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 798aece7ad1e..7e294a315091 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 @@ -177826,13 +177826,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -179690,13 +179689,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181579,13 +181577,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -181603,67 +181600,6 @@ ], "default": "desc" } - }, - { - "name": "page", - "description": "

Closing down notice. Page number of the results to fetch. Use cursor-based pagination with before or after instead.

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "bodyParameters": [], 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 d2629947c503..2ec0761b9584 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 @@ -182001,13 +182001,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -183865,13 +183864,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -185754,13 +185752,12 @@ { "name": "sort", "in": "query", - "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.\nepss_percentage sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.

", + "description": "

The property by which to sort the results.\ncreated means when the alert was created.\nupdated means when the alert's state last changed.

", "schema": { "type": "string", "enum": [ "created", - "updated", - "epss_percentage" + "updated" ], "default": "created" } @@ -185778,67 +185775,6 @@ ], "default": "desc" } - }, - { - "name": "page", - "description": "

Closing down notice. Page number of the results to fetch. Use cursor-based pagination with before or after instead.

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "deprecated": true, - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "first", - "description": "

Deprecated. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with last.\nInstead, use per_page in combination with after to fetch the first page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 30 - } - }, - { - "name": "last", - "description": "

Deprecated. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with first.\nInstead, use per_page in combination with before to fetch the last page of results.

", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100 - } } ], "bodyParameters": [], diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 2e2aa8f8ac52..2b6916068f36 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -50,5 +50,5 @@ ] } }, - "sha": "b42313397697ee856b4effdcc2727a5dbe6cbd6d" + "sha": "7509e549b11bd1aeebf531fc527c542a70cf944b" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index d2c3cadf1348..95b1ca96828e 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "b42313397697ee856b4effdcc2727a5dbe6cbd6d" + "sha": "7509e549b11bd1aeebf531fc527c542a70cf944b" } \ No newline at end of file