From ce978196a1933ed92245b0aea4077293bd635eab Mon Sep 17 00:00:00 2001 From: Charles Kim <52868068+charleskimbac@users.noreply.github.com> Date: Wed, 24 Jan 2024 03:55:28 -0800 Subject: [PATCH 01/23] Update generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md (#31191) --- ...generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 33e9e75abd..cc5bf751ea 100644 --- a/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -74,7 +74,7 @@ If you are a site administrator for {% data variables.location.product_location {% windows %} ```powershell - > Enter a file in which to save the key (c:\Users\YOU\.ssh\id_ALGORITHM):[Press enter] + > Enter file in which to save the key (/c/Users/YOU/.ssh/id_ALGORITHM):[Press enter] ``` {% endwindows %} @@ -169,7 +169,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav {% data reusables.ssh.add-ssh-key-to-ssh-agent %} ```powershell - ssh-add c:\Users\YOU\.ssh\id_ed25519 + ssh-add c:/Users/YOU/.ssh/id_ed25519 ``` {% data reusables.ssh.add-public-key-to-github %} From 9df80cf75f8fefa0a3b751a20819a5b0cee7d1c3 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Wed, 24 Jan 2024 08:21:34 -0500 Subject: [PATCH 02/23] Remove GHAE in Liquid and front matter (8) (#48811) Co-authored-by: Matt Pollard --- .github/workflows/content-lint-markdown.yml | 2 +- .../about-self-hosted-runners.md | 6 +++--- .../adding-self-hosted-runners.md | 8 ++++---- ...ess-to-self-hosted-runners-using-groups.md | 8 ++++---- .../removing-self-hosted-runners.md | 6 +++--- .../using-labels-with-self-hosted-runners.md | 20 +++++++++---------- ...using-self-hosted-runners-in-a-workflow.md | 4 ++-- .../understanding-github-actions.md | 4 ++-- .../security-hardening-for-github-actions.md | 2 +- .../controlling-access-to-larger-runners.md | 2 +- ...s-for-github-actions-in-your-enterprise.md | 2 +- .../scopes-for-oauth-apps.md | 2 +- .../managing-your-personal-access-tokens.md | 4 ++-- .../index.md | 2 +- ...guring-advanced-setup-for-code-scanning.md | 2 +- .../viewing-and-updating-dependabot-alerts.md | 2 +- .../securing-your-organization.md | 6 +++--- .../securing-your-repository.md | 2 +- ...g-secret-scanning-for-your-repositories.md | 4 ++-- ...tion-for-repositories-and-organizations.md | 4 ++-- .../about-security-overview.md | 4 ++-- .../filtering-alerts-in-security-overview.md | 2 +- .../securing-accounts.md | 2 +- .../about-github-advanced-security.md | 2 +- .../best-practices-for-organizations.md | 2 +- .../audit-log-events-for-your-organization.md | 2 +- ...ng-github-actions-for-your-organization.md | 6 +++--- ...he-forking-policy-for-your-organization.md | 2 +- ...epository-creation-in-your-organization.md | 2 +- ...onal-access-tokens-in-your-organization.md | 2 +- ...cess-token-policy-for-your-organization.md | 6 +++--- ...ation-member-to-an-outside-collaborator.md | 2 +- .../repository-roles-for-an-organization.md | 2 +- ...g-people-with-access-to-your-repository.md | 4 ++-- ...out-permissions-and-visibility-of-forks.md | 4 ++-- .../archiving-repositories.md | 2 +- .../searching-on-github/searching-code.md | 4 ++-- .../viewing-and-updating-support-tickets.md | 4 ++-- .../about-github-support.md | 2 +- .../troubleshooting-webhooks.md | 2 +- .../using-webhooks/disabling-webhooks.md | 2 +- data/reusables/actions/about-runner-groups.md | 2 +- .../actions/actions-use-policy-settings.md | 4 ++-- .../actions/disabling-github-actions.md | 2 +- ...licy-label-for-select-actions-workflows.md | 2 +- ...osted-runner-navigate-to-org-enterprise.md | 2 +- ...audit-log-search-list-info-about-action.md | 2 +- .../security-overview/permissions.md | 2 +- .../user-settings/pat-v2-org-opt-in.md | 2 +- .../user-settings/patv2-limitations.md | 4 ++-- 50 files changed, 87 insertions(+), 87 deletions(-) diff --git a/.github/workflows/content-lint-markdown.yml b/.github/workflows/content-lint-markdown.yml index 47a1051eaa..2e08f2a82d 100644 --- a/.github/workflows/content-lint-markdown.yml +++ b/.github/workflows/content-lint-markdown.yml @@ -47,4 +47,4 @@ jobs: # See https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable CHANGED_FILES: |- ${{ steps.changed-files.outputs.all_changed_files }} - run: npm run lint-content -- --errors-only --paths "$CHANGED_FILES" + run: npm run lint-content -- --errors-only --paths $CHANGED_FILES diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md index b332241db2..c7f0397242 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md @@ -17,7 +17,7 @@ type: overview ## About self-hosted runners -A self-hosted runner is a system that you deploy and manage to execute jobs from {% data variables.product.prodname_actions %} on {% ifversion ghae or ghec %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. For more information about {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions){% ifversion fpt %}."{% elsif ghec or ghes or ghae %}" and "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)."{% endif %} +A self-hosted runner is a system that you deploy and manage to execute jobs from {% data variables.product.prodname_actions %} on {% ifversion ghae or ghec %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. For more information about {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions){% ifversion fpt %}."{% elsif ghec or ghes %}" and "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)."{% endif %} {% data reusables.actions.self-hosted-runner-description %} {% data reusables.actions.self-hosted-runner-locations %} @@ -57,7 +57,7 @@ For more information about installing and using self-hosted runners, see "[AUTOT - Can use cloud services or local machines that you already pay for. - Are customizable to your hardware, operating system, software, and security requirements. - Don't need to have a clean instance for every job execution. -- Are free to use with {% data variables.product.prodname_actions %}, but you are responsible for the cost of maintaining your runner machines.{% ifversion ghec or ghes or ghae %} +- Are free to use with {% data variables.product.prodname_actions %}, but you are responsible for the cost of maintaining your runner machines.{% ifversion ghec or ghes %} - Can be organized into groups to restrict access to specific {% ifversion restrict-groups-to-workflows %}workflows, {% endif %}organizations and repositories. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups)."{% endif %} ## Requirements for self-hosted runner machines @@ -285,7 +285,7 @@ For more information about security hardening for self-hosted runners, see "[AUT {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Further reading diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners.md index d0b05e0559..bc84a1ee6f 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners.md @@ -88,12 +88,12 @@ For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managin ## Adding a self-hosted runner to an enterprise -{% ifversion fpt %}If you use {% data variables.product.prodname_ghe_cloud %}, you{% elsif ghec or ghes or ghae %}You{% endif %} can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. The organization owner can control which repositories can use it. {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise).{% endif %} +{% ifversion fpt %}If you use {% data variables.product.prodname_ghe_cloud %}, you{% elsif ghec or ghes %}You{% endif %} can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. The organization owner can control which repositories can use it. {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise).{% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} To add a self-hosted runner to an enterprise, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/actions#self-hosted-runners). @@ -116,7 +116,7 @@ To make an enterprise-level self-hosted runner group available to an organizatio For more information on changing runner group access settings, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Further reading diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md index 69b74d8096..a342577b81 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -1,7 +1,7 @@ --- title: Managing access to self-hosted runners using groups shortTitle: Manage access with runner groups -intro: You can use policies to limit access to self-hosted runners that have been added to an organization{% ifversion ghec or ghes or ghae %} or enterprise{% endif %}. +intro: You can use policies to limit access to self-hosted runners that have been added to an organization{% ifversion ghec or ghes %} or enterprise{% endif %}. permissions: 'Enterprise accounts, organizations owned by enterprise accounts, and organizations using {% data variables.product.prodname_team %} can create and manage additional runner groups.' redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners @@ -14,7 +14,7 @@ versions: ghec: '*' type: tutorial --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## About runner groups @@ -31,7 +31,7 @@ type: tutorial {% data reusables.actions.creating-a-runner-group-for-an-organization %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Creating a self-hosted runner group for an enterprise @@ -45,7 +45,7 @@ type: tutorial {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Changing which organizations can access a runner group diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners.md index f6340fea84..3834ab2dd6 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners.md @@ -1,6 +1,6 @@ --- title: Removing self-hosted runners -intro: 'You can permanently remove a self-hosted runner from a repository{% ifversion fpt %} or organization{% elsif ghec or ghes or ghae %}, an organization, or an enterprise{% endif %}.' +intro: 'You can permanently remove a self-hosted runner from a repository{% ifversion fpt %} or organization{% elsif ghec or ghes %}, an organization, or an enterprise{% endif %}.' redirect_from: - /github/automating-your-workflow-with-github-actions/removing-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/removing-self-hosted-runners @@ -67,7 +67,7 @@ To remove a self-hosted runner from an organization, you must be an organization {% ifversion fpt %} If you use {% data variables.product.prodname_ghe_cloud %}, you can also remove runners from an enterprise. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-self-hosted-runners/removing-self-hosted-runners#removing-a-runner-from-an-enterprise). {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} {% note %} **Notes:** @@ -82,7 +82,7 @@ If you use {% data variables.product.prodname_ghe_cloud %}, you can also remove To remove a self-hosted runner from an enterprise, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/actions#self-hosted-runners). {% data reusables.actions.self-hosted-runner-reusing %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners.md index d295f2d640..01d03a2219 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners.md @@ -11,7 +11,7 @@ versions: type: tutorial shortTitle: Label runners --- - + {% data reusables.actions.enterprise-github-hosted-runners %} For information on how to use labels to route jobs to specific types of self-hosted runners, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow)." {% ifversion target-runner-groups %}You can also route jobs to runners in a specific group. For more information, see "[AUTOTITLE](/actions/using-jobs/choosing-the-runner-for-a-job#targeting-runners-in-a-group)."{% endif %} @@ -20,10 +20,10 @@ For information on how to use labels to route jobs to specific types of self-hos ## Creating a custom label -You can create custom labels for runners at the repository{% ifversion ghec or ghes or ghae %}, organization, and enterprise{% else %} and organization{% endif %} levels. +You can create custom labels for runners at the repository{% ifversion ghec or ghes %}, organization, and enterprise{% else %} and organization{% endif %} levels. - [Creating a custom label for a repository runner](#creating-a-custom-label-for-a-repository-runner) -- [Creating a custom label for an organization runner](#creating-a-custom-label-for-an-organization-runner){% ifversion ghec or ghes or ghae %} +- [Creating a custom label for an organization runner](#creating-a-custom-label-for-an-organization-runner){% ifversion ghec or ghes %} - [Creating a custom label for an enterprise runner](#creating-a-custom-label-for-an-enterprise-runner){% endif %} {% note %} @@ -42,7 +42,7 @@ You can create custom labels for runners at the repository{% ifversion ghec or g {% data reusables.actions.self-hosted-runner-navigate-to-org %} {% data reusables.actions.self-hosted-runners-create-label-steps %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ### Creating a custom label for an enterprise runner @@ -56,10 +56,10 @@ You can create custom labels for runners at the repository{% ifversion ghec or g ## Assigning a label to a self-hosted runner -You can assign labels to self-hosted runners at the repository{% ifversion ghec or ghes or ghae %}, organization, and enterprise{% else %} and organization{% endif %} levels. +You can assign labels to self-hosted runners at the repository{% ifversion ghec or ghes %}, organization, and enterprise{% else %} and organization{% endif %} levels. - [Assigning a label to a repository runner](#assigning-a-label-to-a-repository-runner) -- [Assigning a label to an organization runner](#assigning-a-label-to-an-organization-runner){% ifversion ghec or ghes or ghae %} +- [Assigning a label to an organization runner](#assigning-a-label-to-an-organization-runner){% ifversion ghec or ghes %} - [Assigning a label to an enterprise runner](#assigning-a-label-to-an-enterprise-runner){% endif %} ### Assigning a label to a repository runner @@ -72,7 +72,7 @@ You can assign labels to self-hosted runners at the repository{% ifversion ghec {% data reusables.actions.self-hosted-runner-navigate-to-org %} {% data reusables.actions.self-hosted-runner-assign-label-steps %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ### Assigning a label to an enterprise runner @@ -87,10 +87,10 @@ You can assign labels to self-hosted runners at the repository{% ifversion ghec ## Removing a custom label from a self-hosted runner -You can remove custom labels from self-hosted runners at the repository{% ifversion ghec or ghes or ghae %}, organization, and enterprise{% else %} and organization{% endif %} levels. +You can remove custom labels from self-hosted runners at the repository{% ifversion ghec or ghes %}, organization, and enterprise{% else %} and organization{% endif %} levels. - [Removing a custom label from a repository runner](#removing-a-custom-label-from-a-repository-runner) -- [Removing a custom label from an organization runner](#removing-a-custom-label-from-an-organization-runner){% ifversion ghec or ghes or ghae %} +- [Removing a custom label from an organization runner](#removing-a-custom-label-from-an-organization-runner){% ifversion ghec or ghes %} - [Removing a custom label from an enterprise runner](#removing-a-custom-label-from-an-enterprise-runner){% endif %} ### Removing a custom label from a repository runner @@ -103,7 +103,7 @@ You can remove custom labels from self-hosted runners at the repository{% ifvers {% data reusables.actions.self-hosted-runner-navigate-to-org %} {% data reusables.actions.self-hosted-runner-remove-label-steps %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ### Removing a custom label from an enterprise runner diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md index 9d6e8c13ac..e7e4f09982 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md @@ -13,7 +13,7 @@ versions: type: tutorial shortTitle: Use runners in a workflow --- - + {% data reusables.actions.enterprise-github-hosted-runners %} You can target self-hosted runners for use in a workflow based on the labels assigned to the runners{% ifversion target-runner-groups %}, or their group membership, or a combination of these{% endif %}. @@ -30,7 +30,7 @@ For information on creating custom and default labels, see "[AUTOTITLE](/actions ## About self-hosted runner groups -For self-hosted runners defined at the organization {% ifversion ghec or ghes or ghae %}or enterprise levels{% else %}level{% endif %}, you can group your runners with shared characteristics into a single runner group and then configure your job to target the runner group. +For self-hosted runners defined at the organization {% ifversion ghec or ghes %}or enterprise levels{% else %}level{% endif %}, you can group your runners with shared characteristics into a single runner group and then configure your job to target the runner group. To specify a self-hosted runner group for your job, configure `runs-on.group` in your workflow file. diff --git a/content/actions/learn-github-actions/understanding-github-actions.md b/content/actions/learn-github-actions/understanding-github-actions.md index c5b6886ab7..0a9884d808 100644 --- a/content/actions/learn-github-actions/understanding-github-actions.md +++ b/content/actions/learn-github-actions/understanding-github-actions.md @@ -36,7 +36,7 @@ You must host your own Linux, Windows, or macOS virtual machines to run workflow {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} For more information about introducing {% data variables.product.prodname_actions %} to your enterprise, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise)." @@ -90,7 +90,7 @@ For more information, see "[AUTOTITLE](/actions/creating-actions)." {% data reusables.actions.onboarding-next-steps %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Further reading diff --git a/content/actions/security-guides/security-hardening-for-github-actions.md b/content/actions/security-guides/security-hardening-for-github-actions.md index a6cf50188e..aa52061092 100644 --- a/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/content/actions/security-guides/security-hardening-for-github-actions.md @@ -389,7 +389,7 @@ If you are using {% data variables.product.prodname_actions %} to deploy to a cl ## Auditing {% data variables.product.prodname_actions %} events -You can use the security log to monitor activity for your user account and the audit log to monitor activity in your organization{% ifversion ghec or ghes or ghae %} or enterprise{% endif %}. The security and audit log records the type of action, when it was run, and which personal account performed the action. +You can use the security log to monitor activity for your user account and the audit log to monitor activity in your organization{% ifversion ghec or ghes %} or enterprise{% endif %}. The security and audit log records the type of action, when it was run, and which personal account performed the action. For example, you can use the audit log to track the `org.update_actions_secret` event, which tracks changes to organization secrets. diff --git a/content/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners.md b/content/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners.md index b65b1cc420..e1600c5053 100644 --- a/content/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners.md +++ b/content/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners.md @@ -40,7 +40,7 @@ For example, the following diagram has a runner group named `grp-ubuntu-20.04-16 {% data reusables.actions.hosted-runner-security-admonition %} {% data reusables.actions.creating-a-runner-group-for-an-organization %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Creating a runner group for an enterprise diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md index 66081beb6a..094e68cf17 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md @@ -128,7 +128,7 @@ If a policy is enabled for an enterprise, the policy can be selectively disabled {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.actions.private-repository-forks-configure %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Enforcing a policy for workflow permissions in your enterprise diff --git a/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md index a1c5fb5009..3432a2838b 100644 --- a/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -50,7 +50,7 @@ Name | Description -----|-----------|{% ifversion not ghae %} **`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes %} **`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/enterprise-admin).{% endif %} -**`repo`** | Grants full access to public{% ifversion ghec or ghes or ghae %}, internal,{% endif %} and private repositories including read and write access to code, commit statuses, repository invitations, collaborators, deployment statuses, and repository webhooks. **Note**: In addition to repository related resources, the `repo` scope also grants access to manage organization-owned resources including projects, invitations, team memberships and webhooks. This scope also grants the ability to manage projects owned by users. +**`repo`** | Grants full access to public{% ifversion ghec or ghes %}, internal,{% endif %} and private repositories including read and write access to code, commit statuses, repository invitations, collaborators, deployment statuses, and repository webhooks. **Note**: In addition to repository related resources, the `repo` scope also grants access to manage organization-owned resources including projects, invitations, team memberships and webhooks. This scope also grants the ability to manage projects owned by users.  `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses _without_ granting access to the code.  `repo_deployment`| Grants access to [deployment statuses](/rest/repos#deployments) for {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, _without_ granting access to the code.{% ifversion not ghae %}  `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %} diff --git a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md index 074d08b163..59c7fd1629 100644 --- a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md +++ b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md @@ -43,7 +43,7 @@ Both {% data variables.product.pat_v2 %}s and {% data variables.product.pat_v1_p {% ifversion pat-v2 %} -Organization owners can set a policy to restrict the access of {% data variables.product.pat_v1_plural %} to their organization{% ifversion ghec or ghes or ghae %}, and enterprise owners can restrict the access of {% data variables.product.pat_v1_plural %} to the enterprise or organizations owned by the enterprise{% endif %}. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization#restricting-access-by-personal-access-tokens-classic)." +Organization owners can set a policy to restrict the access of {% data variables.product.pat_v1_plural %} to their organization{% ifversion ghec or ghes %}, and enterprise owners can restrict the access of {% data variables.product.pat_v1_plural %} to the enterprise or organizations owned by the enterprise{% endif %}. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization#restricting-access-by-personal-access-tokens-classic)." {% endif %} @@ -55,7 +55,7 @@ Organization owners can set a policy to restrict the access of {% data variables - Each token can only access specific repositories. - Each token is granted specific permissions, which offer more control than the scopes granted to {% data variables.product.pat_v1_plural %}. - Each token must have an expiration date. -- Organization owners can require approval for any {% data variables.product.pat_v2 %}s that can access resources in the organization.{% ifversion ghec or ghes or ghae %} +- Organization owners can require approval for any {% data variables.product.pat_v2 %}s that can access resources in the organization.{% ifversion ghec or ghes %} - Enterprise owners can require approval for any {% data variables.product.pat_v2 %}s that can access resources in organizations owned by the enterprise.{% endif %} #### {% data variables.product.pat_v1_caps_plural %} diff --git a/content/billing/managing-the-plan-for-your-github-account/index.md b/content/billing/managing-the-plan-for-your-github-account/index.md index c09366ce10..0f2a84cf7f 100644 --- a/content/billing/managing-the-plan-for-your-github-account/index.md +++ b/content/billing/managing-the-plan-for-your-github-account/index.md @@ -1,7 +1,7 @@ --- title: Managing the plan for your GitHub account shortTitle: Manage your plan -intro: "{% ifversion fpt %}You can upgrade, downgrade, and view pending changes to your account's plan at any time.{% elsif ghec or ghes or ghae %}You can manage billing for {% data variables.product.product_name %}{% ifversion ghae %}.{% elsif ghec or ghes %} from your enterprise account on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}{% endif %}" +intro: "{% ifversion fpt %}You can upgrade, downgrade, and view pending changes to your account's plan at any time.{% elsif ghec or ghes %}You can manage billing for {% data variables.product.product_name %}{% ifversion ghae %}.{% elsif ghec or ghes %} from your enterprise account on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}{% endif %}" redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-your-github-account - /categories/97/articles diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md index 1638f6d358..ba4a684975 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md +++ b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md @@ -117,7 +117,7 @@ The `on:pull_request` and `on:push` triggers for code scanning are each useful f {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -1. To the right of "{% data variables.product.prodname_code_scanning_caps %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**.{% ifversion ghec or ghes or ghae %} If "{% data variables.product.prodname_code_scanning %} alerts" is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}.{% endif %} For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)" or "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." +1. To the right of "{% data variables.product.prodname_code_scanning_caps %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**.{% ifversion ghec or ghes %} If "{% data variables.product.prodname_code_scanning %} alerts" is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}.{% endif %} For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)" or "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." 1. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.code-scanning.codeql_workflow %} or on a third-party workflow. Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.code-scanning.codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository. diff --git a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 66b1c7cba4..c0650bb068 100644 --- a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -116,7 +116,7 @@ For more information, see "[Reviewing and fixing alerts](#reviewing-and-fixing-a You can view all open and closed {% data variables.product.prodname_dependabot_alerts %} and corresponding {% data variables.product.prodname_dependabot_security_updates %} in your repository's {% data variables.product.prodname_dependabot_alerts %} tab. You can sort and filter {% data variables.product.prodname_dependabot_alerts %} by selecting a filter from the dropdown menu. -{% ifversion ghec or ghes or ghae %}To view summaries of alerts for all or a subset of repositories owned by your organization, use security overview. For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview#about-security-overview-for-organizations)."{% endif %} +{% ifversion ghec or ghes %}To view summaries of alerts for all or a subset of repositories owned by your organization, use security overview. For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview#about-security-overview-for-organizations)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} diff --git a/content/code-security/getting-started/securing-your-organization.md b/content/code-security/getting-started/securing-your-organization.md index cf4b5caa45..33491b5c2e 100644 --- a/content/code-security/getting-started/securing-your-organization.md +++ b/content/code-security/getting-started/securing-your-organization.md @@ -35,7 +35,7 @@ Some security features have prerequisites. For example, {% data variables.produc Some features are {% ifversion fpt or ghec %}enabled by default in public repositories. In private repositories, some features are {% endif %}only available to enterprises that use {% data variables.product.prodname_GH_advanced_security %} and have enabled {% data variables.product.prodname_advanced_security %} as a feature for repositories. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security#about-advanced-security-features)." -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} {% note %} @@ -59,7 +59,7 @@ When you have decided to enable a security feature, the next step is to decide h When you have decided how to enable a feature for your organization's existing repositories, you must also decide how to handle any new repositories that are created in your organization in the future. For more information, see "[Enabling a feature for new repositories](#enabling-a-feature-for-future-repositories)." -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} For more information about creating a strategy for rolling out security features across a large organization or enterprise, see "[AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale)." {% endif %} @@ -138,7 +138,7 @@ You can use various tools to monitor the actions that your organization's member To help users report security vulnerabilities, you can create a default security policy that will display in any of your organization's public repositories that do not have their own security policy. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} Once your organization's security setup is in place, you may want to prevent users from changing the security settings in a repository. An enterprise owner can prevent repository administrators from enabling or disabling features in a repository. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." {% endif %} diff --git a/content/code-security/getting-started/securing-your-repository.md b/content/code-security/getting-started/securing-your-repository.md index 6c2dd02844..9eeceb80a4 100644 --- a/content/code-security/getting-started/securing-your-repository.md +++ b/content/code-security/getting-started/securing-your-repository.md @@ -81,7 +81,7 @@ For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-aler Dependency review lets you visualize dependency changes in pull requests before they are merged into your repositories. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." -Dependency review is a {% data variables.product.prodname_GH_advanced_security %} feature. {% ifversion fpt or ghec %}Dependency review is already enabled for all public repositories. {% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_advanced_security %} can additionally enable dependency review for private and internal repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/getting-started/securing-your-repository#managing-dependency-review). {% endif %}{% endif %}{% ifversion ghec or ghes or ghae %}To enable dependency review for a {% ifversion ghec %}private or internal {% endif %}repository, ensure that the dependency graph is enabled and enable {% data variables.product.prodname_GH_advanced_security %}. +Dependency review is a {% data variables.product.prodname_GH_advanced_security %} feature. {% ifversion fpt or ghec %}Dependency review is already enabled for all public repositories. {% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_advanced_security %} can additionally enable dependency review for private and internal repositories. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/getting-started/securing-your-repository#managing-dependency-review). {% endif %}{% endif %}{% ifversion ghec or ghes %}To enable dependency review for a {% ifversion ghec %}private or internal {% endif %}repository, ensure that the dependency graph is enabled and enable {% data variables.product.prodname_GH_advanced_security %}. 1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**. 1. Click **Security & analysis**. diff --git a/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md b/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md index be505f160f..8f0c86402e 100644 --- a/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md +++ b/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md @@ -25,7 +25,7 @@ shortTitle: Configure secret scans ## Enabling {% data variables.secret-scanning.user_alerts %} -You can enable {% data variables.secret-scanning.user_alerts %} for any {% ifversion fpt %}free public{% endif %} repository{% ifversion ghec or ghes or ghae %} that is owned by an organization{% else %} that you own{% endif %}. Once enabled, {% data reusables.secret-scanning.secret-scanning-process %}{% ifversion ghes < 3.11 %} {% data variables.product.prodname_secret_scanning_caps %} does not scan issues.{% endif %} {% data reusables.secret-scanning.what-is-scanned %} +You can enable {% data variables.secret-scanning.user_alerts %} for any {% ifversion fpt %}free public{% endif %} repository{% ifversion ghec or ghes %} that is owned by an organization{% else %} that you own{% endif %}. Once enabled, {% data reusables.secret-scanning.secret-scanning-process %}{% ifversion ghes < 3.11 %} {% data variables.product.prodname_secret_scanning_caps %} does not scan issues.{% endif %} {% data reusables.secret-scanning.what-is-scanned %} You can also enable {% data variables.product.prodname_secret_scanning %} for multiple repositories in an organization at the same time. For more information, see "[AUTOTITLE](/code-security/getting-started/securing-your-organization)." @@ -39,7 +39,7 @@ You can also enable {% data variables.product.prodname_secret_scanning %} for mu {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -{% data reusables.repositories.navigate-to-code-security-and-analysis %}{% ifversion ghec or ghes or ghae %} +{% data reusables.repositories.navigate-to-code-security-and-analysis %}{% ifversion ghec or ghes %} 1. If {% data variables.product.prodname_advanced_security %} is not already enabled for the repository, to the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. 1. Review the impact of enabling {% data variables.product.prodname_advanced_security %}, then click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository**. 1. When you enable {% data variables.product.prodname_advanced_security %}, {% data variables.product.prodname_secret_scanning %} may automatically be enabled for the repository due to the organization's settings. If "{% data variables.product.prodname_secret_scanning_caps %}" is shown with an **Enable** button, you still need to enable {% data variables.product.prodname_secret_scanning %} by clicking **Enable**. If you see a **Disable** button, {% data variables.product.prodname_secret_scanning %} is already enabled. diff --git a/content/code-security/secret-scanning/push-protection-for-repositories-and-organizations.md b/content/code-security/secret-scanning/push-protection-for-repositories-and-organizations.md index 5750eeb11a..f6be34e8f9 100644 --- a/content/code-security/secret-scanning/push-protection-for-repositories-and-organizations.md +++ b/content/code-security/secret-scanning/push-protection-for-repositories-and-organizations.md @@ -113,9 +113,9 @@ You can use the organization settings page for "Code security and analysis" to e ## Enabling push protection for a custom pattern -You can enable {% data variables.product.prodname_secret_scanning %} as a push protection for custom patterns stored at {% ifversion ghec or ghes or ghae %}the enterprise, organization, or repository level{% else%} the organization or repository level{% endif %}. +You can enable {% data variables.product.prodname_secret_scanning %} as a push protection for custom patterns stored at {% ifversion ghec or ghes %}the enterprise, organization, or repository level{% else%} the organization or repository level{% endif %}. -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ### Enabling push protection for a custom pattern stored in an enterprise diff --git a/content/code-security/security-overview/about-security-overview.md b/content/code-security/security-overview/about-security-overview.md index 3df701e787..dfd0ebd6a8 100644 --- a/content/code-security/security-overview/about-security-overview.md +++ b/content/code-security/security-overview/about-security-overview.md @@ -29,7 +29,7 @@ topics: {% data reusables.security-overview.about-security-overview %} {% ifversion fpt %}For more information, see [the {% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/security-overview/about-security-overview).{% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} {% note %} @@ -99,7 +99,7 @@ Each repository is shown in security overview with an indicator for each type of {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## About security overview for enterprises diff --git a/content/code-security/security-overview/filtering-alerts-in-security-overview.md b/content/code-security/security-overview/filtering-alerts-in-security-overview.md index 80adb9b00f..4fd19d10d0 100644 --- a/content/code-security/security-overview/filtering-alerts-in-security-overview.md +++ b/content/code-security/security-overview/filtering-alerts-in-security-overview.md @@ -26,7 +26,7 @@ redirect_from: ## About filtering security overview -You can use filters in a security overview to narrow your focus based on a range of factors, like alert risk level, alert type, and feature enablement. Different filters are available depending on the specific view{% ifversion ghec or ghes or ghae %} and whether you are viewing data at the enterprise or organization level{% endif %}. +You can use filters in a security overview to narrow your focus based on a range of factors, like alert risk level, alert type, and feature enablement. Different filters are available depending on the specific view{% ifversion ghec or ghes %} and whether you are viewing data at the enterprise or organization level{% endif %}. {% ifversion security-overview-displayed-alerts %} {% note %} diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md index 7b3e8bf7a0..324e695df6 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md +++ b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md @@ -140,7 +140,7 @@ Just like {% ifversion ghae %}the password for your IdP account{% else %}your ac Another option is to generate SSH keys on a hardware security key. You could use the same key you're using for 2FA. Hardware security keys are very difficult to compromise remotely, because the private SSH key remains on the hardware, and is not directly accessible from software. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key-for-a-hardware-security-key)." -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} Hardware-backed SSH keys are quite secure, but the hardware requirement might not work for some organizations. An alternative approach is to use SSH keys that are only valid for a short period of time, so even if the private key is compromised it can't be exploited for very long. This is the concept behind running your own SSH certificate authority. While this approach gives you a lot of control over how users authenticate, it also comes with the responsibility of maintaining an SSH certificate authority yourself. For more information, see "[AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)." {% endif %} diff --git a/content/get-started/learning-about-github/about-github-advanced-security.md b/content/get-started/learning-about-github/about-github-advanced-security.md index d63b49fa4a..21c0345bff 100644 --- a/content/get-started/learning-about-github/about-github-advanced-security.md +++ b/content/get-started/learning-about-github/about-github-advanced-security.md @@ -110,7 +110,7 @@ For more information on starter workflows, see "[AUTOTITLE](/code-security/code- {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Further reading diff --git a/content/organizations/collaborating-with-groups-in-organizations/best-practices-for-organizations.md b/content/organizations/collaborating-with-groups-in-organizations/best-practices-for-organizations.md index 8395a02630..ea74599459 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/best-practices-for-organizations.md +++ b/content/organizations/collaborating-with-groups-in-organizations/best-practices-for-organizations.md @@ -28,7 +28,7 @@ We highly recommend managing team membership through your identity provider (IdP We recommend keeping teams visible whenever possible and reserving secret teams for sensitive situations. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/changing-team-visibility)." -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Use security overview diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md index 70a60f7d62..f1a8b865c1 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md @@ -18,7 +18,7 @@ autogenerated: audit-logs **Notes**: {% ifversion ghes %} - This article contains the events available in the latest version of {% data variables.product.prodname_ghe_server %}. Some of the events may not be available in previous versions.{% endif %} -- This article contains the events that may appear in your organization's audit log. For the events that can appear in a user account's security log{% ifversion ghec or ghes or ghae %} or the audit log for an enterprise{% endif %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/security-log-events){% ifversion ghec or ghes or ghae %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)."{% else %}."{% endif %} +- This article contains the events that may appear in your organization's audit log. For the events that can appear in a user account's security log{% ifversion ghec or ghes %} or the audit log for an enterprise{% endif %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/security-log-events){% ifversion ghec or ghes %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)."{% else %}."{% endif %} - {% data reusables.webhooks.webhooks-as-audit-log-alternative %} {% endnote %} diff --git a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index eb63328aed..bea8ab8eea 100644 --- a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md +++ b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -13,7 +13,7 @@ topics: - Teams shortTitle: Disable or limit actions --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## About {% data variables.product.prodname_actions %} permissions for your organization @@ -26,7 +26,7 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} for ## Managing {% data variables.product.prodname_actions %} permissions for your organization -You can choose to disable {% data variables.product.prodname_actions %} for all repositories in your organization, or only allow specific repositories. You can also limit the use of public actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}, so that people can only use local actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} that exist in your {% ifversion ghec or ghes or ghae %}enterprise{% else %}organization{% endif %}. +You can choose to disable {% data variables.product.prodname_actions %} for all repositories in your organization, or only allow specific repositories. You can also limit the use of public actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}, so that people can only use local actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} that exist in your {% ifversion ghec or ghes %}enterprise{% else %}organization{% endif %}. {% note %} @@ -176,7 +176,7 @@ You can set the default permissions for the `GITHUB_TOKEN` in the settings for y ### Configuring the default `GITHUB_TOKEN` permissions {% ifversion actions-default-workflow-permissions-restrictive %} -By default, when you create a new organization,{% ifversion ghec or ghes or ghae %} the setting is inherited from what is configured in the enterprise settings.{% else %} `GITHUB_TOKEN` only has read access for the `contents` and `packages` scopes.{% endif %} +By default, when you create a new organization,{% ifversion ghec or ghes %} the setting is inherited from what is configured in the enterprise settings.{% else %} `GITHUB_TOKEN` only has read access for the `contents` and `packages` scopes.{% endif %} {% endif %} {% data reusables.profile.access_profile %} diff --git a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index 89ed928db9..4be23e8bbc 100644 --- a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -27,7 +27,7 @@ If you allow forking of private{% ifversion ghes or ghec or ghae %} and internal {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.profile.org_member_privileges %} -1. Under "Repository forking", select **Allow forking of private {% ifversion ghec or ghes or ghae %}and internal {% endif %}repositories**. +1. Under "Repository forking", select **Allow forking of private {% ifversion ghec or ghes %}and internal {% endif %}repositories**. {%- ifversion org-owners-limit-forks-creation %} 1. Optionally, if your organization is owned by an enterprise account, select a policy for where users are allowed to fork repositories. diff --git a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md index 61fff85ce1..aeba7a7e05 100644 --- a/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md +++ b/content/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization.md @@ -15,7 +15,7 @@ topics: shortTitle: Restrict repository creation --- -You can choose whether members and {% data variables.product.prodname_github_apps %} can create repositories in your organization. {% ifversion ghec or ghes or ghae %}If you allow members and {% data variables.product.prodname_github_apps %} to create repositories, you can choose which types of repositories they can create.{% elsif fpt %}If you allow members and {% data variables.product.prodname_github_apps %} to create repositories, you can choose whether they can create both public and private repositories or public repositories only.{% endif %} Organization owners can always create any type of repository. +You can choose whether members and {% data variables.product.prodname_github_apps %} can create repositories in your organization. {% ifversion ghec or ghes %}If you allow members and {% data variables.product.prodname_github_apps %} to create repositories, you can choose which types of repositories they can create.{% elsif fpt %}If you allow members and {% data variables.product.prodname_github_apps %} to create repositories, you can choose whether they can create both public and private repositories or public repositories only.{% endif %} Organization owners can always create any type of repository. {% ifversion fpt %} Organizations using {% data variables.product.prodname_ghe_cloud %} can also restrict members to creating private repositories only. For more information, see [the {% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization). diff --git a/content/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization.md index f7fafe6901..e4768bdfb9 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization.md @@ -14,7 +14,7 @@ Organization owners can view all {% data variables.product.pat_v2 %}s that can a When a token is revoked, the user who created the token will receive an email notification. -Organization owners can only view and revoke {% data variables.product.pat_v2 %}s, not {% data variables.product.pat_v1_plural %}. Unless the organization {% ifversion ghec or ghes or ghae %}or enterprise {% endif %}has restricted access by {% data variables.product.pat_v1_plural %}, any {% data variables.product.pat_v1 %} can access organization resources until the token expires. For more information about restricting access by {% data variables.product.pat_v1_plural %}, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)"{% ifversion ghec or ghes or ghae %} and "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise)"{% endif %}. +Organization owners can only view and revoke {% data variables.product.pat_v2 %}s, not {% data variables.product.pat_v1_plural %}. Unless the organization {% ifversion ghec or ghes %}or enterprise {% endif %}has restricted access by {% data variables.product.pat_v1_plural %}, any {% data variables.product.pat_v1 %} can access organization resources until the token expires. For more information about restricting access by {% data variables.product.pat_v1_plural %}, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)"{% ifversion ghec or ghes %} and "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise)"{% endif %}. {% ifversion ghec %} Organization owners can also view and revoke {% data variables.product.pat_v1_plural %} if their organization requires SAML single-sign on. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-authorized-credentials)". For more information about using the REST API to do this, see "[List SAML SSO authorizations for an organization](/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization)" and "[Remove a SAML SSO authorization for an organization](/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization)."{% endif %} diff --git a/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md index cc57dcec84..763e293bda 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization.md @@ -12,7 +12,7 @@ shortTitle: Set a token policy Organization owners can prevent {% data variables.product.pat_v2 %}s from accessing resources owned by the organization. {% data variables.product.pat_v2_caps %}s will still be able to read public resources within the organization. This setting only controls access by {% data variables.product.pat_v2 %}s, not {% data variables.product.pat_v1_plural %}. For more information about restricting access by {% data variables.product.pat_v1_plural %}, see "[Restricting access by {% data variables.product.pat_v1_plural %}](#restricting-access-by-personal-access-tokens-classic)" on this page. -{% ifversion ghec or ghes or ghae %} If your organization is owned by an enterprise, and your enterprise owner has restricted access by {% data variables.product.pat_v2 %}s, then you cannot override the policy in your organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise)."{% endif %} +{% ifversion ghec or ghes %} If your organization is owned by an enterprise, and your enterprise owner has restricted access by {% data variables.product.pat_v2 %}s, then you cannot override the policy in your organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise)."{% endif %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} @@ -26,7 +26,7 @@ Organization owners can prevent {% data variables.product.pat_v2 %}s from access Organization owners can require approval for each {% data variables.product.pat_v2 %} that can access the organization. {% data variables.product.pat_v2_caps %}s will still be able to read public resources within the organization without approval. {% data variables.product.pat_v2_caps %}s created by organization owners will not need approval. -{% ifversion ghec or ghes or ghae %} If your organization is owned by an enterprise, and your enterprise owner has set an approval policy for {% data variables.product.pat_v2 %}s, then you cannot override the policy in your organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise)."{% endif %} +{% ifversion ghec or ghes %} If your organization is owned by an enterprise, and your enterprise owner has set an approval policy for {% data variables.product.pat_v2 %}s, then you cannot override the policy in your organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise)."{% endif %} {% note %} @@ -46,7 +46,7 @@ Organization owners can require approval for each {% data variables.product.pat_ Organization owners can prevent {% data variables.product.pat_v1_plural %} from accessing resources owned by the organization. {% data variables.product.pat_v1_caps_plural %} will still be able to read public resources within the organization. This setting only controls access by {% data variables.product.pat_v1_plural %}, not {% data variables.product.pat_v2 %}s. For more information about restricting access by {% data variables.product.pat_v2 %}s, see "[Restricting access by {% data variables.product.pat_v2 %}s](#restricting-access-by-fine-grained-personal-access-tokens)" on this page. -{% ifversion ghec or ghes or ghae %} If your organization is owned by an enterprise, and your enterprise owner has restricted access by {% data variables.product.pat_v1_plural %}, then you cannot override the policy in your organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise)."{% endif %} +{% ifversion ghec or ghes %} If your organization is owned by an enterprise, and your enterprise owner has restricted access by {% data variables.product.pat_v1_plural %}, then you cannot override the policy in your organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise)."{% endif %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md index fa9c59b104..742aff444f 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md @@ -22,7 +22,7 @@ shortTitle: Convert member to collaborator You can convert a member of an organization to an outside collaborator. For more information about outside collaborators, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)." -{% ifversion fpt or ghec %}If the organization is owned by an enterprise, converting{% elsif ghes or ghae %}Converting{% endif %} an organization member to an outside collaborator may be restricted. For more information, see "[Enforcing repository management policies in your enterprise]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-{% ifversion fpt or ghec %}outside-{% endif %}collaborators-to-repositories){% ifversion ghec or ghes or ghae %}."{% elsif fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +{% ifversion fpt or ghec %}If the organization is owned by an enterprise, converting{% elsif ghes or ghae %}Converting{% endif %} an organization member to an outside collaborator may be restricted. For more information, see "[Enforcing repository management policies in your enterprise]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-{% ifversion fpt or ghec %}outside-{% endif %}collaborators-to-repositories){% ifversion ghec or ghes %}."{% elsif fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} {% data reusables.organizations.outside-collaborators-use-seats %} {% data reusables.organizations.outside_collaborator_forks %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md index f7e5525d4c..1d74e0daaa 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md @@ -32,7 +32,7 @@ From least access to most access, the roles for an organization repository are: {% ifversion fpt %} If your organization uses {% data variables.product.prodname_ghe_cloud %}, you can create custom repository roles. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization)" in the {% data variables.product.prodname_ghe_cloud %} documentation. -{% elsif ghec or ghes or ghae %} +{% elsif ghec or ghes %} You can create custom repository roles. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization)." {% endif %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/viewing-people-with-access-to-your-repository.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/viewing-people-with-access-to-your-repository.md index 304453f715..724f17ea45 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/viewing-people-with-access-to-your-repository.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/viewing-people-with-access-to-your-repository.md @@ -1,6 +1,6 @@ --- title: Viewing people with access to your repository -intro: 'You can view{% ifversion ghec or ghes or ghae %} and export{% endif %} a list of people with access to a repository within an organization.' +intro: 'You can view{% ifversion ghec or ghes %} and export{% endif %} a list of people with access to a repository within an organization.' redirect_from: - /articles/viewing-people-with-access-to-your-repository - /github/setting-up-and-managing-organizations-and-teams/viewing-people-with-access-to-your-repository @@ -30,7 +30,7 @@ Organizations that use {% data variables.product.prodname_ghe_cloud %} can also You can see a combined overview of teams and people with access to your repository in your repository settings. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository#about-access-management-for-repositories)." -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Exporting a list of people with access to your repository diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md index 76ae1dd1b6..68aa81a8d1 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks.md @@ -15,7 +15,7 @@ topics: {% data reusables.repositories.you-can-fork %} -If you fork a private repository that belongs to a personal account, external collaborators also get access to the fork. If you fork a private {% ifversion ghec or ghes or ghae %}or internal {% endif %}repository that belongs to an organization, teams within the organization get access to the fork, but external collaborators do not. You can add an external collaborator to the fork, but only if the external collaborator also has access to the upstream repository. +If you fork a private repository that belongs to a personal account, external collaborators also get access to the fork. If you fork a private {% ifversion ghec or ghes %}or internal {% endif %}repository that belongs to an organization, teams within the organization get access to the fork, but external collaborators do not. You can add an external collaborator to the fork, but only if the external collaborator also has access to the upstream repository. {% ifversion fpt or ghec %} @@ -23,7 +23,7 @@ If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %} {% endif %} -Organizations can allow or prevent the forking of any private repositories owned by the organization{% ifversion ghec or ghes or ghae %}, and enterprises can enforce policies to specify where members can create forks of private or internal repositories. Policies control the options available to the enterprise's organizations.{% endif %}. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization){% ifversion fpt %}."{% else %}" and "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-forking-private-or-internal-repositories)."{% endif %} +Organizations can allow or prevent the forking of any private repositories owned by the organization{% ifversion ghec or ghes %}, and enterprises can enforce policies to specify where members can create forks of private or internal repositories. Policies control the options available to the enterprise's organizations.{% endif %}. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization){% ifversion fpt %}."{% else %}" and "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-forking-private-or-internal-repositories)."{% endif %} ## About visibility of forks diff --git a/content/repositories/archiving-a-github-repository/archiving-repositories.md b/content/repositories/archiving-a-github-repository/archiving-repositories.md index 4097d20e1a..bc2308154d 100644 --- a/content/repositories/archiving-a-github-repository/archiving-repositories.md +++ b/content/repositories/archiving-a-github-repository/archiving-repositories.md @@ -27,7 +27,7 @@ topics: {% endnote %} {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} {% note %} **Note:** Customers who use {% data variables.product.prodname_GH_advanced_security %} can enable {% data variables.product.prodname_secret_scanning %} on archived repositories. For more information, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-private-repositories)." diff --git a/content/search-github/searching-on-github/searching-code.md b/content/search-github/searching-on-github/searching-code.md index b6b291ebf3..b1c7eadc15 100644 --- a/content/search-github/searching-on-github/searching-code.md +++ b/content/search-github/searching-on-github/searching-code.md @@ -7,7 +7,7 @@ redirect_from: - /github/searching-for-information-on-github/searching-code-for-exact-matches - /github/searching-for-information-on-github/searching-code - /github/searching-for-information-on-github/searching-on-github/searching-code -allowTitleToDifferFromFilename: true +allowTitleToDifferFromFilename: true versions: fpt: '*' ghec: '*' @@ -42,7 +42,7 @@ Due to the complexity of searching code, there are some restrictions on how sear - Only the _default branch_ is indexed for code search.{% ifversion fpt or ghec %} - Only files smaller than 384 KB are searchable.{% else %}* Only files smaller than 5 MB are searchable. - Only the first 500 KB of each file is searchable.{% endif %} -- Up to 4,000 private{% ifversion ghec or ghes or ghae %} and internal{% endif %} repositories are searchable. These 4,000 repositories will be the most recently updated of the first 10,000 private{% ifversion ghec or ghes or ghae %} and internal{% endif %} repositories that you have access to. +- Up to 4,000 private{% ifversion ghec or ghes %} and internal{% endif %} repositories are searchable. These 4,000 repositories will be the most recently updated of the first 10,000 private{% ifversion ghec or ghes %} and internal{% endif %} repositories that you have access to. - Only repositories with fewer than 500,000 files are searchable.{% ifversion fpt or ghec %} - Only repositories that have had activity or have been returned in search results in the last year are searchable.{% endif %} - Except with [`filename`](#search-by-filename) searches, you must always include at least one search term when searching source code. For example, searching for [`language:javascript`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ajavascript&type=Code&ref=searchresults) is not valid, while [`amazing language:javascript`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ajavascript&type=Code&ref=searchresults) is. diff --git a/content/support/contacting-github-support/viewing-and-updating-support-tickets.md b/content/support/contacting-github-support/viewing-and-updating-support-tickets.md index 076f936021..9fc56d84cf 100644 --- a/content/support/contacting-github-support/viewing-and-updating-support-tickets.md +++ b/content/support/contacting-github-support/viewing-and-updating-support-tickets.md @@ -16,7 +16,7 @@ topics: {% data reusables.support.zendesk-old-tickets %} -You can use the {% data variables.contact.contact_landing_page_portal %} to view current and past support tickets and respond to {% data variables.contact.github_support %}. After 120 days, resolved tickets are archived{% ifversion ghec or ghes or ghae %}, and archived tickets can only be viewed for enterprise accounts{% endif %}. +You can use the {% data variables.contact.contact_landing_page_portal %} to view current and past support tickets and respond to {% data variables.contact.github_support %}. After 120 days, resolved tickets are archived{% ifversion ghec or ghes %}, and archived tickets can only be viewed for enterprise accounts{% endif %}. Your capabilities in the {% data variables.contact.landing_page_portal %} depend on the account you select when you submit a ticket.{% ifversion ghes or ghec %} If you select an enterprise account, your role in the enterprise also affects your capabilities. @@ -31,7 +31,7 @@ Your capabilities in the {% data variables.contact.landing_page_portal %} depend ![Screenshot of a support ticket with the dropdown menu showing the options for translation highlighted with a dark orange outline.](/assets/images/help/support/support-ticket-translation-options.png) -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Viewing your archived support tickets diff --git a/content/support/learning-about-github-support/about-github-support.md b/content/support/learning-about-github-support/about-github-support.md index e6dd52d6e9..0e305a9c99 100644 --- a/content/support/learning-about-github-support/about-github-support.md +++ b/content/support/learning-about-github-support/about-github-support.md @@ -187,7 +187,7 @@ For urgent issues, we can help you in English 24 hours per day, 7 days per week, {% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Resolving and closing support tickets diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md b/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md index b66cfab664..c89959999f 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md @@ -35,7 +35,7 @@ If you are not receiving the webhook deliveries that you expect, you should iden ## Cannot have more than {% ifversion ghes %}250{% else %}20{% endif %} webhooks -You can create up to {% ifversion ghes %}250{% else %}20{% endif %} {% ifversion ghec or ghes or ghae %} repository, organization, or global {% else %} repository or organization {% endif %}webhooks for each event type. If you attempt to create more, you will receive an error stating that you cannot have more than {% ifversion ghes %}250{% else %}20{% endif %} webhooks. +You can create up to {% ifversion ghes %}250{% else %}20{% endif %} {% ifversion ghec or ghes %} repository, organization, or global {% else %} repository or organization {% endif %}webhooks for each event type. If you attempt to create more, you will receive an error stating that you cannot have more than {% ifversion ghes %}250{% else %}20{% endif %} webhooks. If you require more than {% ifversion ghes %}250{% else %}20{% endif %} webhooks, you can run a proxy that receives webhooks from {% data variables.product.company_short %} and forwards them to an unlimited number of destination URLs. diff --git a/content/webhooks/using-webhooks/disabling-webhooks.md b/content/webhooks/using-webhooks/disabling-webhooks.md index 384e513054..a05759e06b 100644 --- a/content/webhooks/using-webhooks/disabling-webhooks.md +++ b/content/webhooks/using-webhooks/disabling-webhooks.md @@ -46,7 +46,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface or th {% data reusables.webhooks.sidebar_webhooks %} {% data reusables.webhooks.disable_webhook %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} ## Disabling a global webhook for a {% data variables.product.prodname_enterprise %} diff --git a/data/reusables/actions/about-runner-groups.md b/data/reusables/actions/about-runner-groups.md index 6de21ebb50..eed0cdb674 100644 --- a/data/reusables/actions/about-runner-groups.md +++ b/data/reusables/actions/about-runner-groups.md @@ -1,4 +1,4 @@ -To control access to runners at the organization{% ifversion ghec or ghes or ghae %} and/or enterprise levels, enterprise and organization owners can use runner groups.{% else %} level, organizations using the {% data variables.product.prodname_team %} plan can use runner groups. {% endif %} +To control access to runners at the organization{% ifversion ghec or ghes %} and/or enterprise levels, enterprise and organization owners can use runner groups.{% else %} level, organizations using the {% data variables.product.prodname_team %} plan can use runner groups. {% endif %} Runner groups are used to collect sets of runners and create a security boundary around them. You can then decide which organizations or repositories are permitted to run jobs on those sets of machines. diff --git a/data/reusables/actions/actions-use-policy-settings.md b/data/reusables/actions/actions-use-policy-settings.md index 87f0512301..6dfff5f003 100644 --- a/data/reusables/actions/actions-use-policy-settings.md +++ b/data/reusables/actions/actions-use-policy-settings.md @@ -1,3 +1,3 @@ -If you choose {% data reusables.actions.policy-label-for-select-actions-workflows %}, actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} within your {% ifversion ghec or ghes or ghae %}enterprise{% else %}organization{% endif %} are allowed, and there are additional options for allowing other specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}. For more information, see "[Allowing select actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to run](#allowing-select-actions{% ifversion actions-workflow-policy %}-and-reusable-workflows{% endif %}-to-run)." +If you choose {% data reusables.actions.policy-label-for-select-actions-workflows %}, actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} within your {% ifversion ghec or ghes %}enterprise{% else %}organization{% endif %} are allowed, and there are additional options for allowing other specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}. For more information, see "[Allowing select actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to run](#allowing-select-actions{% ifversion actions-workflow-policy %}-and-reusable-workflows{% endif %}-to-run)." -{% ifversion ghec or fpt %}When you allow actions{% ifversion actions-workflow-policy %} and reusable workflows from only in{% else %} local to{% endif %} your {% ifversion ghec or ghes or ghae %}enterprise{% else %}organization{% endif %}, the policy blocks all access to actions authored by {% data variables.product.prodname_dotcom %}. For example, the [`actions/checkout`](https://github.com/actions/checkout) action would not be accessible.{% endif %} +{% ifversion ghec or fpt %}When you allow actions{% ifversion actions-workflow-policy %} and reusable workflows from only in{% else %} local to{% endif %} your {% ifversion ghec or ghes %}enterprise{% else %}organization{% endif %}, the policy blocks all access to actions authored by {% data variables.product.prodname_dotcom %}. For example, the [`actions/checkout`](https://github.com/actions/checkout) action would not be accessible.{% endif %} diff --git a/data/reusables/actions/disabling-github-actions.md b/data/reusables/actions/disabling-github-actions.md index 5600ce0f01..6890da6e1f 100644 --- a/data/reusables/actions/disabling-github-actions.md +++ b/data/reusables/actions/disabling-github-actions.md @@ -1 +1 @@ -By default, {% ifversion ghes %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.location.product_location %}, it{% elsif fpt or ghec %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit it to actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} in your {% ifversion ghec or ghes or ghae %}enterprise{% else %}organization{% endif %}. +By default, {% ifversion ghes %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.location.product_location %}, it{% elsif fpt or ghec %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit it to actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} in your {% ifversion ghec or ghes %}enterprise{% else %}organization{% endif %}. diff --git a/data/reusables/actions/policy-label-for-select-actions-workflows.md b/data/reusables/actions/policy-label-for-select-actions-workflows.md index fcd775467b..414398700f 100644 --- a/data/reusables/actions/policy-label-for-select-actions-workflows.md +++ b/data/reusables/actions/policy-label-for-select-actions-workflows.md @@ -1 +1 @@ -{% ifversion actions-workflow-policy %}{% ifversion ghec or ghes or ghae %}**Allow enterprise, and select non-enterprise, actions and reusable workflows**{% else %}**Allow _OWNER_, and select non-_OWNER_, actions and reusable workflows**{% endif %}{% else %}**Allow select actions**{% endif %} +{% ifversion actions-workflow-policy %}{% ifversion ghec or ghes %}**Allow enterprise, and select non-enterprise, actions and reusable workflows**{% else %}**Allow _OWNER_, and select non-_OWNER_, actions and reusable workflows**{% endif %}{% else %}**Allow select actions**{% endif %} diff --git a/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md b/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md index e6de7e0a0c..c6722e51f1 100644 --- a/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md +++ b/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md @@ -2,7 +2,7 @@ 1. Navigate to the main page of the organization where your self-hosted runner is registered. 1. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. {% data reusables.organizations.settings-sidebar-actions-runners %} -{% elsif ghec or ghes or ghae %} +{% elsif ghec or ghes %} 1. Navigate to where your runner is registered: - **In an organization**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. - **If using an enterprise-level runner**: diff --git a/data/reusables/audit_log/audit-log-search-list-info-about-action.md b/data/reusables/audit_log/audit-log-search-list-info-about-action.md index 711ee396a7..d91a0ce980 100644 --- a/data/reusables/audit_log/audit-log-search-list-info-about-action.md +++ b/data/reusables/audit_log/audit-log-search-list-info-about-action.md @@ -2,7 +2,7 @@ Each audit log entry shows applicable information about an event, such as: -- The {% ifversion ghec or ghes or ghae %}enterprise or {% endif %}organization an action was performed in +- The {% ifversion ghec or ghes %}enterprise or {% endif %}organization an action was performed in - The user (actor) who performed the action - The user affected by the action - Which repository an action was performed in diff --git a/data/reusables/security-overview/permissions.md b/data/reusables/security-overview/permissions.md index 561b614b11..f486a007fe 100644 --- a/data/reusables/security-overview/permissions.md +++ b/data/reusables/security-overview/permissions.md @@ -2,7 +2,7 @@ Security overview for an organization is available to all members of the organization. The views and data displayed are determined by your role in the organization, and by your permissions for individual repositories within the organization. {% ifversion security-overview-org-risk-coverage %}For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview#permission-to-view-data-in-security-overview)."{% endif %} -{% ifversion ghec or ghes or ghae %} +{% ifversion ghec or ghes %} Security overview for an enterprise shows organization owners and security managers data for the organizations they have access to. Enterprise owners can only view data for organizations where they are added as an organization owner or security manager. {% ifversion enterprise-owner-join-org %}For more information, see "[AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)."{% endif %} {% endif %} diff --git a/data/reusables/user-settings/pat-v2-org-opt-in.md b/data/reusables/user-settings/pat-v2-org-opt-in.md index 5a30e694f6..6433da4b61 100644 --- a/data/reusables/user-settings/pat-v2-org-opt-in.md +++ b/data/reusables/user-settings/pat-v2-org-opt-in.md @@ -2,6 +2,6 @@ **Note**: {% data reusables.user-settings.pat-v2-beta %} -During the beta, organizations must opt in to {% data variables.product.pat_v2 %}s. {% ifversion ghec or ghes or ghae %}If your organization is owned by an enterprise, and the enterprise has opted in to {% data variables.product.pat_v2 %}s, then your organization is opted in by default. {% endif %}If your organization has not already opted-in, then you will be prompted to opt-in and set policies when you follow the steps below. +During the beta, organizations must opt in to {% data variables.product.pat_v2 %}s. {% ifversion ghec or ghes %}If your organization is owned by an enterprise, and the enterprise has opted in to {% data variables.product.pat_v2 %}s, then your organization is opted in by default. {% endif %}If your organization has not already opted-in, then you will be prompted to opt-in and set policies when you follow the steps below. {% endnote %} diff --git a/data/reusables/user-settings/patv2-limitations.md b/data/reusables/user-settings/patv2-limitations.md index 94b268eb10..6661107f1a 100644 --- a/data/reusables/user-settings/patv2-limitations.md +++ b/data/reusables/user-settings/patv2-limitations.md @@ -1,7 +1,7 @@ {% data variables.product.pat_v1_caps_plural %} are less secure. However, some features currently will only work with {% data variables.product.pat_v1_plural %}: -- Only {% data variables.product.pat_v1_plural %} have write access for public repositories that are not owned by you or an organization that you are not a member of.{% ifversion ghec or ghes or ghae %} +- Only {% data variables.product.pat_v1_plural %} have write access for public repositories that are not owned by you or an organization that you are not a member of.{% ifversion ghec or ghes %} - Only {% data variables.product.pat_v1_plural %} automatically have write access for internal repositories that are owned by your enterprise. {% data variables.product.pat_v2_caps %}s must be granted access to internal repositories.{% endif %} -- Outside collaborators can only use {% data variables.product.pat_v1_plural %} to access organization repositories that they are a collaborator on.{% ifversion ghec or ghes or ghae %} +- Outside collaborators can only use {% data variables.product.pat_v1_plural %} to access organization repositories that they are a collaborator on.{% ifversion ghec or ghes %} - Only {% data variables.product.pat_v1_plural %} can access enterprises. ({% data variables.product.pat_v2_caps %} can access organizations owned by enterprises.){% endif %} - Some REST API operations are not available to {% data variables.product.pat_v2 %}s. For a list of REST API operations that are supported for {% data variables.product.pat_v2 %}s, see "[AUTOTITLE](/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens)". From edcae1c79d702a1f0a9fa3026aad32b70a29ef1d Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Wed, 24 Jan 2024 14:43:00 +0000 Subject: [PATCH 03/23] =?UTF-8?q?Fix=20Copilot=20for=20Docs=20docs=20issue?= =?UTF-8?q?s=20spotted=20by=20=E2=9C=A8=20@andyfeller=20=E2=9C=A8=20=20(#4?= =?UTF-8?q?8825)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> --- .../copilot-docset-management/creating-private-docsets.md | 2 +- .../overview/about-github-copilot-enterprise.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/content/copilot/github-copilot-enterprise/copilot-docset-management/creating-private-docsets.md b/content/copilot/github-copilot-enterprise/copilot-docset-management/creating-private-docsets.md index 86475d1f63..03ad65705b 100644 --- a/content/copilot/github-copilot-enterprise/copilot-docset-management/creating-private-docsets.md +++ b/content/copilot/github-copilot-enterprise/copilot-docset-management/creating-private-docsets.md @@ -17,7 +17,7 @@ To learn more about {% data variables.product.prodname_copilot_for_docs %} and h ## Creating a private docset -You can create a private docset from a single repository or a selection of repositories in your organization. You can create a docset from public or private repositories. Organization users will only have access to results from repositories they have read access to. +You can create a private docset from a single repository or a selection of repositories in your organization. You can create a docset from public, private, or internal repositories. Organization users will only have access to results from repositories they have read access to. {% data reusables.copilot.click-copilot-icon %} {% data reusables.copilot.copilot-immersive-mode %} diff --git a/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md b/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md index 6d9b4a230a..fd4fae8a4e 100644 --- a/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md +++ b/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md @@ -22,6 +22,7 @@ If {% data variables.product.prodname_copilot_enterprise_short %} is enabled for - {% data variables.product.prodname_copilot_chat_short %} (see "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat)") - {% data variables.product.prodname_copilot_for_prs %} (see "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries)") +- {% data variables.product.prodname_copilot_for_docs %} (see "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-docset-management/about-copilot-docset-management)") These features are in beta and subject to change. Additional features will be added to the {% data variables.product.prodname_copilot_enterprise_short %} offering over time. If you're taking part in the beta, you'll be notified when new features are added. From a2cba86302b1a1078e1360fc953ebe85f7a0a9df Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Wed, 24 Jan 2024 10:30:14 -0500 Subject: [PATCH 04/23] Remove GHAE in Liquid and front matter (9) (#48826) --- ...ng-access-to-self-hosted-runners-using-groups.md | 13 ++++++------- .../security-hardening-for-github-actions.md | 3 +-- .../actions/using-workflows/reusing-workflows.md | 9 ++++----- .../getting-started/securing-your-organization.md | 3 +-- .../about-github-advanced-security.md | 3 +-- ...y-and-analysis-settings-for-your-organization.md | 3 +-- ...ging-the-forking-policy-for-your-organization.md | 5 ++--- ...a-repository-is-deleted-or-changes-visibility.md | 3 +-- .../about-repositories.md | 3 +-- .../deleting-a-repository.md | 3 +-- .../setting-repository-visibility.md | 5 ++--- content/rest/actions/permissions.md | 2 +- .../searching-on-github/searching-commits.md | 2 +- .../searching-for-repositories.md | 3 +-- .../searching-issues-and-pull-requests.md | 3 +-- content/webhooks/about-webhooks.md | 3 +-- content/webhooks/types-of-webhooks.md | 5 ++--- .../webhooks/using-webhooks/creating-webhooks.md | 3 +-- data/reusables/actions/reusable-workflows.md | 2 +- .../workflows/required-workflow-source-notes.md | 4 ++-- .../workflows/required-workflow-target-notes.md | 2 +- 21 files changed, 33 insertions(+), 49 deletions(-) diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md index a342577b81..50446b904b 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial --- @@ -104,7 +103,7 @@ For runner groups in an organization, you can change what repositories in the or ## Changing the name of a runner group -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} You can edit the name of your runner groups at the enterprise and organization levels. - [Changing the name of an organization runner group](#changing-the-name-of-an-organization-runner-group) @@ -117,7 +116,7 @@ You can edit the name of your runner groups at the enterprise and organization l {% data reusables.actions.runner-groups-org-navigation %} {% data reusables.actions.changing-the-name-of-a-runner-group %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} ### Changing the name of an enterprise runner group @@ -132,7 +131,7 @@ You can edit the name of your runner groups at the enterprise and organization l ## Moving a self-hosted runner to a group {% data reusables.actions.about-moving-a-runner-to-a-group %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} - [Moving an organization runner to a group](#moving-an-organization-runner-to-a-group) - [Moving an enterprise runner to a group](#moving-an-enterprise-runner-to-a-group) @@ -146,7 +145,7 @@ You can edit the name of your runner groups at the enterprise and organization l {% data reusables.organizations.settings-sidebar-actions-runners %} {% data reusables.actions.moving-a-runner-to-a-group %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} ### Moving an enterprise runner to a group @@ -160,7 +159,7 @@ You can edit the name of your runner groups at the enterprise and organization l ## Removing a self-hosted runner group {% data reusables.actions.about-removing-a-runner-group %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} - [Removing a runner group from an organization](#removing-a-runner-group-from-an-organization) - [Removing a runner group from an enterprise](#removing-a-runner-group-from-an-enterprise) @@ -172,7 +171,7 @@ You can edit the name of your runner groups at the enterprise and organization l {% data reusables.actions.runner-groups-org-navigation %} {% data reusables.actions.removing-a-runner-group %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} ### Removing a runner group from an enterprise diff --git a/content/actions/security-guides/security-hardening-for-github-actions.md b/content/actions/security-guides/security-hardening-for-github-actions.md index aa52061092..702d4a4bd3 100644 --- a/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/content/actions/security-guides/security-hardening-for-github-actions.md @@ -8,7 +8,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: overview topics: @@ -232,7 +231,7 @@ You can use {% data variables.product.prodname_dependabot_version_updates %} to {% data reusables.actions.workflow-pr-approval-permissions-intro %} Allowing workflows, or any other automation, to {% ifversion allow-actions-to-approve-pr-with-ent-repo %}create or {% endif %}approve pull requests could be a security risk if the pull request is merged without proper oversight. -For more information on how to configure this setting, see {% ifversion allow-actions-to-approve-pr-with-ent-repo %}{% ifversion ghes or ghec or ghae %}"[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#preventing-github-actions-from-creating-or-approving-pull-requests)",{% endif %}{% endif %} "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-{% ifversion allow-actions-to-approve-pr-with-ent-repo %}creating-or-{% endif %}approving-pull-requests)"{% ifversion allow-actions-to-approve-pr-with-ent-repo %}, and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests)"{% endif %}. +For more information on how to configure this setting, see {% ifversion allow-actions-to-approve-pr-with-ent-repo %}{% ifversion ghes or ghec %}"[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#preventing-github-actions-from-creating-or-approving-pull-requests)",{% endif %}{% endif %} "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-{% ifversion allow-actions-to-approve-pr-with-ent-repo %}creating-or-{% endif %}approving-pull-requests)"{% ifversion allow-actions-to-approve-pr-with-ent-repo %}, and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests)"{% endif %}. {% endif %} ## Using OpenSSF Scorecards to secure workflows diff --git a/content/actions/using-workflows/reusing-workflows.md b/content/actions/using-workflows/reusing-workflows.md index 1b33946fb8..fa4d7cdd6a 100644 --- a/content/actions/using-workflows/reusing-workflows.md +++ b/content/actions/using-workflows/reusing-workflows.md @@ -8,7 +8,6 @@ versions: fpt: '*' ghec: '*' ghes: '*' - ghae: '>= 3.4' type: how_to topics: - Workflows @@ -51,9 +50,9 @@ For more information, see "[AUTOTITLE](/actions/using-workflows/creating-starter A reusable workflow can be used by another workflow if any of the following is true: - Both workflows are in the same repository. -- The called workflow is stored in a public repository{% ifversion actions-workflow-policy %}, and your {% ifversion ghec %}enterprise{% else %}organization{% endif %} allows you to use public reusable workflows{% endif %}.{% ifversion ghes or ghec or ghae %} +- The called workflow is stored in a public repository{% ifversion actions-workflow-policy %}, and your {% ifversion ghec %}enterprise{% else %}organization{% endif %} allows you to use public reusable workflows{% endif %}.{% ifversion ghes or ghec %} - The called workflow is stored in an internal repository and the settings for that repository allow it to be accessed. For more information, see {% ifversion internal-actions %}"[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise){% else %}"[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository){% endif %}."{% endif %}{% ifversion private-actions %} -- The called workflow is stored in a private repository and the settings for that repository allow it to be accessed. For more information, see {% ifversion ghes or ghec or ghae %}"[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)."{% else %}"[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-organization)" and "[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-from-your-private-repository)."{% endif %} +- The called workflow is stored in a private repository and the settings for that repository allow it to be accessed. For more information, see {% ifversion ghes or ghec %}"[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)."{% else %}"[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-organization)" and "[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-from-your-private-repository)."{% endif %} {% endif %} {% data reusables.actions.actions-redirects-workflows %} @@ -70,9 +69,9 @@ The assignment of {% data variables.product.prodname_dotcom %}-hosted runners is {% endif %} -Called workflows that are owned by the same user or organization{% ifversion ghes or ghec or ghae %} or enterprise{% endif %} as the caller workflow can access self-hosted runners from the caller's context. This means that a called workflow can access self-hosted runners that are: +Called workflows that are owned by the same user or organization{% ifversion ghes or ghec %} or enterprise{% endif %} as the caller workflow can access self-hosted runners from the caller's context. This means that a called workflow can access self-hosted runners that are: - In the caller repository -- In the caller repository's organization{% ifversion ghes or ghec or ghae %} or enterprise{% endif %}, provided that the runner has been made available to the caller repository +- In the caller repository's organization{% ifversion ghes or ghec %} or enterprise{% endif %}, provided that the runner has been made available to the caller repository ## Limitations diff --git a/content/code-security/getting-started/securing-your-organization.md b/content/code-security/getting-started/securing-your-organization.md index 33491b5c2e..83ceb6f76e 100644 --- a/content/code-security/getting-started/securing-your-organization.md +++ b/content/code-security/getting-started/securing-your-organization.md @@ -5,7 +5,6 @@ permissions: Organization owners and security managers can manage security featu versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: how_to topics: @@ -124,7 +123,7 @@ You can choose to enable a security feature automatically in all new repositorie When you have enabled a feature, you should communicate with repository administrators and contributors in your organization to assess the impact of the feature. You may need to adjust the configuration of some features at the repository level, or reassess the distribution of security features across your organization. You should also monitor the security alerts that a feature generates, and your members' responses to these alerts. -{% ifversion ghes or ghec or ghae %}You{% elsif fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %}{% endif %} can use security overview to see which teams and repositories are affected by security alerts, with a breakdown of alerts by severity. For more information, see{% ifversion ghes or ghec or ghae %} "[AUTOTITLE](/code-security/security-overview/assessing-code-security-risk)."{% elsif fpt %} "[AUTOTITLE](/enterprise-cloud@latest/code-security/security-overview/assessing-code-security-risk)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +{% ifversion ghes or ghec %}You{% elsif fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud %}{% endif %} can use security overview to see which teams and repositories are affected by security alerts, with a breakdown of alerts by severity. For more information, see{% ifversion ghes or ghec %} "[AUTOTITLE](/code-security/security-overview/assessing-code-security-risk)."{% elsif fpt %} "[AUTOTITLE](/enterprise-cloud@latest/code-security/security-overview/assessing-code-security-risk)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} {% ifversion security-overview-dashboard %} Security overview also has a dashboard (beta) where you can explore high-level trends and metrics to gain insight into your organization's security landscape. For more information, see "[AUTOTITLE](/code-security/security-overview/viewing-security-insights-for-your-organization)." diff --git a/content/get-started/learning-about-github/about-github-advanced-security.md b/content/get-started/learning-about-github/about-github-advanced-security.md index 21c0345bff..bbd4c14724 100644 --- a/content/get-started/learning-about-github/about-github-advanced-security.md +++ b/content/get-started/learning-about-github/about-github-advanced-security.md @@ -5,7 +5,6 @@ product: '{% data reusables.gated-features.ghas %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Security @@ -66,7 +65,7 @@ For information about {% data variables.product.prodname_advanced_security %} fe {% data variables.product.prodname_GH_advanced_security %} features are enabled for all public repositories on {% data variables.product.prodname_dotcom_the_website %}. Organizations that use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_advanced_security %} can additionally enable these features for private and internal repositories. {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security#enabling-advanced-security-features). {% endif %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} ## Deploying GitHub Advanced Security in your enterprise diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md index e003c6368f..673e16d231 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md @@ -9,7 +9,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Organizations @@ -63,7 +62,7 @@ You can use security overview to find a set of repositories and enable or disabl {% data reusables.advanced-security.note-org-enable-uses-seats %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} {% note %} **Note:** If you encounter an error that reads "GitHub Advanced Security cannot be enabled because of a policy setting for the organization," contact your enterprise admin and ask them to change the GitHub Advanced Security policy for your enterprise. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)." diff --git a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index 4be23e8bbc..7eae76a7bc 100644 --- a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -9,7 +9,6 @@ permissions: Organization owners can manage the forking policy for an organizati versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Organizations @@ -17,9 +16,9 @@ topics: shortTitle: Manage forking policy --- -By default, new organizations are configured to disallow the forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories. +By default, new organizations are configured to disallow the forking of private{% ifversion ghes or ghec %} and internal{% endif %} repositories. -If you allow forking of private{% ifversion ghes or ghec or ghae %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." +If you allow forking of private{% ifversion ghes or ghec %} and internal{% endif %} repositories at the organization level, you can also configure the ability to fork a specific private{% ifversion ghes or ghec %} or internal{% endif %} repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." {% ifversion org-owners-limit-forks-creation %} {% ifversion ghec %}If your organization is owned by an enterprise account, you{% else %}You{% endif %} may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-forking-private-or-internal-repositories)."{% endif %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index e9c50a3c0f..d79742b048 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Pull requests @@ -60,7 +59,7 @@ If a private repository is made public and then deleted, its private forks will {% endif %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} ## Changing the visibility of an internal repository diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md index d39bba944d..529ec20610 100644 --- a/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -14,7 +14,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Repositories @@ -95,7 +94,7 @@ Organization owners always have access to every repository created in an organiz People with admin permissions for a repository can change an existing repository's visibility. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} ## About internal repositories diff --git a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index cb4fe480f2..d691a21aa7 100644 --- a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Repositories @@ -24,7 +23,7 @@ topics: **Warnings**: - Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. -- Deleting a private{% ifversion ghes or ghec or ghae %} or internal{% endif %} repository will delete all forks of the repository. +- Deleting a private{% ifversion ghes or ghec %} or internal{% endif %} repository will delete all forks of the repository. {% endwarning %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index f270970cb5..7b762d5787 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -11,7 +11,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Repositories @@ -52,7 +51,7 @@ We recommend reviewing the following caveats before you change the visibility of {% ifversion fpt or ghes or ghec %} - {% data variables.product.product_name %} will detach public forks of the public repository and put them into a new network. Public forks are not made private.{% endif %} -{%- ifversion ghes or ghec or ghae %} +{%- ifversion ghes or ghec %} - If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% ifversion fpt or ghes or ghec %}The visibility of any forks will also change to private.{% elsif ghae %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)" {%- endif %} {%- ifversion fpt %} @@ -66,7 +65,7 @@ We recommend reviewing the following caveats before you change the visibility of - Anonymous Git read access is no longer available. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." {%- endif %} -{% ifversion ghes or ghec or ghae %} +{% ifversion ghes or ghec %} ### Making a repository internal diff --git a/content/rest/actions/permissions.md b/content/rest/actions/permissions.md index e777fa169f..35dbf06273 100644 --- a/content/rest/actions/permissions.md +++ b/content/rest/actions/permissions.md @@ -17,6 +17,6 @@ autogenerated: rest ## About permissions for {% data variables.product.prodname_actions %} -You can use the REST API to set permissions for the {% ifversion ghes or ghec or ghae %}enterprises, {% endif %}organizations and repositories that are allowed to run {% data variables.product.prodname_actions %}, and the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %} +You can use the REST API to set permissions for the {% ifversion ghes or ghec %}enterprises, {% endif %}organizations and repositories that are allowed to run {% data variables.product.prodname_actions %}, and the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %} diff --git a/content/search-github/searching-on-github/searching-commits.md b/content/search-github/searching-on-github/searching-commits.md index 8c221d2f76..5ad6c99f27 100644 --- a/content/search-github/searching-on-github/searching-commits.md +++ b/content/search-github/searching-on-github/searching-commits.md @@ -109,7 +109,7 @@ The `is` qualifier matches commits from repositories with the specified visibili {%- ifversion fpt or ghes or ghec %} | `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Commits) matches commits to public repositories. {%- endif %} -{%- ifversion ghes or ghec or ghae %} +{%- ifversion ghes or ghec %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Commits) matches commits to internal repositories. {%- endif %} | `is:private` | [**is:private**](https://github.com/search?q=is%3Aprivate&type=Commits) matches commits to private repositories. diff --git a/content/search-github/searching-on-github/searching-for-repositories.md b/content/search-github/searching-on-github/searching-for-repositories.md index 1448f9babf..f4d9a49018 100644 --- a/content/search-github/searching-on-github/searching-for-repositories.md +++ b/content/search-github/searching-on-github/searching-for-repositories.md @@ -9,7 +9,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - GitHub search @@ -150,7 +149,7 @@ You can filter your search based on the visibility of the repositories. For more | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} -| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% endif %}{% ifversion ghes or ghec %} | `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test".{% endif %} | `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) matches private repositories that you can access and contain the word "pages." diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 9d3b91717d..f614bb47b4 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -9,7 +9,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - GitHub search @@ -103,7 +102,7 @@ You can filter by the visibility of the repository containing the issues and pul | Qualifier | Example | ------------- | ------------- |{% ifversion fpt or ghes or ghec %} -| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion ghes or ghec or ghae %} +| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% endif %}{% ifversion ghes or ghec %} | `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %} | `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access. diff --git a/content/webhooks/about-webhooks.md b/content/webhooks/about-webhooks.md index b812d99a44..6bfd9b4221 100644 --- a/content/webhooks/about-webhooks.md +++ b/content/webhooks/about-webhooks.md @@ -18,7 +18,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Webhooks @@ -43,7 +42,7 @@ When you create a webhook, you specify a URL and subscribe to events that occur For example, you could subscribe your webhook to events that occur when code is pushed to a repository, a pull request is opened, a {% data variables.product.prodname_pages %} site is built, or a new member is added to a team. Your server could respond by deploying code to production, triggering a CI pipeline, sending a notification, or creating a {% data variables.product.company_short %} project for the new team member. -You must create a webhook within a specific repository, organization, {% ifversion ghes or ghec or ghae %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %}. The webhook can only access resources that are available in the repository, organization, {% ifversion ghes or ghec or ghae %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %} where it is installed. For more information, see "[AUTOTITLE](/webhooks/types-of-webhooks)." +You must create a webhook within a specific repository, organization, {% ifversion ghes or ghec %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %}. The webhook can only access resources that are available in the repository, organization, {% ifversion ghes or ghec %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %} where it is installed. For more information, see "[AUTOTITLE](/webhooks/types-of-webhooks)." For more information about creating webhooks, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks)." For more information about the types of events you can subscribe to, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads)." For more information about configuring your server to take an action in response to a payload delivery, see "[AUTOTITLE](/webhooks/using-webhooks/configuring-your-server-to-receive-payloads)." diff --git a/content/webhooks/types-of-webhooks.md b/content/webhooks/types-of-webhooks.md index aafca42ece..05cb216827 100644 --- a/content/webhooks/types-of-webhooks.md +++ b/content/webhooks/types-of-webhooks.md @@ -1,6 +1,6 @@ --- title: Types of webhooks -intro: 'You can create webhooks to subscribe to events that occur in a specific repository, organization, {% ifversion ghes or ghec or ghae %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %}.' +intro: 'You can create webhooks to subscribe to events that occur in a specific repository, organization, {% ifversion ghes or ghec %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %}.' redirect_from: - /webhooks-and-events/webhooks/about-webhooks-for-repositories - /webhooks/webhooks/about-webhooks-for-repositories @@ -8,7 +8,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Webhooks @@ -16,7 +15,7 @@ topics: ## About webhook types -A webhook can only access events that are available in the repository, organization, {% ifversion ghes or ghec or ghae %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %} where it is installed. +A webhook can only access events that are available in the repository, organization, {% ifversion ghes or ghec %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %} where it is installed. You cannot create webhooks for individual user accounts, or for events that are specific to user resources, like personal notifications or mentions. diff --git a/content/webhooks/using-webhooks/creating-webhooks.md b/content/webhooks/using-webhooks/creating-webhooks.md index a074bb1b4e..3b466bb0a6 100644 --- a/content/webhooks/using-webhooks/creating-webhooks.md +++ b/content/webhooks/using-webhooks/creating-webhooks.md @@ -12,7 +12,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Webhooks @@ -20,7 +19,7 @@ topics: ## About creating webhooks -You can create webhooks to subscribe to specific events on {% data variables.product.prodname_dotcom %} that occur in a repository, organization, {% ifversion ghes or ghec or ghae %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %}. +You can create webhooks to subscribe to specific events on {% data variables.product.prodname_dotcom %} that occur in a repository, organization, {% ifversion ghes or ghec %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %}. For more information about the different types of webhooks, see "[AUTOTITLE](/webhooks/types-of-webhooks)." diff --git a/data/reusables/actions/reusable-workflows.md b/data/reusables/actions/reusable-workflows.md index eac1d7e0e4..05d9291315 100644 --- a/data/reusables/actions/reusable-workflows.md +++ b/data/reusables/actions/reusable-workflows.md @@ -1 +1 @@ -{% ifversion ghes or ghec or ghae %}You can share workflows with your organization, publicly or privately, by calling{% else %} You can call{% endif %} one workflow from within another workflow. This allows you to reuse workflows, avoiding duplication and making your workflows easier to maintain. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)." +{% ifversion ghes or ghec %}You can share workflows with your organization, publicly or privately, by calling{% else %} You can call{% endif %} one workflow from within another workflow. This allows you to reuse workflows, avoiding duplication and making your workflows easier to maintain. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)." diff --git a/data/reusables/actions/workflows/required-workflow-source-notes.md b/data/reusables/actions/workflows/required-workflow-source-notes.md index 5326d2ad8d..d5869655eb 100644 --- a/data/reusables/actions/workflows/required-workflow-source-notes.md +++ b/data/reusables/actions/workflows/required-workflow-source-notes.md @@ -1,6 +1,6 @@ - Required workflows can be stored in any repository folder and are not restricted to the `.github/workflows` folder like normal workflows. If a required workflow calls a reusable workflow, the reusable workflow must be stored in the `.github/workflows` folder. When calling a reusable workflow, a required workflow must use the full path and ref to the reusable workflow. For example, `{owner}/{repo}/.github/workflows/{filename}@{ref}`. -- If the required workflow is contained in a private {% ifversion ghes or ghec or ghae %}or internal {% endif %}repository, you must ensure that workflows within the repository are accessible by other repositories in your organization. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-access-for-a-private-repository){% ifversion ghes or ghec or ghae %}" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository){% endif %}." -- Workflows stored in a public repository can be configured as required workflows for any repository in your organization. Workflows stored in a private repository can only be configured as required workflows for other private repositories in your organization. {% ifversion ghes or ghec or ghae %} Workflows stored in internal repositories can be configured as required workflows for internal and private repositories in your organization.{% endif %} +- If the required workflow is contained in a private {% ifversion ghes or ghec %}or internal {% endif %}repository, you must ensure that workflows within the repository are accessible by other repositories in your organization. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-access-for-a-private-repository){% ifversion ghes or ghec %}" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository){% endif %}." +- Workflows stored in a public repository can be configured as required workflows for any repository in your organization. Workflows stored in a private repository can only be configured as required workflows for other private repositories in your organization. {% ifversion ghes or ghec %} Workflows stored in internal repositories can be configured as required workflows for internal and private repositories in your organization.{% endif %} - {% data variables.product.prodname_codeql %} is not supported in required workflows because {% data variables.product.prodname_codeql %} requires configuration at the repository level. For information on configuring code scanning, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning)." {% ifversion actions-required-workflow-improvements %} {% ifversion fpt or ghec %} diff --git a/data/reusables/actions/workflows/required-workflow-target-notes.md b/data/reusables/actions/workflows/required-workflow-target-notes.md index 620f045894..67a8c84062 100644 --- a/data/reusables/actions/workflows/required-workflow-target-notes.md +++ b/data/reusables/actions/workflows/required-workflow-target-notes.md @@ -1,3 +1,3 @@ -- When configuring a required workflow to run on all or selected repositories, the visibility of the repository containing the required workflow will affect which repositories in your organization the workflow runs on. Required workflows stored in public repositories will run on all repositories. Required workflows stored in private repositories will only run on other private repositories. {% ifversion ghes or ghec or ghae %} Required workflows stored in internal repositories will run on internal and private repositories.{% endif %} +- When configuring a required workflow to run on all or selected repositories, the visibility of the repository containing the required workflow will affect which repositories in your organization the workflow runs on. Required workflows stored in public repositories will run on all repositories. Required workflows stored in private repositories will only run on other private repositories. {% ifversion ghes or ghec %} Required workflows stored in internal repositories will run on internal and private repositories.{% endif %} - Required workflows cannot be configured to run in the repository the workflow is created in. You should consider creating a separate repository to store your required workflows. - When configuring a required workflow to run on all or selected repositories, required workflows will not run in repositories where actions is disabled in the organization settings. From f2fdfe42b462517d836f5a6ec88fed66efdda9af Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 24 Jan 2024 10:35:18 -0600 Subject: [PATCH 05/23] Update audit log event data (#48833) --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 561d9a7709..828646e4f5 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -1,4 +1,4 @@ { "apiOnlyEventsAdditionalDescription": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "sha": "b5bbe6c2aa628a381e44765b7a9deba2bba4bc7f" + "sha": "03f0454dd848696065d9a331a0749a954858628c" } \ No newline at end of file From 369fbeccc50cf036a0113b4c63726612105f497e Mon Sep 17 00:00:00 2001 From: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Date: Wed, 24 Jan 2024 09:44:20 -0700 Subject: [PATCH 06/23] Enterprise bug fix hour for week of January 8, 2024 (#48635) Co-authored-by: Brian Co-authored-by: Stacy Carter Co-authored-by: Matt Pollard --- .../command-line-utilities.md | 4 ++++ .../managing-access-to-the-management-console.md | 8 ++++---- ...-visual-studio-subscriptions-with-github-enterprise.md | 6 ++++++ .../unlocking-management-console-with-shell.md | 2 +- 4 files changed, 15 insertions(+), 5 deletions(-) diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md index e427b55ebe..305c87dc19 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md @@ -895,12 +895,16 @@ This utility manually repackages a repository network to optimize pack storage. You can add the optional `--prune` argument to remove unreachable Git objects that aren't referenced from a branch, tag, or any other ref. This is particularly useful for immediately removing [previously expunged sensitive information](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository). +{% ifversion ghes < 3.9 %} + {% warning %} **Warning**: Before using the `--prune` argument to remove unreachable Git objects, put {% data variables.location.product_location %} into maintenance mode, or ensure all repositories within the same repository network are locked. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)" and "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/locking-a-repository)." {% endwarning %} +{% endif %} + ```shell ghe-repo-gc USERNAME/REPONAME ``` diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console.md b/content/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console.md index 666ee84411..a3f95ef287 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-access-to-the-management-console.md @@ -71,14 +71,14 @@ If you have not configured email notifications for {% data variables.location.pr ## Configuring rate limits for authentication to the {% data variables.enterprise.management_console %} -You can configure the lockout time and login attempt limits for the {% data variables.enterprise.management_console %}. If you configure rate limits, the limits apply to both the root site administrator and any {% data variables.enterprise.management_console %} users. +You can configure the lockout time and login attempt limits for the {% data variables.enterprise.management_console %}. -After you configure rate limits and a user exceeds the limit, the {% data variables.enterprise.management_console %} will remain locked for the duration set by the lockout time. {% data reusables.enterprise_management_console.unlocking-management-console-with-shell %} +After you configure rate limits and a {% data variables.enterprise.management_console %} user exceeds the limit, the {% data variables.enterprise.management_console %} will remain locked for the duration set by the lockout time. {% data reusables.enterprise_management_console.unlocking-management-console-with-shell %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} -1. Optionally, under "Lockout time", type a number of minutes to lock the {% data variables.enterprise.management_console %} after too many failed login attempts. -1. Optionally, under "Login attempt limit", type a maximum number of failed login attempts to allow before the {% data variables.enterprise.management_console %} is locked. +1. Optionally, under "Lockout time for Management Console users", type a number of minutes to lock the {% data variables.enterprise.management_console %} after too many failed login attempts. When locked out, the root site administrator must be manually unlocked. +1. Optionally, under "Login attempt limit for all users", type a maximum number of failed login attempts to allow before the {% data variables.enterprise.management_console %} is locked. {% data reusables.enterprise_management_console.save-settings %} {% endif %} diff --git a/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md b/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md index c4ce05bf0b..67227be874 100644 --- a/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md +++ b/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md @@ -31,6 +31,12 @@ For more information about the setup of {% data variables.visual_studio.prodname After you assign a license for {% data variables.visual_studio.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a personal account on {% data variables.product.prodname_dotcom_the_website %}. If the verified email address for the personal account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.visual_studio.prodname_vss_ghe %}. +{% note %} + +**Note:** To make sure that a {% data variables.product.prodname_emus %} account consumes a {% data variables.product.prodname_vs %} license, either the email address associated with the {% data variables.product.prodname_dotcom %} account or the SCIM `userName` attribute value from the linked identity must match the UPN. + +{% endnote %} + The total quantity of your licenses for your enterprise on {% data variables.product.prodname_dotcom %} is the sum of any standard {% data variables.product.prodname_enterprise %} licenses and the number of {% data variables.product.prodname_vs %} subscription licenses that include access to {% data variables.product.prodname_dotcom %}. If the personal account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the personal account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber. For more information about {% data variables.product.prodname_enterprise %}, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans#github-enterprise)." For more information about accounts on {% data variables.product.prodname_dotcom_the_website %}, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)." diff --git a/data/reusables/enterprise_management_console/unlocking-management-console-with-shell.md b/data/reusables/enterprise_management_console/unlocking-management-console-with-shell.md index 1b8060bffe..867f3f5e41 100644 --- a/data/reusables/enterprise_management_console/unlocking-management-console-with-shell.md +++ b/data/reusables/enterprise_management_console/unlocking-management-console-with-shell.md @@ -1 +1 @@ -To immediately unlock access to the {% data variables.enterprise.management_console %}{% ifversion enterprise-management-console-multi-user-auth %} by the root site administrator{% endif %}, use the `ghe-reactivate-admin-login` command via the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-reactivate-admin-login)" and "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." +If the root site administrator's {% data variables.enterprise.management_console %} login is locked, someone with administrative SSH access must unlock the login. To immediately unlock access to the {% data variables.enterprise.management_console %}{% ifversion enterprise-management-console-multi-user-auth %} by the root site administrator{% endif %}, use the `ghe-reactivate-admin-login` command via the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-reactivate-admin-login)" and "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." From ab5e0d16dba7c6f66f5df06c935142deb1303241 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Wed, 24 Jan 2024 11:57:21 -0500 Subject: [PATCH 07/23] Don't say that @ has to be capitalized (#48832) --- .../lib/linting-rules/list-first-word-capitalization.js | 3 ++- .../tests/unit/list-first-word-captitalization.js | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/content-linter/lib/linting-rules/list-first-word-capitalization.js b/src/content-linter/lib/linting-rules/list-first-word-capitalization.js index f19b566b89..3d84649dec 100644 --- a/src/content-linter/lib/linting-rules/list-first-word-capitalization.js +++ b/src/content-linter/lib/linting-rules/list-first-word-capitalization.js @@ -36,7 +36,8 @@ export const listFirstWordCapitalization = { if (firstWord.startsWith('[{%') || firstWord.startsWith('{%') || firstWord.startsWith('{{')) return // If the first letter is capitalized, it's not an error - if (/[A-Z]/.test(firstWord[0])) return + // And any special characters (like @) that can't be capitalized + if (/[A-Z@]/.test(firstWord[0])) return // There are items that start with a number or words that contain numbers // e.g., x64 if (/\d/.test(firstWord)) return diff --git a/src/content-linter/tests/unit/list-first-word-captitalization.js b/src/content-linter/tests/unit/list-first-word-captitalization.js index d596346b86..510a5b23ad 100644 --- a/src/content-linter/tests/unit/list-first-word-captitalization.js +++ b/src/content-linter/tests/unit/list-first-word-captitalization.js @@ -51,6 +51,8 @@ describe(listFirstWordCapitalization.names.join(' - '), () => { '- {% data variables.product.prodname_dotcom_the_website %} Services Continuity and Incident Management Plan', '- {% data variables.product.prodname_dotcom_the_website %} Services Continuity and Incident Management Plan', '- x64', + '- @mention your friends', + '- @hash tags', '- 05:00', ].join('\n') const result = await runRule(listFirstWordCapitalization, { strings: { markdown } }) From 01b9402db4827ddf15dc30915d98f81c2d4fc507 Mon Sep 17 00:00:00 2001 From: Janella Co <106457244+janellaco@users.noreply.github.com> Date: Wed, 24 Jan 2024 13:13:30 -0500 Subject: [PATCH 08/23] Update Stripe API Key validity check (#48817) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- data/secret-scanning.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/secret-scanning.yml b/data/secret-scanning.yml index 37fa026eaa..3aae8efa74 100644 --- a/data/secret-scanning.yml +++ b/data/secret-scanning.yml @@ -2512,7 +2512,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' - provider: 'Stripe' supportedSecret: 'Stripe Legacy API Secret Key' From 313ac6827bdcd47ae76c53819ede3e3419f53cbf Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Wed, 24 Jan 2024 13:24:28 -0500 Subject: [PATCH 09/23] Use Node 20.11.0 in Docker (#48835) --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 99e0e41523..b33be2b956 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,7 +5,7 @@ # -------------------------------------------------------------------------------- # To update the sha, run `docker pull node:$VERSION-alpine` # look for something like: `Digest: sha256:0123456789abcdef` -FROM node:20-alpine@sha256:9e38d3d4117da74a643f67041c83914480b335c3bd44d37ccf5b5ad86cd715d1 as base +FROM node:20-alpine@sha256:8e6a472eb9742f4f486ca9ef13321b7fc2e54f2f60814f339eeda2aff3037573 as base # This directory is owned by the node user ARG APP_HOME=/home/node/app From 662b07f6570292ae8bbf7aa953405e4dfc9b17a3 Mon Sep 17 00:00:00 2001 From: David Jarzebowski Date: Wed, 24 Jan 2024 13:41:15 -0500 Subject: [PATCH 10/23] Document a new known issue about HAProxy out-of-memory errors (#48818) Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> --- data/release-notes/enterprise-server/3-10/0.yml | 2 ++ data/release-notes/enterprise-server/3-10/1.yml | 2 ++ data/release-notes/enterprise-server/3-10/2.yml | 2 ++ data/release-notes/enterprise-server/3-10/3.yml | 2 ++ data/release-notes/enterprise-server/3-10/4.yml | 2 ++ data/release-notes/enterprise-server/3-10/5.yml | 2 ++ data/release-notes/enterprise-server/3-11/0.yml | 2 ++ data/release-notes/enterprise-server/3-11/1.yml | 2 ++ data/release-notes/enterprise-server/3-11/2.yml | 2 ++ data/release-notes/enterprise-server/3-11/3.yml | 2 ++ data/release-notes/enterprise-server/3-9/0.yml | 2 ++ data/release-notes/enterprise-server/3-9/1.yml | 2 ++ data/release-notes/enterprise-server/3-9/2.yml | 2 ++ data/release-notes/enterprise-server/3-9/3.yml | 2 ++ data/release-notes/enterprise-server/3-9/4.yml | 2 ++ data/release-notes/enterprise-server/3-9/5.yml | 2 ++ data/release-notes/enterprise-server/3-9/6.yml | 2 ++ data/release-notes/enterprise-server/3-9/7.yml | 2 ++ data/release-notes/enterprise-server/3-9/8.yml | 2 ++ data/reusables/release-notes/2024-01-ha-proxy-out-of-memory.md | 1 + 20 files changed, 39 insertions(+) create mode 100644 data/reusables/release-notes/2024-01-ha-proxy-out-of-memory.md diff --git a/data/release-notes/enterprise-server/3-10/0.yml b/data/release-notes/enterprise-server/3-10/0.yml index d42a48c6bb..363c8999d7 100644 --- a/data/release-notes/enterprise-server/3-10/0.yml +++ b/data/release-notes/enterprise-server/3-10/0.yml @@ -306,6 +306,8 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] deprecations: # https://github.com/github/releases/issues/2605 diff --git a/data/release-notes/enterprise-server/3-10/1.yml b/data/release-notes/enterprise-server/3-10/1.yml index 1e7c872f04..d9551e973a 100644 --- a/data/release-notes/enterprise-server/3-10/1.yml +++ b/data/release-notes/enterprise-server/3-10/1.yml @@ -75,3 +75,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-10/2.yml b/data/release-notes/enterprise-server/3-10/2.yml index aa19a03fdb..c1571c9262 100644 --- a/data/release-notes/enterprise-server/3-10/2.yml +++ b/data/release-notes/enterprise-server/3-10/2.yml @@ -52,3 +52,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-10/3.yml b/data/release-notes/enterprise-server/3-10/3.yml index d309de3627..019c8974a7 100644 --- a/data/release-notes/enterprise-server/3-10/3.yml +++ b/data/release-notes/enterprise-server/3-10/3.yml @@ -91,3 +91,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-10/4.yml b/data/release-notes/enterprise-server/3-10/4.yml index 9ee26d00a3..d9a62332ae 100644 --- a/data/release-notes/enterprise-server/3-10/4.yml +++ b/data/release-notes/enterprise-server/3-10/4.yml @@ -170,6 +170,8 @@ sections: Restoring backups with `ghe-restore` on a GHES cluster will exit prematurely if `redis` has not restarted properly. - | {% data reusables.release-notes.2024-01-haproxy-upgrade-causing-increased-errors %} [Updated 2024-01-03] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] deprecations: - heading: Interactive maps in the web UI no longer allow authentication using an Azure Maps API key notes: diff --git a/data/release-notes/enterprise-server/3-10/5.yml b/data/release-notes/enterprise-server/3-10/5.yml index df76226d44..fe82e5508c 100644 --- a/data/release-notes/enterprise-server/3-10/5.yml +++ b/data/release-notes/enterprise-server/3-10/5.yml @@ -66,3 +66,5 @@ sections: Restoring backups with `ghe-restore` on a GHES cluster will exit prematurely if `redis` has not restarted properly. - | {% data reusables.release-notes.2024-01-haproxy-upgrade-causing-increased-errors %} + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-11/0.yml b/data/release-notes/enterprise-server/3-11/0.yml index f3926c146f..2e78b6b472 100644 --- a/data/release-notes/enterprise-server/3-11/0.yml +++ b/data/release-notes/enterprise-server/3-11/0.yml @@ -331,6 +331,8 @@ sections: {% data reusables.release-notes.2023-10-git-push-made-but-not-registered %} - | {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] deprecations: # https://github.com/github/releases/issues/3259 diff --git a/data/release-notes/enterprise-server/3-11/1.yml b/data/release-notes/enterprise-server/3-11/1.yml index 3ab4163fa2..bbdcca58a6 100644 --- a/data/release-notes/enterprise-server/3-11/1.yml +++ b/data/release-notes/enterprise-server/3-11/1.yml @@ -108,6 +108,8 @@ sections: Restoring backups with `ghe-restore` on a GHES cluster will exit prematurely if `redis` has not restarted properly. - | {% data reusables.release-notes.2024-01-haproxy-upgrade-causing-increased-errors %} [Updated 2024-01-03] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] deprecations: - heading: Interactive maps in the web UI no longer allow authentication using an Azure Maps API key notes: diff --git a/data/release-notes/enterprise-server/3-11/2.yml b/data/release-notes/enterprise-server/3-11/2.yml index 9a269718fc..395484aac0 100644 --- a/data/release-notes/enterprise-server/3-11/2.yml +++ b/data/release-notes/enterprise-server/3-11/2.yml @@ -27,3 +27,5 @@ sections: Restoring backups with `ghe-restore` on a GHES cluster will exit prematurely if `redis` has not restarted properly. - | {% data reusables.release-notes.2024-01-haproxy-upgrade-causing-increased-errors %} [Updated 2024-01-03] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-11/3.yml b/data/release-notes/enterprise-server/3-11/3.yml index 9df8f85f7a..e7a1239cb2 100644 --- a/data/release-notes/enterprise-server/3-11/3.yml +++ b/data/release-notes/enterprise-server/3-11/3.yml @@ -50,3 +50,5 @@ sections: {% data reusables.release-notes.2024-01-haproxy-upgrade-causing-increased-errors %} - | Pre-receive hooks which utilize `git rev-list` fail with an `fatal: Invalid revision range` error message. + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-9/0.yml b/data/release-notes/enterprise-server/3-9/0.yml index 4160837f1a..034f2a0a96 100644 --- a/data/release-notes/enterprise-server/3-9/0.yml +++ b/data/release-notes/enterprise-server/3-9/0.yml @@ -447,6 +447,8 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] deprecations: # https://github.com/github/releases/issues/2826 diff --git a/data/release-notes/enterprise-server/3-9/1.yml b/data/release-notes/enterprise-server/3-9/1.yml index a2f2e08844..4b84a50fc5 100644 --- a/data/release-notes/enterprise-server/3-9/1.yml +++ b/data/release-notes/enterprise-server/3-9/1.yml @@ -167,3 +167,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-9/2.yml b/data/release-notes/enterprise-server/3-9/2.yml index 0e2310d8c3..b71a7cf0a3 100644 --- a/data/release-notes/enterprise-server/3-9/2.yml +++ b/data/release-notes/enterprise-server/3-9/2.yml @@ -82,3 +82,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-9/3.yml b/data/release-notes/enterprise-server/3-9/3.yml index b6ca2962e6..e541de846b 100644 --- a/data/release-notes/enterprise-server/3-9/3.yml +++ b/data/release-notes/enterprise-server/3-9/3.yml @@ -78,3 +78,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-9/4.yml b/data/release-notes/enterprise-server/3-9/4.yml index 4293188b9b..8d7f81ade7 100644 --- a/data/release-notes/enterprise-server/3-9/4.yml +++ b/data/release-notes/enterprise-server/3-9/4.yml @@ -66,3 +66,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-9/5.yml b/data/release-notes/enterprise-server/3-9/5.yml index 5b3e52f628..17cebd0c41 100644 --- a/data/release-notes/enterprise-server/3-9/5.yml +++ b/data/release-notes/enterprise-server/3-9/5.yml @@ -72,3 +72,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-9/6.yml b/data/release-notes/enterprise-server/3-9/6.yml index b0aac8c671..4e07371da4 100644 --- a/data/release-notes/enterprise-server/3-9/6.yml +++ b/data/release-notes/enterprise-server/3-9/6.yml @@ -88,3 +88,5 @@ sections: {% data reusables.release-notes.2023-12-backup-utils-exit-early-redis %} [Updated 2023-12-05] - | {% data reusables.release-notes.2023-12-client-ip-addresses-incorrect-in-audit-log %} [Updated 2023-12-13] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/release-notes/enterprise-server/3-9/7.yml b/data/release-notes/enterprise-server/3-9/7.yml index d10ba3bed1..ea441c431b 100644 --- a/data/release-notes/enterprise-server/3-9/7.yml +++ b/data/release-notes/enterprise-server/3-9/7.yml @@ -166,6 +166,8 @@ sections: Restoring backups with `ghe-restore` on a GHES cluster will exit prematurely if `redis` has not restarted properly. - | {% data reusables.release-notes.2024-01-haproxy-upgrade-causing-increased-errors %} [Updated 2024-01-03] + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] deprecations: - heading: Interactive maps in the web UI no longer allow authentication using an Azure Maps API key notes: diff --git a/data/release-notes/enterprise-server/3-9/8.yml b/data/release-notes/enterprise-server/3-9/8.yml index 25e79c74e7..b50f41d7c9 100644 --- a/data/release-notes/enterprise-server/3-9/8.yml +++ b/data/release-notes/enterprise-server/3-9/8.yml @@ -65,3 +65,5 @@ sections: Restoring backups with `ghe-restore` on a GHES cluster will exit prematurely if `redis` has not restarted properly. - | {% data reusables.release-notes.2024-01-haproxy-upgrade-causing-increased-errors %} + - | + {% data reusables.release-notes.2024-01-ha-proxy-out-of-memory %} [Updated 2024-01-23] diff --git a/data/reusables/release-notes/2024-01-ha-proxy-out-of-memory.md b/data/reusables/release-notes/2024-01-ha-proxy-out-of-memory.md new file mode 100644 index 0000000000..11a27df43f --- /dev/null +++ b/data/reusables/release-notes/2024-01-ha-proxy-out-of-memory.md @@ -0,0 +1 @@ +During periods of high traffic, interruptions in service may occur due to insufficient resource allocations for internal components. From 9e39cd709b9f9c922bf65f60cc502fd847ee5389 Mon Sep 17 00:00:00 2001 From: mc <42146119+mchammer01@users.noreply.github.com> Date: Wed, 24 Jan 2024 19:25:17 +0000 Subject: [PATCH 11/23] Update "Enabling Dependabot version updates" procedure with more detail about the `dependabot.yml` file. (#48808) --- .../configuring-dependabot-version-updates.md | 33 ++++++++++++------- .../dependabot/link-to-yml-config-file.md | 1 + 2 files changed, 23 insertions(+), 11 deletions(-) create mode 100644 data/reusables/dependabot/link-to-yml-config-file.md diff --git a/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md b/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md index a8485eb85f..036ad642c2 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md @@ -44,20 +44,31 @@ You enable {% data variables.product.prodname_dependabot_version_updates %} by c {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} -1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot_version_updates %}", click **Enable** to open a basic `dependabot.yml` configuration file in the `.github` directory of your repository. +1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot_version_updates %}", click **Enable** to open a basic `dependabot.yml` configuration file in the `.github` directory of your repository. {% data reusables.dependabot.link-to-yml-config-file %} {% else %} -1. Create a `dependabot.yml` configuration file in the `.github` directory of your repository. +1. Create a `dependabot.yml` configuration file in the `.github` directory of your repository. You can use the snippet below as a starting point. {% data reusables.dependabot.link-to-yml-config-file %} {% endif %} -1. Add a `version`. -1. Optionally, if you have dependencies in a private registry, add a `registries` section containing authentication details. -1. Add an `updates` section, with an entry for each package manager you want {% data variables.product.prodname_dependabot %} to monitor. -1. For each package manager, use: - - `package-ecosystem` to specify the package manager. - - `directory` to specify the location of the manifest or other definition files. - - `schedule.interval` to specify how often to check for new versions. -{% data reusables.dependabot.check-in-dependabot-yml %} -For information about all the configuration options, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)." + ```yaml copy + # To get started with Dependabot version updates, you'll need to specify which + # package ecosystems to update and where the package manifests are located. + + version: 2 + updates: + - package-ecosystem: "" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" + ``` + +1. Add a `version`. This key is mandatory. The file must start with `version: 2`. +1. Optionally, if you have dependencies in a private registry, add a `registries` section containing authentication details. For more information, see [`registries`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#registries) in "Configuration options for the `dependabot.yml` file." +1. Add an `updates` section, with an entry for each package manager you want {% data variables.product.prodname_dependabot %} to monitor. This key is mandatory. You use it to configure how {% data variables.product.prodname_dependabot %} updates the versions or your project's dependencies. Each entry configures the update settings for a particular package manager. +1. For each package manager, use: + - `package-ecosystem` to specify the package manager. For more information about the supported package managers, see [`package-ecosystem`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem) in "Configuration options for the `dependabot.yml` file." + - `directory` to specify the location of the manifest or other definition files. For more information, see [`directory`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#directory) in "Configuration options for the `dependabot.yml` file." + - `schedule.interval` to specify how often to check for new versions. For more information, see [`schedule.interval`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#scheduleinterval) in "Configuration options for the `dependabot.yml` file." +{% data reusables.dependabot.check-in-dependabot-yml %} ### Example `dependabot.yml` file diff --git a/data/reusables/dependabot/link-to-yml-config-file.md b/data/reusables/dependabot/link-to-yml-config-file.md new file mode 100644 index 0000000000..e5092818e0 --- /dev/null +++ b/data/reusables/dependabot/link-to-yml-config-file.md @@ -0,0 +1 @@ +For information about the options you can use to customize how {% data variables.product.prodname_dependabot %} maintains your repositories, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)." From 0f050a9bbfcdaaf6e30386e8552564d2c02a361b Mon Sep 17 00:00:00 2001 From: mc <42146119+mchammer01@users.noreply.github.com> Date: Wed, 24 Jan 2024 19:32:01 +0000 Subject: [PATCH 12/23] Dependabot Version Updates Support devcontainers (#48232) Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Josh Spicer --- ...dabot-version-updates-devcontainer-support.yml | 5 +++++ .../dependabot/supported-package-managers.md | 15 ++++++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 data/features/dependabot-version-updates-devcontainer-support.yml diff --git a/data/features/dependabot-version-updates-devcontainer-support.yml b/data/features/dependabot-version-updates-devcontainer-support.yml new file mode 100644 index 0000000000..14a12386b0 --- /dev/null +++ b/data/features/dependabot-version-updates-devcontainer-support.yml @@ -0,0 +1,5 @@ +# Reference: Issue #13185 - Dependabot Version Updates Support devcontainers +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.13' diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index 41a7f65e14..6b8e1884aa 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -9,7 +9,8 @@ Package manager | YAML value | Supported versions | Private repositories | Bundler | `bundler` | v1, v2 | {% octicon "x" aria-label="Not supported" %}| {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | [Cargo](#cargo) | `cargo` | v1 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} (git only) | {% octicon "x" aria-label="Not supported" %} | Composer | `composer` | v1, v2 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | -{% ifversion dependabot-version-updates-enhanced-docker-support %}[Docker](#docker){% else %}Docker{% endif %} | `docker` | v1 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Not applicable | +{% ifversion dependabot-version-updates-devcontainer-support %}[Dev containers](#dev-containers) | `devcontainers` | Not applicable | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | +{% endif %}{% ifversion dependabot-version-updates-enhanced-docker-support %}[Docker](#docker){% else %}Docker{% endif %} | `docker` | v1 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Not applicable | Hex | `mix` | v1 | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | elm-package | `elm` | v0.19 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | git submodule | `gitsubmodule` | Not applicable | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Not applicable | @@ -40,6 +41,18 @@ pipenv | `pip` | <= 2021-05-29 | {% octicon "x" aria-label Private registry support applies to git registries, and doesn't include cargo registries. +{% ifversion dependabot-version-updates-devcontainer-support %} + +#### Dev containers + +You can use `devcontainers` as a `package-ecosystem` in your `dependabot.yml` file to update Features in your `devcontainer.json` configuration files. Dev containers are used in several tools and services, including {% data variables.product.prodname_codespaces %}. For more information about Features and the supported services, see [Features](https://containers.dev/implementors/features/) and [Supporting tools and services](https://containers.dev/supporting) in the Dev Containers' documentation, respectively. + +This updater ensures Features are pinned to the latest `major` version in the associated `devcontainer.json` file. If a dev container has a lockfile, that file will also be updated. For more information about lockfile specifications, see [Lockfiles](https://github.com/devcontainers/spec/blob/main/docs/specs/devcontainer-lockfile.md) in the `devcontainers/spec` repository. + +Features in any valid dev container location will be updated in a single pull request. For more information about the dev container specification, see [Specification](https://containers.dev/implementors/spec/#devcontainerjson) in the Dev Containers' documentation. + +{% endif %} + {% ifversion dependabot-version-updates-enhanced-docker-support %} #### Docker From 92d757a7ad4eac80ac2326bf8a1ad6820ab6aa2a Mon Sep 17 00:00:00 2001 From: Anne-Marie <102995847+am-stead@users.noreply.github.com> Date: Wed, 24 Jan 2024 21:33:46 +0100 Subject: [PATCH 13/23] Update GHAS adoption articles for push protection #8597 (#48613) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Felicity Chapman --- .../index.md | 1 - ...pting-github-advanced-security-at-scale.md | 10 +++--- .../phase-2-preparing-to-enable-at-scale.md | 20 +++++++++-- .../phase-3-pilot-programs.md | 10 ++++++ ...ase-6-rollout-and-scale-secret-scanning.md | 34 ++++++++++++------- ...tion-for-repositories-and-organizations.md | 7 ++-- .../secret-scanning/pre-push-protection.md | 1 + .../secret-scanning/push-protection-bypass.md | 4 +++ .../push-protection-custom-pattern.md | 1 + 9 files changed, 63 insertions(+), 25 deletions(-) create mode 100644 data/reusables/secret-scanning/pre-push-protection.md create mode 100644 data/reusables/secret-scanning/push-protection-bypass.md create mode 100644 data/reusables/secret-scanning/push-protection-custom-pattern.md diff --git a/content/code-security/adopting-github-advanced-security-at-scale/index.md b/content/code-security/adopting-github-advanced-security-at-scale/index.md index b483f4c43c..556dca74e7 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/index.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/index.md @@ -19,4 +19,3 @@ children: - /phase-5-rollout-and-scale-code-scanning - /phase-6-rollout-and-scale-secret-scanning --- - diff --git a/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md b/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md index 083be88b2d..049e65db30 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md @@ -26,15 +26,15 @@ We’ve created a phased approach to GHAS rollouts developed from industry and G Enabling GHAS across a large organization can be broken down into six core phases. 1. [Align on your rollout strategy and goals](/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals): Think about what success will look like, and align on how GHAS will be implemented in your company. This phase may only take a few days or a week, but it lays a solid foundation for the rest of the rollout. - + 1. [Preparing to enable at scale](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale): Prepare developers, collect data about your repositories, and ensure you're ready for the next phase. - + 1. [Pilot programs](/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs): Optionally, pilot an initial rollout to a few high-impact projects and teams. This will allow an initial group within your company to get familiar with GHAS before you roll out to the remainder of your company. - + 1. [Create internal documentation](/code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation): Create and communicate internal documentation for the consumers of GHAS. Without proper documentation provided to developers, security engineers, and others who will be using GHAS, the value will get lost in the rollout. - + 1. [Rollout and scale {% data variables.product.prodname_code_scanning %}](/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning): Leveraging the available APIs, automatically rollout {% data variables.product.prodname_code_scanning %} by team and by language across your enterprise, using the repository data you collected earlier. - + 1. [Rollout and scale {% data variables.product.prodname_secret_scanning %}](/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning): Roll out {% data variables.product.prodname_secret_scanning %}, which involves less configuration and is therefore simpler to adopt than {% data variables.product.prodname_code_scanning %}. Still, it's critical to have a strategy for handling new and old results. ## {% data variables.contact.github_support %} and {% data variables.product.prodname_professional_services_team %} diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md index 5e0e0ba91d..a4487bc6e8 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md @@ -131,7 +131,7 @@ Before you can proceed with pilot programs and rolling out {% data variables.pro {% note %} -**Note:** When {% data variables.product.prodname_secret_scanning %} detects a secret in repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}, {% data variables.product.prodname_dotcom %} alerts all users with access to security alerts for the repository. {% ifversion ghec %} +**Note:** When a secret is detected in a repository that has enabled {% data variables.product.prodname_secret_scanning %}, {% data variables.product.prodname_dotcom %} alerts all users with access to security alerts for the repository. {% ifversion ghec %} Secrets found in public repositories using {% data variables.secret-scanning.partner_alerts %} are reported directly to the partner, without creating an alert on {% data variables.product.product_name %}. For details about the supported partner patterns, see "[AUTOTITLE](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)."{% endif %} @@ -149,7 +149,7 @@ If a project communicates with an external service, it might use a token or priv #### License consumption -Enabling {% data variables.product.prodname_secret_scanning %} for all repositories will consume all your licenses, even if no one is using code scanning. This is fine unless you plan to increase the number of active developers in your organization. If the number of active developers is likely to increase in the coming months, you may exceed your license limit and then be unable to use {% data variables.product.prodname_GH_advanced_security %} on newly created repositories. +Enabling {% data variables.product.prodname_secret_scanning %} for all repositories will maximize your use of {% data variables.product.prodname_GH_advanced_security %} licenses. This is fine if you have enough licenses for the current committers to all those repositories. If the number of active developers is likely to increase in the coming months, you may exceed your license limit and then be unable to use {% data variables.product.prodname_GH_advanced_security %} on newly created repositories. #### Initial high volume of detected secrets @@ -171,6 +171,22 @@ If you are enabling {% data variables.product.prodname_secret_scanning %} on a l As you audit your repositories and speak to security and developer teams, build a list of the secret types that you will later use to configure custom patterns for {% data variables.product.prodname_secret_scanning %}. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." +### Push protection for {% data variables.product.prodname_secret_scanning %} + +Push protection for organizations and repositories instructs {% data variables.product.prodname_secret_scanning %} to check pushes for supported secrets _before_ secrets are committed to the codebase. For information on which secrets are supported, see "[AUTOTITLE](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." + +If a secret is detected in a push, that push is blocked. {% data variables.product.prodname_secret_scanning_caps %} lists any secrets it detects so the author can review the secrets and remove them or, if needed, allow those secrets to be pushed. {% data reusables.secret-scanning.push-protection-custom-pattern %} + +Developers have the option to bypass push protection by reporting that a secret is a false positive, that it is used in tests, or that it will be fixed later. + +{% data reusables.secret-scanning.push-protection-bypass %} + +Before enabling push protection, consider whether you need to create guidance for developer teams on the acceptable conditions for bypassing push protection. You can configure a link to this resource in the message that's displayed when a developer attempts to push a blocked secret. + +Next, familiarize yourself with the different options for managing and monitoring alerts that are the result of a contributor bypassing push protection. + +For more information, see "[AUTOTITLE](/code-security/secret-scanning/push-protection-for-repositories-and-organizations)." + {% note %} For the next article in this series, see "[AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs)." diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md index 5fa7849316..4958e803d8 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md @@ -79,6 +79,16 @@ To enable secret scanning for your {% data variables.product.prodname_ghe_server You need to enable secret scanning for each pilot project, either by enabling the feature for each repository or for all repositories in any organizations taking part in the project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)" or "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)." +Next, enable push protection for each pilot project. + +If you plan to configure a link to a resource in the message that's displayed when a developer attempts to push a blocked secret, now would be a good time to test and start to refine the guidance that you plan to make available. + +{%- ifversion security-overview-push-protection-metrics-page %} + +Start to review activity using the push protection metrics page in security overview. For more information, see "[AUTOTITLE](/code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection-in-your-organization)." + +{%- endif %} + If you have collated any custom patterns specific to your enterprise, especially any related to the projects piloting {% data variables.product.prodname_secret_scanning %}, you can configure those. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." To learn how to view and close alerts for secrets checked into your repository, see "[AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning)." diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index f73b8d39c6..c6875fe3a0 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -26,15 +26,15 @@ When you enable {% data variables.product.prodname_secret_scanning %}, you shoul There are a few approaches for tackling newly committed credentials, but one example approach would be: -1. Notify: Use webhooks to ensure that any new secret alerts are seen by the right teams as quickly as possible. A webhook fires when a secret alert is either created, resolved, or reopened. You can then parse the webhook payload, and integrate it into any tools you and your team use such Slack, Teams, Splunk, or email. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/about-webhooks)" and "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert)." -1. Follow Up: Create a high-level remediation process that works for all secret types. For example, you could contact the developer who committed the secret and their technical lead on that project, highlighting the dangers of committing secrets to GitHub, and asking the them to revoke, and update the detected secret. +1. **Notify**: Use webhooks to ensure that any new secret alerts are seen by the right teams as quickly as possible. A webhook fires when a secret alert is either created, resolved, or reopened. You can then parse the webhook payload, and integrate it into any tools you and your team use such Slack, Teams, Splunk, or email. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/about-webhooks)" and "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert)." +1. **Follow Up**: Create a high-level remediation process that works for all secret types. For example, you could contact the developer who committed the secret and their technical lead on that project, highlighting the dangers of committing secrets to {% data variables.product.prodname_dotcom %}, and asking the them to revoke, and update the detected secret. {% note %} **Note:** You can automate this step. For large enterprises and organizations with hundreds of repositories, manually following up is unsustainable. You could incorporate automation into the webhook process defined in the first step. The webhook payload contains repository and organization information about the leaked secret. Using this information, you can contact the current maintainers on the repository and create an email/message to the responsible people or open an issue. {% endnote %} -1. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If the a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. +1. **Educate**: Create an internal training document assigned to the developer who committed the secret. Within this training document, you can explain the risks created by committing secrets and direct them to your best practice information about using secrets securely in development. If a developer doesn't learn from the experience and continues to commit secrets, you could create an escalation process, but education usually works well. Repeat the last two steps for any new secrets leaked. This process encourages developers to take responsibility for managing the secrets used in their code securely, and allows you to measure the reduction in newly committed secrets. @@ -44,9 +44,25 @@ Repeat the last two steps for any new secrets leaked. This process encourages de {% endnote %} -## 2. Remediate previously committed secrets, starting with the most critical +## 2. Enable push protection -After you have established a process to monitor, notify and remediate newly published secrets, you can start work on secrets committed before {% data variables.product.prodname_GH_advanced_security %} was introduced. +Once you have enabled {% data variables.product.prodname_secret_scanning %}, you should also enable push protection. With push protection, {% data variables.product.prodname_secret_scanning %} checks pushes for supported secrets and blocks pushes to {% data variables.product.prodname_dotcom %} _before_ the secrets are exposed to other users. For information on how to enable push protection, see "[AUTOTITLE](/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-secret-scanning-as-a-push-protection)." + +Once enabled, you can do the following: + +1. **Provide guidance**: Configure a custom link in the message that contributors will see if their push is blocked by {% data variables.product.prodname_secret_scanning %}. The linked resource can provide guidance for contributors on how to resolve the blocked push. For more information, see "[AUTOTITLE](/code-security/secret-scanning/push-protection-for-repositories-and-organizations#enabling-secret-scanning-as-a-push-protection)." + +1. **Notify**: Define a webhook that specifically tracks {% data variables.secret-scanning.alerts %} created when someone bypasses push protection by using the alert property `"push_protection_bypassed": true`. Or, use the API to get updates on which {% data variables.secret-scanning.alerts %} were the result of a push protection bypass by filtering the list of results for `"push_protection_bypassed": true`. For more information, see "[AUTOTITLE](/code-security/getting-started/auditing-security-alerts)." + +{%- ifversion security-overview-push-protection-metrics-page %} + +1. **Monitor**: Use security overview to view metrics on how push protection is performing in repositories across your organization, so you can quickly identify any repositories where you might need to take action. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection-in-your-organization)." + +{%- endif %} + +## 3. Remediate previously committed secrets, starting with the most critical + +After you have established a process to reduce the addition of secrets to your codebases, you are ready to start work remediating secrets that were committed before you introduced {% data variables.product.prodname_GH_advanced_security %}. How you define your most critical secrets will depend on your organization's processes and integrations. For example, a company likely isn’t worried about a Slack Incoming Webhook secret if they don’t use Slack. You may find it useful to start by focusing on the top five most critical credential types for your organization. @@ -80,18 +96,12 @@ Once you have decided on the secret types, you can do the following: 1. After you collect information about leaked secrets, create a targeted communication plan for the users who maintain the repositories affected by each secret type. You could use email, messaging, or even create GitHub issues in the affected repositories. If you can use APIs provided by these tools to send out the communications in an automated manner, this will make it easier for you to scale across multiple secret types. -## 3. Expand the program to include more secret types and custom patterns +## 4. Expand the program to include more secret types and custom patterns You can now expand beyond the five most critical secret types into a more comprehensive list, with an additional focus on education. You can repeat the previous step, remediating previously committed secrets, for the different secret types you have targeted. You can also include more of the custom patterns collated in the earlier phases and invite security teams and developer teams to submit more patterns, establishing a process for submitting new patterns as new secret types are created. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." -{% ifversion secret-scanning-push-protection %} - -You can also enable push protection with secret scanning. Once enabled, secret scanning checks pushes for high-confidence secrets and blocks the push. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#using-secret-scanning-as-a-push-protection-from-the-command-line)." - -{% endif %} - As you continue to build your remediation processes for other secret types, start to create proactive training material that can be shared with all developers of GitHub in your organization. Until this point, a lot of the focus has been reactive. It is an excellent idea to shift focus to being proactive and encourage developers not to push credentials to GitHub in the first place. This can be achieved in multiple ways but creating a short document explaining the risks and reasons would be a great place to start. {% note %} diff --git a/content/code-security/secret-scanning/push-protection-for-repositories-and-organizations.md b/content/code-security/secret-scanning/push-protection-for-repositories-and-organizations.md index f6be34e8f9..a111e78d99 100644 --- a/content/code-security/secret-scanning/push-protection-for-repositories-and-organizations.md +++ b/content/code-security/secret-scanning/push-protection-for-repositories-and-organizations.md @@ -21,12 +21,9 @@ shortTitle: Push protection for repositories ## About push protection for repositories and organizations -Up to now, {% data variables.product.prodname_secret_scanning %} checks for secrets _after_ a push and alerts users to exposed secrets. {% data reusables.secret-scanning.push-protection-overview %} {% ifversion secret-scanning-push-protection-custom-patterns %}{% data variables.product.prodname_secret_scanning_caps %} can also check pushes for custom patterns. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)."{% endif %} +{% data reusables.secret-scanning.pre-push-protection %} {% data reusables.secret-scanning.push-protection-overview %} {% data reusables.secret-scanning.push-protection-custom-pattern %} {% ifversion secret-scanning-push-protection-custom-patterns %}For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)."{% endif %} -If a contributor bypasses a push protection block for a secret, {% data variables.product.prodname_dotcom %}: -- creates an alert in the **Security** tab of the repository in the state described in the table below. -- adds the bypass event to the audit log.{% ifversion secret-scanning-push-protection-email %} -- sends an email alert to organization or personal account owners, security managers, and repository administrators who are watching the repository, with a link to the secret and the reason why it was allowed.{% endif %} +{% data reusables.secret-scanning.push-protection-bypass %} {% data reusables.secret-scanning.bypass-reasons-and-alerts %} diff --git a/data/reusables/secret-scanning/pre-push-protection.md b/data/reusables/secret-scanning/pre-push-protection.md new file mode 100644 index 0000000000..7cffc917c5 --- /dev/null +++ b/data/reusables/secret-scanning/pre-push-protection.md @@ -0,0 +1 @@ +So far, {% data variables.product.prodname_secret_scanning %} checks for secrets _after_ a push and alerts users to exposed secrets. diff --git a/data/reusables/secret-scanning/push-protection-bypass.md b/data/reusables/secret-scanning/push-protection-bypass.md new file mode 100644 index 0000000000..bca915c783 --- /dev/null +++ b/data/reusables/secret-scanning/push-protection-bypass.md @@ -0,0 +1,4 @@ +If a contributor bypasses a push protection block for a secret, {% data variables.product.prodname_dotcom %}: +- Creates an alert in the **Security** tab of the repository. +- Adds the bypass event to the audit log.{% ifversion secret-scanning-push-protection-email %} +- Sends an email alert to organization or personal account owners, security managers, and repository administrators who are watching the repository, with a link to the secret and the reason why it was allowed.{% endif %} diff --git a/data/reusables/secret-scanning/push-protection-custom-pattern.md b/data/reusables/secret-scanning/push-protection-custom-pattern.md new file mode 100644 index 0000000000..ff2453ddf6 --- /dev/null +++ b/data/reusables/secret-scanning/push-protection-custom-pattern.md @@ -0,0 +1 @@ +{% ifversion secret-scanning-push-protection-custom-patterns %}{% data variables.product.prodname_secret_scanning_caps %} can also check pushes for custom patterns.{% endif %} From a25a33bb6cbf86a629d0a0c7bef624743991f97e Mon Sep 17 00:00:00 2001 From: Jeff Chen Date: Wed, 24 Jan 2024 15:37:45 -0500 Subject: [PATCH 14/23] fix typo in about-github-hosted-runners.md (#31257) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../about-github-hosted-runners/about-github-hosted-runners.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners.md b/content/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners.md index 70c41bd918..191d03b5d9 100644 --- a/content/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners.md @@ -159,7 +159,7 @@ You can also view a software bill of materials (SBOM) for each build of the Wind ### Using preinstalled software We recommend using actions to interact with the software installed on runners. This approach has several benefits: -- Usually, actions provide more flexible functionality like versions selection, ability to pass arguments, and parameters +- Usually, actions provide more flexible functionality like version selection, ability to pass arguments, and parameters - It ensures the tool versions used in your workflow will remain the same regardless of software updates If there is a tool that you'd like to request, please open an issue at [actions/runner-images](https://github.com/actions/runner-images). This repository also contains announcements about all major software updates on runners. From cbbc403d0a0ffd94998da7dec9be98096081be33 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Wed, 24 Jan 2024 16:24:35 -0500 Subject: [PATCH 15/23] Use latest version of actions/cache (#48836) --- .github/actions/cache-nextjs/action.yml | 2 +- .github/actions/node-npm-setup/action.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/actions/cache-nextjs/action.yml b/.github/actions/cache-nextjs/action.yml index 13dc7311e0..84146741c8 100644 --- a/.github/actions/cache-nextjs/action.yml +++ b/.github/actions/cache-nextjs/action.yml @@ -8,7 +8,7 @@ runs: using: 'composite' steps: - name: Cache .next/cache - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # pin @3.3.1 + uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0 with: path: ${{ github.workspace }}/.next/cache # Generate a new cache whenever packages or source files change. diff --git a/.github/actions/node-npm-setup/action.yml b/.github/actions/node-npm-setup/action.yml index cbd090f78e..8592d0b57a 100644 --- a/.github/actions/node-npm-setup/action.yml +++ b/.github/actions/node-npm-setup/action.yml @@ -6,7 +6,7 @@ runs: using: 'composite' steps: - name: Cache node_modules - uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 + uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0 id: cache-node_modules env: # Default is 10 min, per segment, but we can make it much smaller From 218ac254897834c3c3939c6de68bc8bec829655d Mon Sep 17 00:00:00 2001 From: Mark Maxwell <138938022+mark-mxwl@users.noreply.github.com> Date: Wed, 24 Jan 2024 15:57:21 -0800 Subject: [PATCH 16/23] Update events-that-trigger-workflows.md (#30703) Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> --- .../actions/using-workflows/events-that-trigger-workflows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/using-workflows/events-that-trigger-workflows.md b/content/actions/using-workflows/events-that-trigger-workflows.md index 018cd2f8a2..735e5b9a84 100644 --- a/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/content/actions/using-workflows/events-that-trigger-workflows.md @@ -586,7 +586,7 @@ on: | Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` | | --------------------- | -------------- | ------------ | -------------| -| [`pull_request`](/webhooks-and-events/webhooks/webhook-events-and-payloads#pull_request) | - `assigned`
- `unassigned`
- `labeled`
- `unlabeled`
- `opened`
- `edited`
- `closed`
- `reopened`
- `synchronize`
- `converted_to_draft`
- `ready_for_review`
- `locked`
- `unlocked`
- `milestoned`
- `demilestoned`
- `review_requested`
- `review_request_removed`
- `auto_merge_enabled`
- `auto_merge_disabled` | Last merge commit on the `GITHUB_REF` branch | PR merge branch `refs/pull/PULL_REQUEST_NUMBER/merge` | +| [`pull_request`](/webhooks-and-events/webhooks/webhook-events-and-payloads#pull_request) | - `assigned`
- `unassigned`
- `labeled`
- `unlabeled`
- `opened`
- `edited`
- `closed`
- `reopened`
- `synchronize`
- `converted_to_draft`
- `locked`
- `unlocked`
{% ifversion fpt or ghec %}- `enqueued`
- `dequeued`
{% endif %}- `milestoned`
- `demilestoned`
- `ready_for_review`
- `review_requested`
- `review_request_removed`
- `auto_merge_enabled`
- `auto_merge_disabled` | Last merge commit on the `GITHUB_REF` branch | PR merge branch `refs/pull/PULL_REQUEST_NUMBER/merge` | {% note %} From 4e2658cdfafe70cdde5232bfa0eac995d0a8e6a1 Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Wed, 24 Jan 2024 16:50:22 -0800 Subject: [PATCH 17/23] Fix openapi parser bug and add error throwing (#48845) --- src/rest/scripts/utils/get-body-params.js | 2 +- src/rest/scripts/utils/operation.js | 131 ++++++++++++++-------- src/rest/scripts/utils/sync.js | 3 +- 3 files changed, 86 insertions(+), 50 deletions(-) diff --git a/src/rest/scripts/utils/get-body-params.js b/src/rest/scripts/utils/get-body-params.js index 389f9d914d..2d76636e4c 100644 --- a/src/rest/scripts/utils/get-body-params.js +++ b/src/rest/scripts/utils/get-body-params.js @@ -101,7 +101,7 @@ export async function getBodyParams(schema, topLevel = false) { } keyParam.childParamsGroups.push(...(await getBodyParams(param.additionalProperties, false))) childParamsGroups.push(keyParam) - } else if (paramType && paramType.includes('array')) { + } else if (paramType && paramType.includes('array') && param.items) { if (param.items && param.items.oneOf) { if (param.items.oneOf.every((object) => object.type === 'object')) { paramType.splice(paramType.indexOf('array'), 1, `array of objects`) diff --git a/src/rest/scripts/utils/operation.js b/src/rest/scripts/utils/operation.js index ad655d6fcd..1c05d59f67 100644 --- a/src/rest/scripts/utils/operation.js +++ b/src/rest/scripts/utils/operation.js @@ -67,18 +67,28 @@ export default class Operation { } async renderDescription() { - this.descriptionHTML = await renderContent(this.#operation.description) - return this + try { + this.descriptionHTML = await renderContent(this.#operation.description) + return this + } catch (error) { + console.error(error) + throw new Error(`Error rendering description for ${this.verb} ${this.requestPath}`) + } } async codeExamples() { this.codeExamples = await getCodeSamples(this.#operation) - return await Promise.all( - this.codeExamples.map(async (codeExample) => { - codeExample.response.description = await renderContent(codeExample.response.description) - return codeExample - }), - ) + try { + return await Promise.all( + this.codeExamples.map(async (codeExample) => { + codeExample.response.description = await renderContent(codeExample.response.description) + return codeExample + }), + ) + } catch (error) { + console.error(error) + throw new Error(`Error generating code examples for ${this.verb} ${this.requestPath}`) + } } async renderStatusCodes() { @@ -86,38 +96,49 @@ export default class Operation { const responseKeys = Object.keys(responses) if (responseKeys.length === 0) return [] - this.statusCodes = await Promise.all( - responseKeys.map(async (responseCode) => { - const response = responses[responseCode] - const httpStatusCode = responseCode - const httpStatusMessage = httpStatusCodes.getMessage(Number(responseCode), 'HTTP/2') - // The OpenAPI should be updated to provide better descriptions, but - // until then, we can catch some known generic descriptions and replace - // them with the default http status message. - const responseDescription = - response.description.toLowerCase() === 'response' - ? await renderContent(httpStatusMessage) - : await renderContent(response.description) + try { + this.statusCodes = await Promise.all( + responseKeys.map(async (responseCode) => { + const response = responses[responseCode] + const httpStatusCode = responseCode + const httpStatusMessage = httpStatusCodes.getMessage(Number(responseCode), 'HTTP/2') + // The OpenAPI should be updated to provide better descriptions, but + // until then, we can catch some known generic descriptions and replace + // them with the default http status message. + const responseDescription = + response.description.toLowerCase() === 'response' + ? await renderContent(httpStatusMessage) + : await renderContent(response.description) - return { - httpStatusCode, - description: responseDescription, - } - }), - ) + return { + httpStatusCode, + description: responseDescription, + } + }), + ) + } catch (error) { + console.error(error) + throw new Error(`Error rendering status codes for ${this.verb} ${this.requestPath}`) + } } async renderParameterDescriptions() { - return Promise.all( - this.parameters.map(async (param) => { - param.description = await renderContent(param.description) - return param - }), - ) + try { + return Promise.all( + this.parameters.map(async (param) => { + param.description = await renderContent(param.description) + return param + }), + ) + } catch (error) { + console.error(error) + throw new Error(`Error rendering parameter descriptions for ${this.verb} ${this.requestPath}`) + } } async renderBodyParameterDescriptions() { if (!this.#operation.requestBody) return [] + // There is currently only one operation with more than one content type // and the request body parameter types are the same for both. // Operation Id: markdown/render-raw @@ -129,26 +150,40 @@ export default class Operation { } // Merges any instances of allOf in the schema using a deep merge const mergedAllofSchema = mergeAllOf(schema) - this.bodyParameters = isPlainObject(schema) ? await getBodyParams(mergedAllofSchema, true) : [] + try { + this.bodyParameters = isPlainObject(schema) + ? await getBodyParams(mergedAllofSchema, true) + : [] + } catch (error) { + console.error(error) + throw new Error( + `Error rendering body parameter descriptions for ${this.verb} ${this.requestPath}`, + ) + } } async renderPreviewNotes() { const previews = get(this.#operation, 'x-github.previews', []) - this.previews = await Promise.all( - previews.map(async (preview) => { - const note = preview.note - // remove extra leading and trailing newlines - .replace(/```\n\n\n/gm, '```\n') - .replace(/```\n\n/gm, '```\n') - .replace(/\n\n\n```/gm, '\n```') - .replace(/\n\n```/gm, '\n```') + try { + this.previews = await Promise.all( + previews.map(async (preview) => { + const note = preview.note + // remove extra leading and trailing newlines + .replace(/```\n\n\n/gm, '```\n') + .replace(/```\n\n/gm, '```\n') + .replace(/\n\n\n```/gm, '\n```') + .replace(/\n\n```/gm, '\n```') - // convert single-backtick code snippets to fully fenced triple-backtick blocks - // example: This is the description.\n\n`application/vnd.github.machine-man-preview+json` - .replace(/\n`application/, '\n```\napplication') - .replace(/json`$/, 'json\n```') - return await renderContent(note) - }), - ) + // convert single-backtick code snippets to fully fenced triple-backtick blocks + // example: This is the description.\n\n`application/vnd.github.machine-man-preview+json` + .replace(/\n`application/, '\n```\napplication') + .replace(/json`$/, 'json\n```') + return await renderContent(note) + }), + ) + } catch (error) { + console.error(error) + throw new Error(`Error rendering preview notes for ${this.verb} ${this.requestPath}`) + } } } diff --git a/src/rest/scripts/utils/sync.js b/src/rest/scripts/utils/sync.js index 0d2bdac458..d7e878c11b 100644 --- a/src/rest/scripts/utils/sync.js +++ b/src/rest/scripts/utils/sync.js @@ -23,12 +23,13 @@ export async function syncRestData(sourceDirectory, restSchemas) { const operations = [] try { + console.log('Proccessing operations for version ', schemaName) const newOperations = await createOperations(schema) operations.push(...newOperations) await processOperations(operations) } catch (error) { throw new Error( - "🐛 Whoops! It looks like the script wasn't able to parse the dereferenced schema. A recent change may not yet be supported by the decorator. Please reach out in the #docs-engineering slack channel for help.", + `${error}\n\n🐛 Whoops! It looks like the script wasn't able to parse the dereferenced schema. A recent change may not yet be supported by the decorator. Please reach out in the #docs-engineering slack channel for help.`, ) } const formattedOperations = await formatRestData(operations) From 3156a89719f57bdb70f986d062dce2dbee8ce21e Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 24 Jan 2024 19:29:04 -0600 Subject: [PATCH 18/23] Update OpenAPI Description (#48848) --- .../fine-grained-pat-permissions.json | 20 +- .../data/fpt-2022-11-28/fine-grained-pat.json | 14 +- .../server-to-server-permissions.json | 24 +- .../fpt-2022-11-28/server-to-server-rest.json | 14 +- .../fpt-2022-11-28/user-to-server-rest.json | 14 +- .../fine-grained-pat-permissions.json | 20 +- .../ghec-2022-11-28/fine-grained-pat.json | 14 +- .../server-to-server-permissions.json | 24 +- .../server-to-server-rest.json | 14 +- .../ghec-2022-11-28/user-to-server-rest.json | 14 +- .../fine-grained-pat-permissions.json | 2 +- .../fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../server-to-server-rest.json | 2 +- .../user-to-server-rest.json | 2 +- .../fine-grained-pat-permissions.json | 2 +- .../fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../server-to-server-rest.json | 2 +- .../user-to-server-rest.json | 2 +- .../fine-grained-pat-permissions.json | 2 +- .../data/ghes-3.8/fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../data/ghes-3.8/server-to-server-rest.json | 2 +- .../data/ghes-3.8/user-to-server-rest.json | 2 +- .../fine-grained-pat-permissions.json | 2 +- .../ghes-3.9-2022-11-28/fine-grained-pat.json | 2 +- .../server-to-server-permissions.json | 2 +- .../server-to-server-rest.json | 2 +- .../user-to-server-rest.json | 2 +- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 372 ++++++++++--- src/rest/data/ghae/schema.json | 114 ++-- src/rest/data/ghec-2022-11-28/schema.json | 372 ++++++++++--- .../data/ghes-3.10-2022-11-28/schema.json | 120 ++--- .../data/ghes-3.11-2022-11-28/schema.json | 120 ++--- src/rest/data/ghes-3.8/schema.json | 120 ++--- src/rest/data/ghes-3.9-2022-11-28/schema.json | 120 ++--- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 490 ++++++++++++++++-- src/webhooks/data/ghae/schema.json | 78 ++- src/webhooks/data/ghec/schema.json | 490 ++++++++++++++++-- src/webhooks/data/ghes-3.10/schema.json | 78 ++- src/webhooks/data/ghes-3.11/schema.json | 78 ++- src/webhooks/data/ghes-3.8/schema.json | 78 ++- src/webhooks/data/ghes-3.9/schema.json | 78 ++- src/webhooks/lib/config.json | 2 +- 47 files changed, 2244 insertions(+), 682 deletions(-) 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 c9864f5698..45a3e6b97f 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 @@ -5683,7 +5683,25 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", + "additional-permissions": [], + "access": "write" + }, + { + "category": "pages", + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", + "additional-permissions": [], + "access": "read" + }, + { + "category": "pages", + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", "additional-permissions": [], "access": "write" }, 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 30efa28b96..6817aa75d8 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 @@ -3448,7 +3448,19 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" + }, + { + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" + }, + { + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" }, { "slug": "get-a-dns-health-check-for-github-pages", 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 b32dc34483..44654e301d 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 @@ -7013,7 +7013,29 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "pages", + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "pages", + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", "access": "write", "user-to-server": true, "server-to-server": true, 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 46a516030c..77c8edc61e 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 @@ -3052,7 +3052,19 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" + }, + { + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" + }, + { + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" }, { "slug": "get-a-dns-health-check-for-github-pages", 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 db3e9d83bc..1644ea8b24 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 @@ -3520,7 +3520,19 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" + }, + { + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" + }, + { + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" }, { "slug": "get-a-dns-health-check-for-github-pages", 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 dd45adf9ac..6e61bc5bdf 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 @@ -6375,7 +6375,25 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", + "additional-permissions": [], + "access": "write" + }, + { + "category": "pages", + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", + "additional-permissions": [], + "access": "read" + }, + { + "category": "pages", + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", "additional-permissions": [], "access": "write" }, 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 c20cf9ca98..84e6c75bd5 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 @@ -3776,7 +3776,19 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" + }, + { + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" + }, + { + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" }, { "slug": "get-a-dns-health-check-for-github-pages", 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 fcdf90187c..267934acc9 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 @@ -7853,7 +7853,29 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "pages", + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + }, + { + "category": "pages", + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", "access": "write", "user-to-server": true, "server-to-server": true, 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 f19b9cae9b..b0d656d9c2 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 @@ -3380,7 +3380,19 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" + }, + { + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" + }, + { + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" }, { "slug": "get-a-dns-health-check-for-github-pages", 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 a1d3378531..e06bf4f1b4 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 @@ -3848,7 +3848,19 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" + }, + { + "slug": "get-the-status-of-a-github-pages-deployment", + "subcategory": "pages", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}" + }, + { + "slug": "cancel-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" }, { "slug": "get-a-dns-health-check-for-github-pages", diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json index d14b4c25e2..c68ffa88bd 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json @@ -4883,7 +4883,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "additional-permissions": [], "access": "write" } diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json index 2a15d968f2..d05702e194 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json @@ -2932,7 +2932,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json index 39418f0052..a965cf050e 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json @@ -6053,7 +6053,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "access": "write", "user-to-server": true, "server-to-server": true, diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json index 967bae1d9a..9cdb4a548f 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-rest.json @@ -2822,7 +2822,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json index 1e979d5ed7..f5ddd92fb6 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/user-to-server-rest.json @@ -3004,7 +3004,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json index 0edfa9b7d1..a9ed24874f 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json @@ -4991,7 +4991,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "additional-permissions": [], "access": "write" } diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json index 5fb5ed182a..f60e3625f2 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json @@ -2962,7 +2962,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-permissions.json index de18fac086..be20b31590 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-permissions.json @@ -6185,7 +6185,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "access": "write", "user-to-server": true, "server-to-server": true, diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json index 168e94a59b..4a14b121c7 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/server-to-server-rest.json @@ -2852,7 +2852,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json index e99e54282a..937e40a541 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/user-to-server-rest.json @@ -3034,7 +3034,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json index 614753052f..30139f9445 100644 --- a/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json @@ -4667,7 +4667,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "additional-permissions": [], "access": "write" } diff --git a/src/github-apps/data/ghes-3.8/fine-grained-pat.json b/src/github-apps/data/ghes-3.8/fine-grained-pat.json index b24c026ff8..067bb31680 100644 --- a/src/github-apps/data/ghes-3.8/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.8/fine-grained-pat.json @@ -2708,7 +2708,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.8/server-to-server-permissions.json b/src/github-apps/data/ghes-3.8/server-to-server-permissions.json index 480318a20f..9b22158a61 100644 --- a/src/github-apps/data/ghes-3.8/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.8/server-to-server-permissions.json @@ -5678,7 +5678,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "access": "write", "user-to-server": true, "server-to-server": true, diff --git a/src/github-apps/data/ghes-3.8/server-to-server-rest.json b/src/github-apps/data/ghes-3.8/server-to-server-rest.json index 5317ed167a..d3c593b6a4 100644 --- a/src/github-apps/data/ghes-3.8/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.8/server-to-server-rest.json @@ -2496,7 +2496,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.8/user-to-server-rest.json b/src/github-apps/data/ghes-3.8/user-to-server-rest.json index 415f40f497..f6eff9c732 100644 --- a/src/github-apps/data/ghes-3.8/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.8/user-to-server-rest.json @@ -2732,7 +2732,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json index a263c49c0c..4abe97dce9 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json @@ -4811,7 +4811,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "additional-permissions": [], "access": "write" } diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json index 6e2e561032..aa910d4940 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json @@ -2890,7 +2890,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json index ca56c32e85..8addc77bd1 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-permissions.json @@ -5854,7 +5854,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "access": "write", "user-to-server": true, "server-to-server": true, diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json index 5e585fc837..1fec21d527 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/server-to-server-rest.json @@ -2726,7 +2726,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json index acb51c265b..6cb8ab5970 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/user-to-server-rest.json @@ -2914,7 +2914,7 @@ "slug": "create-a-github-pages-deployment", "subcategory": "pages", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment" + "requestPath": "/repos/{owner}/{repo}/pages/deployments" } ], "projects": [ diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 35af5313cb..86bfd8ccc5 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "e44bcaa6f0d15e9c8c558b5023595ef39ad0f15a" + "sha": "ec36bcff2ea7a3020350434873fa9e05d94a2d2d" } \ 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 6313af1e13..e4c4fa1dd5 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -77510,7 +77510,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -80820,7 +80820,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -84227,7 +84227,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -154680,7 +154680,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

You must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -210362,7 +210362,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

\n

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
    • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -212952,7 +212952,7 @@ } ], "previews": [], - "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.

\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -213382,7 +213382,7 @@ } ], "previews": [], - "descriptionHTML": "

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

\n

Comments are ordered by ascending ID.

", + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

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

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

Gets a specified commit comment.

\n

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

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

Updates the contents of a specified commit comment.

\n

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

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

Use the :commit_sha to specify the commit that will have its comments listed.

", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

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

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

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

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -248148,7 +248148,7 @@ } ], "previews": [], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.\nAt least one of description or files is required.

", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -251876,8 +251876,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -252804,8 +252804,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -253147,8 +253147,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -253488,8 +253488,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -253841,8 +253841,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -254144,7 +254144,7 @@ } ], "previews": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

Note: This API supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
    • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
    • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "statusCodes": [ { "httpStatusCode": "200", @@ -256687,7 +256687,7 @@ } ], "previews": [], - "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -261031,7 +261031,7 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

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

List issues in an organization assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

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

\n

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

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

List issues in a repository. Only open issues will be listed.

\n

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

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

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

\n

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

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

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

\n

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

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

Issue owners and users with push access can edit an issue.

", + "descriptionHTML": "

Issue owners and users with push access can edit an issue.

\n

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

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

List issues across owned and member repositories assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

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

\n

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

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

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

\n

By default, issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

By default, issue comments are ordered by ascending ID.

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

\n

Issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

Issue comments are ordered by ascending ID.

\n

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

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

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

This method returns the contents of the repository's license file, if one is detected.

\n

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
    • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -356227,11 +356227,23 @@ "description": "The name of the property" }, "value": { - "type": [ - "string", - "null" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } ], - "description": "The value assigned to the property" + "description": "The value assigned to the property", + "type": [ + "null", + "string", + "array" + ] } }, "required": [ @@ -356310,7 +356322,7 @@ "isRequired": true }, { - "type": "string or null", + "type": "null or string or array", "name": "value", "description": "

The value assigned to the property

", "isRequired": true @@ -367427,11 +367439,17 @@ "description": "The unique identifier of the rule insight." }, "actor_id": { - "type": "integer", + "type": [ + "integer", + "null" + ], "description": "The number that identifies the user." }, "actor_name": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The handle for the GitHub user account." }, "before_sha": { @@ -390414,7 +390432,7 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "title": "Create a GitHub Pages deployment", "category": "pages", "subcategory": "pages", @@ -390439,12 +390457,17 @@ } ], "bodyParameters": [ + { + "type": "number", + "name": "artifact_id", + "in": "body", + "description": "

The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either artifact_id or artifact_url are required.

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

The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.

", - "isRequired": true + "description": "

The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either artifact_id or artifact_url are required.

" }, { "type": "string", @@ -390507,7 +390530,7 @@ "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", "examples": [ - "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" ] }, "page_url": { @@ -390556,6 +390579,185 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", + "title": "Get the status of a GitHub Pages deployment", + "category": "pages", + "subcategory": "pages", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The ID of the Pages deployment. You can also give the commit SHA of the deployment.

", + "in": "path", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "pages_deployment_id": "PAGES_DEPLOYMENT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "status": "succeed" + }, + "schema": { + "title": "GitHub Pages deployment status", + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the deployment.", + "enum": [ + "deployment_in_progress", + "syncing_files", + "finished_file_sync", + "updating_pages", + "purging_cdn", + "deployment_cancelled", + "deployment_failed", + "deployment_content_failed", + "deployment_attempt_error", + "deployment_lost", + "succeed" + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the current status of a GitHub Pages deployment.

\n

Users must have read permission for the GitHub Pages site. GitHub Apps must have the pages:read permission.

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

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", + "title": "Cancel a GitHub Pages deployment", + "category": "pages", + "subcategory": "pages", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The ID of the Pages deployment. You can also give the commit SHA of the deployment.

", + "in": "path", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "pages_deployment_id": "PAGES_DEPLOYMENT_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

A header with no content is returned.

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

Cancels a GitHub Pages deployment.

\n

Users must have write permissions for the GitHub Pages site. GitHub Apps must have the pages:write permission to use this endpoint.

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

A header with no content is returned.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -403255,7 +403457,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
  • application/vnd.github.patch: For more information, see \"git-format-patch\" in the Git documentation.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -407131,7 +407333,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -410959,7 +411161,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -414837,7 +415039,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -415692,7 +415894,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -415889,7 +416091,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note: Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -416892,7 +417094,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

\n

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

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

Provides details for a review comment.

", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

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

Enables you to edit a review comment.

", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

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

Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

", + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

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

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

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

" + "description": "

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -419616,7 +419818,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The list of reviews returns in chronological order.

", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

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

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

" + "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -433152,7 +433354,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

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

Retrieves a pull request review by its ID.

", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

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

Update the review summary comment with new text.

", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

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

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

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

List comments for a specific pull request review.

", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

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

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note: To dismiss a pull request review on a protected branch,\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.

\n

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

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

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

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

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
    • \n
  • 1 MB or smaller: All features of this endpoint are supported.
    • \n
  • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
  • Greater than 100 MB: This endpoint is not supported.
    • \n
\n

If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
    • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
    • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
    • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -494654,7 +494856,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -494866,7 +495068,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -495086,11 +495288,23 @@ "description": "The name of the property" }, "value": { - "type": [ - "string", - "null" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } ], - "description": "The value assigned to the property" + "description": "The value assigned to the property", + "type": [ + "null", + "string", + "array" + ] } }, "required": [ @@ -495161,7 +495375,7 @@ "isRequired": true }, { - "type": "string or null", + "type": "null or string or array", "name": "value", "description": "

The value assigned to the property

", "isRequired": true @@ -502793,11 +503007,17 @@ "description": "The unique identifier of the rule insight." }, "actor_id": { - "type": "integer", + "type": [ + "integer", + "null" + ], "description": "The number that identifies the user." }, "actor_name": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The handle for the GitHub user account." }, "before_sha": { diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 77f6243da6..61346b4b9e 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -50123,7 +50123,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -53263,7 +53263,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -56500,7 +56500,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -117622,7 +117622,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

You must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -130958,7 +130958,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

\n

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
    • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -133548,7 +133548,7 @@ } ], "previews": [], - "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.

\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -133978,7 +133978,7 @@ } ], "previews": [], - "descriptionHTML": "

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

\n

Comments are ordered by ascending ID.

", + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

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

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

Gets a specified commit comment.

\n

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

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

Updates the contents of a specified commit comment.

\n

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

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

Use the :commit_sha to specify the commit that will have its comments listed.

", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

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

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

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

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -162512,7 +162512,7 @@ } ], "previews": [], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.\nAt least one of description or files is required.

", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -166240,8 +166240,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -167168,8 +167168,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -167511,8 +167511,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -167852,8 +167852,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -168205,8 +168205,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -168508,7 +168508,7 @@ } ], "previews": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

Note: This API supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
    • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
    • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "statusCodes": [ { "httpStatusCode": "200", @@ -171051,7 +171051,7 @@ } ], "previews": [], - "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -174508,7 +174508,7 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

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

List issues in an organization assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

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

\n

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

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

List issues in a repository. Only open issues will be listed.

\n

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

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

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

\n

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

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

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

\n

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

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

Issue owners and users with push access can edit an issue.

", + "descriptionHTML": "

Issue owners and users with push access can edit an issue.

\n

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

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

List issues across owned and member repositories assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

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

\n

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

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

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

\n

By default, issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

By default, issue comments are ordered by ascending ID.

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

\n

Issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

Issue comments are ordered by ascending ID.

\n

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

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

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

This method returns the contents of the repository's license file, if one is detected.

\n

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
    • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -281105,7 +281105,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
  • application/vnd.github.patch: For more information, see \"git-format-patch\" in the Git documentation.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -284975,7 +284975,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -288803,7 +288803,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -292681,7 +292681,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -293536,7 +293536,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -293733,7 +293733,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note: Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -294736,7 +294736,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

\n

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

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

Provides details for a review comment.

", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

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

Enables you to edit a review comment.

", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

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

Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

", + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

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

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

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

" + "description": "

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -297450,7 +297450,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The list of reviews returns in chronological order.

", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

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

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

" + "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -310646,7 +310646,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

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

Retrieves a pull request review by its ID.

", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

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

Update the review summary comment with new text.

", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

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

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

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

List comments for a specific pull request review.

", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

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

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note: To dismiss a pull request review on a protected branch,\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.

\n

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

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

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

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

Gets the preferred README for a repository.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -367450,7 +367450,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 421da9073e..adc774fa88 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -87302,7 +87302,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -90612,7 +90612,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -94019,7 +94019,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -166655,7 +166655,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

You must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -222601,7 +222601,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

\n

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
    • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -225191,7 +225191,7 @@ } ], "previews": [], - "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.

\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -225621,7 +225621,7 @@ } ], "previews": [], - "descriptionHTML": "

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

\n

Comments are ordered by ascending ID.

", + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

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

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

Gets a specified commit comment.

\n

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

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

Updates the contents of a specified commit comment.

\n

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

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

Use the :commit_sha to specify the commit that will have its comments listed.

", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

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

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

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

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -267554,7 +267554,7 @@ } ], "previews": [], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.\nAt least one of description or files is required.

", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -271282,8 +271282,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -272210,8 +272210,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -272553,8 +272553,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -272894,8 +272894,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -273247,8 +273247,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -273550,7 +273550,7 @@ } ], "previews": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

Note: This API supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
    • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
    • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "statusCodes": [ { "httpStatusCode": "200", @@ -276093,7 +276093,7 @@ } ], "previews": [], - "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -280437,7 +280437,7 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

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

List issues in an organization assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

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

\n

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

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

List issues in a repository. Only open issues will be listed.

\n

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

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

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

\n

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

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

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

\n

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

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

Issue owners and users with push access can edit an issue.

", + "descriptionHTML": "

Issue owners and users with push access can edit an issue.

\n

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

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

List issues across owned and member repositories assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

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

\n

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

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

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

\n

By default, issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

By default, issue comments are ordered by ascending ID.

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

\n

Issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

Issue comments are ordered by ascending ID.

\n

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

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

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

This method returns the contents of the repository's license file, if one is detected.

\n

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
    • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -376271,11 +376271,23 @@ "description": "The name of the property" }, "value": { - "type": [ - "string", - "null" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } ], - "description": "The value assigned to the property" + "description": "The value assigned to the property", + "type": [ + "null", + "string", + "array" + ] } }, "required": [ @@ -376354,7 +376366,7 @@ "isRequired": true }, { - "type": "string or null", + "type": "null or string or array", "name": "value", "description": "

The value assigned to the property

", "isRequired": true @@ -390402,11 +390414,17 @@ "description": "The unique identifier of the rule insight." }, "actor_id": { - "type": "integer", + "type": [ + "integer", + "null" + ], "description": "The number that identifies the user." }, "actor_name": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The handle for the GitHub user account." }, "before_sha": { @@ -413503,7 +413521,7 @@ { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "title": "Create a GitHub Pages deployment", "category": "pages", "subcategory": "pages", @@ -413528,12 +413546,17 @@ } ], "bodyParameters": [ + { + "type": "number", + "name": "artifact_id", + "in": "body", + "description": "

The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either artifact_id or artifact_url are required.

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

The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.

", - "isRequired": true + "description": "

The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either artifact_id or artifact_url are required.

" }, { "type": "string", @@ -413596,7 +413619,7 @@ "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", "examples": [ - "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" ] }, "page_url": { @@ -413645,6 +413668,185 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}", + "title": "Get the status of a GitHub Pages deployment", + "category": "pages", + "subcategory": "pages", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The ID of the Pages deployment. You can also give the commit SHA of the deployment.

", + "in": "path", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "pages_deployment_id": "PAGES_DEPLOYMENT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "status": "succeed" + }, + "schema": { + "title": "GitHub Pages deployment status", + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the deployment.", + "enum": [ + "deployment_in_progress", + "syncing_files", + "finished_file_sync", + "updating_pages", + "purging_cdn", + "deployment_cancelled", + "deployment_failed", + "deployment_content_failed", + "deployment_attempt_error", + "deployment_lost", + "succeed" + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets the current status of a GitHub Pages deployment.

\n

Users must have read permission for the GitHub Pages site. GitHub Apps must have the pages:read permission.

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

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel", + "title": "Cancel a GitHub Pages deployment", + "category": "pages", + "subcategory": "pages", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The ID of the Pages deployment. You can also give the commit SHA of the deployment.

", + "in": "path", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "pages_deployment_id": "PAGES_DEPLOYMENT_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

A header with no content is returned.

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

Cancels a GitHub Pages deployment.

\n

Users must have write permissions for the GitHub Pages site. GitHub Apps must have the pages:write permission to use this endpoint.

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

A header with no content is returned.

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -426344,7 +426546,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
  • application/vnd.github.patch: For more information, see \"git-format-patch\" in the Git documentation.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -430220,7 +430422,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -434048,7 +434250,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -437926,7 +438128,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -438781,7 +438983,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -438978,7 +439180,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note: Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -439981,7 +440183,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

\n

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

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

Provides details for a review comment.

", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

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

Enables you to edit a review comment.

", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

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

Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

", + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

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

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

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

" + "description": "

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -442705,7 +442907,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The list of reviews returns in chronological order.

", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

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

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

" + "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -456241,7 +456443,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

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

Retrieves a pull request review by its ID.

", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

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

Update the review summary comment with new text.

", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

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

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

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

List comments for a specific pull request review.

", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

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

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note: To dismiss a pull request review on a protected branch,\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.

\n

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

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

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

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

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
    • \n
  • 1 MB or smaller: All features of this endpoint are supported.
    • \n
  • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
  • Greater than 100 MB: This endpoint is not supported.
    • \n
\n

If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
    • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
    • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
    • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -517875,7 +518077,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -518087,7 +518289,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -518307,11 +518509,23 @@ "description": "The name of the property" }, "value": { - "type": [ - "string", - "null" + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } ], - "description": "The value assigned to the property" + "description": "The value assigned to the property", + "type": [ + "null", + "string", + "array" + ] } }, "required": [ @@ -518382,7 +518596,7 @@ "isRequired": true }, { - "type": "string or null", + "type": "null or string or array", "name": "value", "description": "

The value assigned to the property

", "isRequired": true @@ -526159,11 +526373,17 @@ "description": "The unique identifier of the rule insight." }, "actor_id": { - "type": "integer", + "type": [ + "integer", + "null" + ], "description": "The number that identifies the user." }, "actor_name": { - "type": "string", + "type": [ + "string", + "null" + ], "description": "The handle for the GitHub user account." }, "before_sha": { 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 496b4f3fa5..1686529030 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 @@ -86781,7 +86781,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -90091,7 +90091,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -93498,7 +93498,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -160487,7 +160487,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

You must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -174212,7 +174212,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

\n

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
    • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -176802,7 +176802,7 @@ } ], "previews": [], - "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.

\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -177232,7 +177232,7 @@ } ], "previews": [], - "descriptionHTML": "

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

\n

Comments are ordered by ascending ID.

", + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

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

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

Gets a specified commit comment.

\n

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

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

Updates the contents of a specified commit comment.

\n

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

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

Use the :commit_sha to specify the commit that will have its comments listed.

", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

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

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

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

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -226510,7 +226510,7 @@ } ], "previews": [], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.\nAt least one of description or files is required.

", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -230238,8 +230238,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -231166,8 +231166,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -231509,8 +231509,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -231850,8 +231850,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -232203,8 +232203,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -232506,7 +232506,7 @@ } ], "previews": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

Note: This API supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
    • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
    • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "statusCodes": [ { "httpStatusCode": "200", @@ -235049,7 +235049,7 @@ } ], "previews": [], - "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -238591,7 +238591,7 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

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

List issues in an organization assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

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

\n

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

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

List issues in a repository. Only open issues will be listed.

\n

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

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

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

\n

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

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

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

\n

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

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

Issue owners and users with push access can edit an issue.

", + "descriptionHTML": "

Issue owners and users with push access can edit an issue.

\n

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

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

List issues across owned and member repositories assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

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

\n

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

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

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

\n

By default, issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

By default, issue comments are ordered by ascending ID.

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

\n

Issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

Issue comments are ordered by ascending ID.

\n

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

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

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

This method returns the contents of the repository's license file, if one is detected.

\n

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
    • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -362128,7 +362128,7 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "title": "Create a GitHub Pages deployment", "category": "pages", "subcategory": "pages", @@ -362221,7 +362221,7 @@ "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", "examples": [ - "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" ] }, "page_url": { @@ -374539,7 +374539,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
  • application/vnd.github.patch: For more information, see \"git-format-patch\" in the Git documentation.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -378415,7 +378415,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -382243,7 +382243,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -386121,7 +386121,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -386976,7 +386976,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -387173,7 +387173,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note: Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -388176,7 +388176,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

\n

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

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

Provides details for a review comment.

", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

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

Enables you to edit a review comment.

", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

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

Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

", + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

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

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

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

" + "description": "

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -390900,7 +390900,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The list of reviews returns in chronological order.

", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

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

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

" + "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -404436,7 +404436,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

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

Retrieves a pull request review by its ID.

", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

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

Update the review summary comment with new text.

", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

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

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

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

List comments for a specific pull request review.

", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

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

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note: To dismiss a pull request review on a protected branch,\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.

\n

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

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

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

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

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
    • \n
  • 1 MB or smaller: All features of this endpoint are supported.
    • \n
  • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
  • Greater than 100 MB: This endpoint is not supported.
    • \n
\n

If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
    • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
    • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
    • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -465345,7 +465345,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -465557,7 +465557,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", 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 d1db856416..2e4bb01827 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 @@ -86805,7 +86805,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -90115,7 +90115,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -93522,7 +93522,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -160511,7 +160511,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

You must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -174248,7 +174248,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

\n

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
    • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -176838,7 +176838,7 @@ } ], "previews": [], - "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.

\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -177268,7 +177268,7 @@ } ], "previews": [], - "descriptionHTML": "

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

\n

Comments are ordered by ascending ID.

", + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

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

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

Gets a specified commit comment.

\n

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

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

Updates the contents of a specified commit comment.

\n

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

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

Use the :commit_sha to specify the commit that will have its comments listed.

", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

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

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

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

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -226575,7 +226575,7 @@ } ], "previews": [], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.\nAt least one of description or files is required.

", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -230303,8 +230303,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -231231,8 +231231,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -231574,8 +231574,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -231915,8 +231915,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -232268,8 +232268,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -232571,7 +232571,7 @@ } ], "previews": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

Note: This API supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
    • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
    • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "statusCodes": [ { "httpStatusCode": "200", @@ -235114,7 +235114,7 @@ } ], "previews": [], - "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -238656,7 +238656,7 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

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

List issues in an organization assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

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

\n

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

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

List issues in a repository. Only open issues will be listed.

\n

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

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

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

\n

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

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

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

\n

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

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

Issue owners and users with push access can edit an issue.

", + "descriptionHTML": "

Issue owners and users with push access can edit an issue.

\n

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

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

List issues across owned and member repositories assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

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

\n

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

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

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

\n

By default, issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

By default, issue comments are ordered by ascending ID.

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

\n

Issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

Issue comments are ordered by ascending ID.

\n

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

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

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

This method returns the contents of the repository's license file, if one is detected.

\n

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
    • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -367696,7 +367696,7 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "title": "Create a GitHub Pages deployment", "category": "pages", "subcategory": "pages", @@ -367789,7 +367789,7 @@ "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", "examples": [ - "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" ] }, "page_url": { @@ -380107,7 +380107,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
  • application/vnd.github.patch: For more information, see \"git-format-patch\" in the Git documentation.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -383983,7 +383983,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -387811,7 +387811,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -391689,7 +391689,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -392544,7 +392544,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -392741,7 +392741,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note: Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -393744,7 +393744,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

\n

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

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

Provides details for a review comment.

", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

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

Enables you to edit a review comment.

", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

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

Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

", + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

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

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

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

" + "description": "

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -396468,7 +396468,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The list of reviews returns in chronological order.

", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

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

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

" + "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -410004,7 +410004,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

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

Retrieves a pull request review by its ID.

", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

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

Update the review summary comment with new text.

", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

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

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

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

List comments for a specific pull request review.

", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

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

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note: To dismiss a pull request review on a protected branch,\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.

\n

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

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

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

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

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
    • \n
  • 1 MB or smaller: All features of this endpoint are supported.
    • \n
  • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
  • Greater than 100 MB: This endpoint is not supported.
    • \n
\n

If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
    • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
    • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
    • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -471346,7 +471346,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -471558,7 +471558,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index f02a1b1928..efe55cfa97 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -84905,7 +84905,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -88215,7 +88215,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -91622,7 +91622,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -157850,7 +157850,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

You must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -171135,7 +171135,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

\n

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
    • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -173725,7 +173725,7 @@ } ], "previews": [], - "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.

\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -174155,7 +174155,7 @@ } ], "previews": [], - "descriptionHTML": "

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

\n

Comments are ordered by ascending ID.

", + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

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

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

Gets a specified commit comment.

\n

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

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

Updates the contents of a specified commit comment.

\n

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

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

Use the :commit_sha to specify the commit that will have its comments listed.

", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

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

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

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

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -221337,7 +221337,7 @@ } ], "previews": [], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.\nAt least one of description or files is required.

", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -225065,8 +225065,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -225993,8 +225993,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -226336,8 +226336,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -226677,8 +226677,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -227030,8 +227030,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -227333,7 +227333,7 @@ } ], "previews": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

Note: This API supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
    • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
    • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "statusCodes": [ { "httpStatusCode": "200", @@ -229876,7 +229876,7 @@ } ], "previews": [], - "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -233418,7 +233418,7 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

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

List issues in an organization assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

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

\n

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

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

List issues in a repository. Only open issues will be listed.

\n

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

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

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

\n

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

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

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

\n

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

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

Issue owners and users with push access can edit an issue.

", + "descriptionHTML": "

Issue owners and users with push access can edit an issue.

\n

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

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

List issues across owned and member repositories assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

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

\n

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

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

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

\n

By default, issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

By default, issue comments are ordered by ascending ID.

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

\n

Issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

Issue comments are ordered by ascending ID.

\n

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

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

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

This method returns the contents of the repository's license file, if one is detected.

\n

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
    • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -338225,7 +338225,7 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "title": "Create a GitHub Pages deployment", "category": "pages", "subcategory": "pages", @@ -338318,7 +338318,7 @@ "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", "examples": [ - "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" ] }, "page_url": { @@ -350625,7 +350625,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
  • application/vnd.github.patch: For more information, see \"git-format-patch\" in the Git documentation.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -354492,7 +354492,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -358311,7 +358311,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -362180,7 +362180,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -363035,7 +363035,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -363232,7 +363232,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note: Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -364235,7 +364235,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

\n

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

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

Provides details for a review comment.

", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

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

Enables you to edit a review comment.

", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

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

Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

", + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

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

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

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

" + "description": "

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -366949,7 +366949,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The list of reviews returns in chronological order.

", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

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

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

" + "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -380446,7 +380446,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

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

Retrieves a pull request review by its ID.

", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

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

Update the review summary comment with new text.

", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

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

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

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

List comments for a specific pull request review.

", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

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

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note: To dismiss a pull request review on a protected branch,\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.

\n

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

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

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

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

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
    • \n
  • 1 MB or smaller: All features of this endpoint are supported.
    • \n
  • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
  • Greater than 100 MB: This endpoint is not supported.
    • \n
\n

If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
    • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
    • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
    • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -440762,7 +440762,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -440974,7 +440974,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index d34c410139..3be8ca1e1c 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -85827,7 +85827,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -89137,7 +89137,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -92544,7 +92544,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.

", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -159224,7 +159224,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

You must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -172890,7 +172890,7 @@ } ], "previews": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

You can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.

\n

To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
    • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -175480,7 +175480,7 @@ } ], "previews": [], - "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.

\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
    • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
    • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
    • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
    • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "statusCodes": [ { "httpStatusCode": "200", @@ -175910,7 +175910,7 @@ } ], "previews": [], - "descriptionHTML": "

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

\n

Comments are ordered by ascending ID.

", + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

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

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

Gets a specified commit comment.

\n

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

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

Updates the contents of a specified commit comment.

\n

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

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

Use the :commit_sha to specify the commit that will have its comments listed.

", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

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

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

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

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -223982,7 +223982,7 @@ } ], "previews": [], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.\nAt least one of description or files is required.

", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -227710,8 +227710,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -228638,8 +228638,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -228981,8 +228981,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -229322,8 +229322,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -229675,8 +229675,8 @@ } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -229978,7 +229978,7 @@ } ], "previews": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

Note: This API supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
    • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
    • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "statusCodes": [ { "httpStatusCode": "200", @@ -232521,7 +232521,7 @@ } ], "previews": [], - "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -236063,7 +236063,7 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

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

List issues in an organization assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

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

\n

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

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

List issues in a repository. Only open issues will be listed.

\n

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

", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

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

\n

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

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

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

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

\n

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

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

Issue owners and users with push access can edit an issue.

", + "descriptionHTML": "

Issue owners and users with push access can edit an issue.

\n

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

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

List issues across owned and member repositories assigned to the authenticated user.

\n

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

", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

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

\n

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

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

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

\n

By default, issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

By default, issue comments are ordered by ascending ID.

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

", + "descriptionHTML": "

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

\n

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

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

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

\n

Issue comments are ordered by ascending ID.

", + "descriptionHTML": "

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

\n

Issue comments are ordered by ascending ID.

\n

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

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

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

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

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

This method returns the contents of the repository's license file, if one is detected.

\n

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.

", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
    • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -356074,7 +356074,7 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "requestPath": "/repos/{owner}/{repo}/pages/deployments", "title": "Create a GitHub Pages deployment", "category": "pages", "subcategory": "pages", @@ -356167,7 +356167,7 @@ "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", "examples": [ - "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" ] }, "page_url": { @@ -368474,7 +368474,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
  • application/vnd.github.patch: For more information, see \"git-format-patch\" in the Git documentation.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -372341,7 +372341,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -376160,7 +376160,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
    • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
    • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
    • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -380029,7 +380029,7 @@ } ], "previews": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -380884,7 +380884,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.

", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -381081,7 +381081,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note: Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -382084,7 +382084,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

\n

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

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

Provides details for a review comment.

", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

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

Enables you to edit a review comment.

", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

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

Lists all review comments for a pull request. By default, review comments are in ascending order by ID.

", + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

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

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

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

" + "description": "

This parameter is deprecated. Use line instead. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -384808,7 +384808,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"Create an issue comment.\" We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

Note: The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

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

The list of reviews returns in chronological order.

", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

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

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.

" + "description": "

The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

" }, { "type": "string", @@ -398305,7 +398305,7 @@ } ], "previews": [], - "descriptionHTML": "

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

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

Retrieves a pull request review by its ID.

", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

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

Update the review summary comment with new text.

", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

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

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

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

List comments for a specific pull request review.

", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

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

Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note: To dismiss a pull request review on a protected branch,\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.

\n

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

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

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

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

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit\n:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

\n

Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:
    • \n
  • 1 MB or smaller: All features of this endpoint are supported.
    • \n
  • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty string and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
  • Greater than 100 MB: This endpoint is not supported.
    • \n
\n

If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink:\nIf the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.

\n

If the content is a submodule:\nThe submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.

\n

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the\ngithub.com URLs (html_url and _links[\"html\"]) will have null values.

", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
    • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
    • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
    • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
    • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
    • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
      • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
      • \n
    • Greater than 100 MB: This endpoint is not supported.
      • \n
    \n
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -458988,7 +458988,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -459200,7 +459200,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

READMEs support custom media types for retrieving the raw content or rendered HTML.

", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
    • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 6e6fffc702..37b90db3d4 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -41,5 +41,5 @@ ] } }, - "sha": "e44bcaa6f0d15e9c8c558b5023595ef39ad0f15a" + "sha": "ec36bcff2ea7a3020350434873fa9e05d94a2d2d" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index d848046de2..86ebae8009 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -15226,7 +15226,7 @@ "isRequired": true }, { - "type": "string or null", + "type": "null or string or array", "name": "value", "description": "

The value assigned to the property

", "isRequired": true @@ -15247,7 +15247,7 @@ "isRequired": true }, { - "type": "string or null", + "type": "null or string or array", "name": "value", "description": "

The value assigned to the property

", "isRequired": true @@ -48051,34 +48051,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, { "type": "object", "name": "sender", @@ -207064,6 +207036,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -207462,6 +207444,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -207860,6 +207852,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -208258,6 +208260,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -208444,6 +208456,414 @@ ], "action": "revoked", "category": "secret_scanning_alert" + }, + "validated": { + "descriptionHtml": "

A secret scanning alert was validated.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "validated" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "

The security alert number.

" + }, + { + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, + { + "type": "null", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "

The REST API URL of the alert resource.

" + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

" + }, + { + "type": "string", + "name": "locations_url", + "description": "

The REST API URL of the code locations for this alert.

" + }, + { + "type": "string or null", + "name": "resolution", + "description": "

The reason for resolving the alert.

", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "

The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, + { + "type": "object", + "name": "resolved_by", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "

An optional comment to resolve an alert.

" + }, + { + "type": "string", + "name": "secret_type", + "description": "

The type of secret that secret scanning detected.

" + }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "

Whether push protection was bypassed for the detected secret.

" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "validated", + "category": "secret_scanning_alert" } }, "secret_scanning_alert_location": { @@ -208657,6 +209077,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json index b5f614e64a..87819188ac 100644 --- a/src/webhooks/data/ghae/schema.json +++ b/src/webhooks/data/ghae/schema.json @@ -46355,34 +46355,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, { "type": "object", "name": "sender", @@ -184781,6 +184753,16 @@ "type": "string", "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" + }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] } ] }, @@ -185039,6 +185021,16 @@ "type": "string", "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" + }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] } ] }, @@ -185297,6 +185289,16 @@ "type": "string", "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" + }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] } ] }, @@ -185555,6 +185557,16 @@ "type": "string", "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" + }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] } ] }, @@ -185814,6 +185826,16 @@ "type": "string", "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" + }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] } ] }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index ba9842862f..44e019369e 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -15290,7 +15290,7 @@ "isRequired": true }, { - "type": "string or null", + "type": "null or string or array", "name": "value", "description": "

The value assigned to the property

", "isRequired": true @@ -15311,7 +15311,7 @@ "isRequired": true }, { - "type": "string or null", + "type": "null or string or array", "name": "value", "description": "

The value assigned to the property

", "isRequired": true @@ -48115,34 +48115,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, { "type": "object", "name": "sender", @@ -207128,6 +207100,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -207526,6 +207508,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -207924,6 +207916,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -208322,6 +208324,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -208508,6 +208520,414 @@ ], "action": "revoked", "category": "secret_scanning_alert" + }, + "validated": { + "descriptionHtml": "

A secret scanning alert was validated.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "validated" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "

The security alert number.

" + }, + { + "type": "string", + "name": "created_at", + "description": "

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, + { + "type": "null", + "name": "updated_at", + "description": "" + }, + { + "type": "string", + "name": "url", + "description": "

The REST API URL of the alert resource.

" + }, + { + "type": "string", + "name": "html_url", + "description": "

The GitHub URL of the alert resource.

" + }, + { + "type": "string", + "name": "locations_url", + "description": "

The REST API URL of the code locations for this alert.

" + }, + { + "type": "string or null", + "name": "resolution", + "description": "

The reason for resolving the alert.

", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "

The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, + { + "type": "object", + "name": "resolved_by", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "

An optional comment to resolve an alert.

" + }, + { + "type": "string", + "name": "secret_type", + "description": "

The type of secret that secret scanning detected.

" + }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "

Whether push protection was bypassed for the detected secret.

" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "

A GitHub user.

", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "

The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "

The GitHub user that triggered the event. This property is included in every webhook payload.

", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "validated", + "category": "secret_scanning_alert" } }, "secret_scanning_alert_location": { @@ -208721,6 +209141,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghes-3.10/schema.json b/src/webhooks/data/ghes-3.10/schema.json index 9cee6cbe08..dfa9e5606c 100644 --- a/src/webhooks/data/ghes-3.10/schema.json +++ b/src/webhooks/data/ghes-3.10/schema.json @@ -46508,34 +46508,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, { "type": "object", "name": "sender", @@ -189208,6 +189180,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -189606,6 +189588,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -190004,6 +189996,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -190402,6 +190404,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -190801,6 +190813,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghes-3.11/schema.json b/src/webhooks/data/ghes-3.11/schema.json index a1cfb5ca0e..b5b8397390 100644 --- a/src/webhooks/data/ghes-3.11/schema.json +++ b/src/webhooks/data/ghes-3.11/schema.json @@ -46632,34 +46632,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, { "type": "object", "name": "sender", @@ -193805,6 +193777,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -194203,6 +194185,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -194601,6 +194593,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -194999,6 +195001,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -195398,6 +195410,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json index 90be09a7ed..f2bd35f5a1 100644 --- a/src/webhooks/data/ghes-3.8/schema.json +++ b/src/webhooks/data/ghes-3.8/schema.json @@ -41320,34 +41320,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, { "type": "object", "name": "sender", @@ -179933,6 +179905,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -180331,6 +180313,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -180729,6 +180721,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -181127,6 +181129,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -181526,6 +181538,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/data/ghes-3.9/schema.json b/src/webhooks/data/ghes-3.9/schema.json index 2802bed9d9..ecf7b223d3 100644 --- a/src/webhooks/data/ghes-3.9/schema.json +++ b/src/webhooks/data/ghes-3.9/schema.json @@ -42690,34 +42690,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.

", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "

The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.

", - "childParamsGroups": [] - }, { "type": "object", "name": "sender", @@ -183960,6 +183932,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -184358,6 +184340,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -184756,6 +184748,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -185154,6 +185156,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -185553,6 +185565,16 @@ "name": "secret_type", "description": "

The type of secret that secret scanning detected.

" }, + { + "type": "string", + "name": "validity", + "description": "

The token status as of the latest validity check.

", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, { "type": "boolean or null", "name": "push_protection_bypassed", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 82ff3502a2..26299906f7 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "e44bcaa6f0d15e9c8c558b5023595ef39ad0f15a" + "sha": "ec36bcff2ea7a3020350434873fa9e05d94a2d2d" } \ No newline at end of file From 55e3d46c4f41a0a1d362ac73b64af16c463b2136 Mon Sep 17 00:00:00 2001 From: Jess Hosman <1183847+jhosman@users.noreply.github.com> Date: Wed, 24 Jan 2024 18:50:29 -0700 Subject: [PATCH 19/23] Remove Media Types info from REST stub files (#48566) --- content/rest/activity/starring.md | 8 -- content/rest/code-scanning/code-scanning.md | 10 -- content/rest/gitignore/gitignore.md | 2 - content/rest/issues/comments.md | 2 - content/rest/issues/issues.md | 4 - content/rest/pulls/comments.md | 2 - content/rest/pulls/reviews.md | 2 - content/rest/repos/contents.md | 24 ---- .../getting-started-with-the-rest-api.md | 3 + content/rest/using-the-rest-api/index.md | 2 - .../rest/using-the-rest-api/media-types.md | 135 ------------------ .../pull_requests/issues-media-types.md | 10 -- 12 files changed, 3 insertions(+), 201 deletions(-) delete mode 100644 content/rest/using-the-rest-api/media-types.md delete mode 100644 data/reusables/pull_requests/issues-media-types.md diff --git a/content/rest/activity/starring.md b/content/rest/activity/starring.md index 80914756eb..61bb2ee990 100644 --- a/content/rest/activity/starring.md +++ b/content/rest/activity/starring.md @@ -25,12 +25,4 @@ below). For more information, see the REST API "[AUTOTITLE](/rest/activity/watch In responses from the REST API, `watchers`, `watchers_count`, and `stargazers_count` correspond to the number of users that have starred a repository, whereas `subscribers_count` corresponds to the number of watchers. -### Custom media types for starring - -There is one supported custom media type for these endpoints. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`. - - application/vnd.github.star+json - -For more information about media types, see "[AUTOTITLE](/rest/overview/media-types)." - diff --git a/content/rest/code-scanning/code-scanning.md b/content/rest/code-scanning/code-scanning.md index 701276fe58..6f00ce7be6 100644 --- a/content/rest/code-scanning/code-scanning.md +++ b/content/rest/code-scanning/code-scanning.md @@ -23,14 +23,4 @@ autogenerated: rest You can retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[AUTOTITLE](/code-security/code-scanning)." -### Custom media type for {% data variables.product.prodname_code_scanning %} - -There is one supported custom media type for {% data variables.product.prodname_code_scanning %} endpoints. - - application/sarif+json - -You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. For more information about this operation, see "[Get a {% data variables.product.prodname_code_scanning %} analysis for a repository](#get-a-code-scanning-analysis-for-a-repository)." When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than the summary of the analysis that's returned when you use the default media type. The response also includes additional data such as the `github/alertNumber` and `github/alertUrl` properties. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). - -For more information, see "[AUTOTITLE](/rest/overview/media-types)." - diff --git a/content/rest/gitignore/gitignore.md b/content/rest/gitignore/gitignore.md index a97d936959..c2b7011719 100644 --- a/content/rest/gitignore/gitignore.md +++ b/content/rest/gitignore/gitignore.md @@ -19,6 +19,4 @@ autogenerated: rest When you create a new repository on {% data variables.location.product_location %} via the API, you can specify a [.gitignore template](/get-started/getting-started-with-git/ignoring-files) to apply to the repository upon creation. You can use the REST API to get .gitignore templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). -You can use the `application/vnd.github.raw` custom media type when getting a gitignore template. For more information, see "[AUTOTITLE](/rest/overview/media-types)." - diff --git a/content/rest/issues/comments.md b/content/rest/issues/comments.md index 2dc7b63d34..c6f642d6bf 100644 --- a/content/rest/issues/comments.md +++ b/content/rest/issues/comments.md @@ -17,6 +17,4 @@ autogenerated: rest You can use the REST API to create and manage comments on issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %} To manage pull request review comments, see "[AUTOTITLE](/rest/pulls/comments)." -{% data reusables.pull_requests.issues-media-types %} - diff --git a/content/rest/issues/issues.md b/content/rest/issues/issues.md index 493298add3..7246524b80 100644 --- a/content/rest/issues/issues.md +++ b/content/rest/issues/issues.md @@ -11,8 +11,4 @@ topics: autogenerated: rest --- -## About issues - -{% data reusables.pull_requests.issues-media-types %} - diff --git a/content/rest/pulls/comments.md b/content/rest/pulls/comments.md index c01ba1256d..5ba14ee79a 100644 --- a/content/rest/pulls/comments.md +++ b/content/rest/pulls/comments.md @@ -17,6 +17,4 @@ autogenerated: rest Pull request review comments are comments made on a portion of the unified diff during a pull request review. These are different from commit comments and issue comments in a pull request. For more information, see "[AUTOTITLE](/rest/commits/comments)" and "[AUTOTITLE](/rest/issues/comments)." -{% data reusables.pull_requests.issues-media-types %} - diff --git a/content/rest/pulls/reviews.md b/content/rest/pulls/reviews.md index f3ad0a1e46..1c9efbcd96 100644 --- a/content/rest/pulls/reviews.md +++ b/content/rest/pulls/reviews.md @@ -17,6 +17,4 @@ autogenerated: rest Pull Request Reviews are groups of pull request review comments on a pull request, grouped together with a state and optional body comment. -{% data reusables.pull_requests.issues-media-types %} - diff --git a/content/rest/repos/contents.md b/content/rest/repos/contents.md index dc4470c979..243148fa73 100644 --- a/content/rest/repos/contents.md +++ b/content/rest/repos/contents.md @@ -15,28 +15,4 @@ topics: autogenerated: rest --- -## About repository contents - -To request the raw format or rendered HTML (when supported), use custom media types for repository contents. - -### Custom media types for repository contents - -[READMEs](/rest/repos#get-a-repository-readme), [files](/rest/repos#get-repository-content), and [symlinks](/rest/repos#get-repository-content) support the following custom media types: - - application/vnd.github.raw - application/vnd.github.html - -Use the `.raw` media type to retrieve the contents of the file. - -For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). - -[All objects](/rest/repos#get-repository-content) support the following custom media type: - - application/vnd.github.object - -Use the `object` media type parameter to retrieve the contents in a consistent object format regardless of the content type. For example, instead of an array of objects -for a directory, the response will be an object with an `entries` attribute containing the array of objects. - -For more information about the use of media types in the API, see "[AUTOTITLE](/rest/overview/media-types)." - diff --git a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md index e03bebee04..a68af16923 100644 --- a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md +++ b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md @@ -13,6 +13,9 @@ redirect_from: - /rest/initialize-the-repo - /rest/overview/resources-in-the-rest-api - /rest/using-the-rest-api/resources-in-the-rest-api + - /v3/media + - /rest/overview/media-types + - /rest/using-the-rest-api/media-types --- ## Introduction diff --git a/content/rest/using-the-rest-api/index.md b/content/rest/using-the-rest-api/index.md index 6a27334f01..b009216bd2 100644 --- a/content/rest/using-the-rest-api/index.md +++ b/content/rest/using-the-rest-api/index.md @@ -13,7 +13,6 @@ children: - /rate-limits-for-the-rest-api - /using-pagination-in-the-rest-api - /libraries-for-the-rest-api - - /media-types - /best-practices-for-using-the-rest-api - /troubleshooting-the-rest-api - /timezones-and-the-rest-api @@ -21,4 +20,3 @@ children: - /issue-event-types - /github-event-types --- - diff --git a/content/rest/using-the-rest-api/media-types.md b/content/rest/using-the-rest-api/media-types.md deleted file mode 100644 index 1e978757e3..0000000000 --- a/content/rest/using-the-rest-api/media-types.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: Media types -intro: Learn about media types for specifying the format of the data you want to consume. -redirect_from: - - /v3/media - - /rest/overview/media-types -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API ---- - - -Custom media types are used in the API to let consumers choose the format -of the data they wish to receive. This is done by adding one or more of -the following types to the `Accept` header when you make a request. Media types -are specific to resources, allowing them to change independently and support -formats that other resources don't. - -All {% data variables.product.product_name %} media types look like this: - - application/vnd.github.param[+json] - -The most basic media types the API supports are: - - application/vnd.github+json - application/json - -{% note %} - -**Note:** In the past, we recommended including `v3` in your `Accept` header. This is no longer required and will have no impact on your API requests. - -{% endnote %} - -If you're specifying a property (such as full/raw/etc defined below), -put it after `github`: - - application/vnd.github.raw+json - -## Comment body properties - -The body of a comment can be written in [{% data variables.product.prodname_dotcom %} Flavored Markdown](https://github.github.com/github-flavored-markdown/). The APIs to manage [issues](/rest/issues), [issue comments](/rest/issues#comments), [pull request comments](/rest/pulls#comments), and [gist comments](/rest/gists#comments) all accept these same media types: - -### Raw media type for comment body properties - - application/vnd.github.raw+json - -Return the raw markdown body. Response will include `body`. This is the -default if you do not pass any specific media type. - -### Text media type for comment body properties - - application/vnd.github.text+json - -Return a text only representation of the markdown body. Response will -include `body_text`. - -### HTML media type for comment body properties - - application/vnd.github.html+json - -Return HTML rendered from the body's markdown. Response will include -`body_html`. - -### Full media type for comment body properties - - application/vnd.github.full+json - -Return raw, text and HTML representations. Response will include `body`, -`body_text`, and `body_html`: - -## Git blob properties - -The following media types are allowed when [getting a blob](/rest/git#get-a-blob): - -### JSON media type for Git blob properties - - application/vnd.github+json - application/json - -Return JSON representation of the blob with `content` as a base64 -encoded string. This is the default if nothing is passed. - -### Raw media type for Git blob properties - - application/vnd.github.raw - -Return the raw blob data. - -## Commits, commit comparison, and pull requests - -The REST API to manage [commits](/rest/repos#commits) and [pull requests](/rest/pulls) support [diff](https://git-scm.com/docs/git-diff) and [patch](https://git-scm.com/docs/git-format-patch) formats: - -### diff media type for commits, commit comparison, and pull requests - - application/vnd.github.diff - -### patch media type for commits, commit comparison, and pull requests - - application/vnd.github.patch - -### sha media type for commits, commit comparison, and pull requests - - application/vnd.github.sha - -## Repository contents - -### Raw media type for repository contents - - application/vnd.github.raw - -Return the raw contents of a file. This is the default if you do not pass any specific media type. - -### HTML media type for repository contents - - application/vnd.github.html - -For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). - -## Gists - -### Raw media type for gists - - application/vnd.github.raw - -Return the raw contents of a gist. This is the default if you do not pass any specific media type. - -### base64 media type for gists - - application/vnd.github.base64 - -The gist contents are base64-encoded before being sent out. This can be useful if your gist contains any invalid UTF-8 sequences. diff --git a/data/reusables/pull_requests/issues-media-types.md b/data/reusables/pull_requests/issues-media-types.md deleted file mode 100644 index 0861649797..0000000000 --- a/data/reusables/pull_requests/issues-media-types.md +++ /dev/null @@ -1,10 +0,0 @@ -### Custom media types - -These are the supported media types for this set of endpoints: - - application/vnd.github.raw+json - application/vnd.github.text+json - application/vnd.github.html+json - application/vnd.github.full+json - -For more information about media types, see "[AUTOTITLE](/rest/overview/media-types)." From 84519700ea1b6fc8ce1ad248922bd02e367a51f2 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 25 Jan 2024 09:33:54 +0100 Subject: [PATCH 20/23] [Batch] Update Octernships status on GitHub Docs (#48823) --- .../about-github-octernships.md | 27 -------- .../applying-for-github-octernships.md | 64 ------------------- .../index.md | 10 --- content/education/index.md | 5 +- 4 files changed, 4 insertions(+), 102 deletions(-) delete mode 100644 content/education/explore-internship-projects-with-github-octernships/about-github-octernships.md delete mode 100644 content/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships.md delete mode 100644 content/education/explore-internship-projects-with-github-octernships/index.md diff --git a/content/education/explore-internship-projects-with-github-octernships/about-github-octernships.md b/content/education/explore-internship-projects-with-github-octernships/about-github-octernships.md deleted file mode 100644 index df27c2246d..0000000000 --- a/content/education/explore-internship-projects-with-github-octernships/about-github-octernships.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: 'About {% data variables.product.prodname_octernships %}' -intro: 'You can apply to paid professional experiences through your {% data variables.product.prodname_dotcom %} account and {% data variables.product.prodname_global_campus %}.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' ---- - -{% data reusables.education.octernships-availability %} - -## About {% data variables.product.prodname_octernships %} - -If you're over 18 years old, have been accepted to {% data variables.product.prodname_global_campus %}, and have an active {% data variables.product.prodname_dotcom %} account, you can use the {% data variables.product.prodname_octernships %} program to seek out and apply for paid remote internships from organizations partnering with {% data variables.product.prodname_dotcom %}. - -You can use the {% data variables.product.prodname_octernships %} website to browse the current projects and apply to up to four internships at a time. - -Before you can apply, you must have been accepted to {% data variables.product.prodname_global_campus %}. For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)." - -To learn more about the {% data variables.product.prodname_octernships %} application process for students, see "[AUTOTITLE](/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships)." - -## Applying to become a {% data variables.product.prodname_octernships %} partner organization - -If you're interested in partnering with {% data variables.product.prodname_dotcom %} and offering internships through {% data variables.product.prodname_octernships %}, you can find out more in the handbook at [github.com/education/Octernships](https://github.com/education/Octernships). - -## Further reading - -- [{% data variables.product.prodname_octernships %} FAQ](https://education.github.com/students/octernships#faq) diff --git a/content/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships.md b/content/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships.md deleted file mode 100644 index 63700f86eb..0000000000 --- a/content/education/explore-internship-projects-with-github-octernships/applying-for-github-octernships.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: 'Applying for {% data variables.product.prodname_octernships %}' -intro: 'Learn how to apply to paid professional experiences with {% data variables.product.prodname_octernships %}.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' ---- - -{% data reusables.education.octernships-availability %} - -## Application process - -To apply for internships, you must meet the following requirements: - -- You have been accepted to {% data variables.product.prodname_global_campus %}. For more information, including how to apply, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)." -- You are at least 18 years old. -- You have an active {% data variables.product.prodname_dotcom %} account. -- You are a resident of one of the countries where {% data variables.product.prodname_octernships %} is available. - -You can find and apply for internships at [education.github.com/students/octernships](https://education.github.com/students/octernships). You can apply for up to four internships at any one time. In other words, you can always have up to four applications simultaneously, as many times as you would like, as long as you are an eligible student. - -{% note %} - -**Note:** Only eligible students can view {% data variables.product.prodname_octernships %} on Global Campus. For more information, see the "[{% data variables.product.prodname_octernships %} FAQ](https://education.github.com/students/octernships#faq)." - -{% endnote %} - -Each internship project has an assignment to complete. The assignment consists of a problem statement, videos, and other content. When you apply for a project, you can then complete the assignment and submit your work in the repository created for you. - -You may then be invited to a remote interview and following the interview, the partner organization can decide whether to offer the internship project to you. If successful, you will receive an email notification and will be able to accept or decline the project on your [{% data variables.product.prodname_octernships %} dashboard](https://education.github.com/globalcampus/octernships). - -If you choose to accept an internship project, you will be asked to submit your Discord username so the {% data variables.product.prodname_education %} team can invite you to a Discord server to communicate with partner organizations, the {% data variables.product.prodname_education %}, and other students. - -## Finding and applying for a {% data variables.product.prodname_octernship_singular %} - -You can use the {% data variables.product.prodname_octernships %} website to find and apply to internships. - -1. Navigate to [education.github.com/students/octernship](https://education.github.com/students/octernships). -1. If you are not already signed in, click **Sign in** on the top right of the website to sign in to your {% data variables.product.prodname_dotcom %} account. -1. Click **Explore Octernships**. -1. Browse the available opportunities and information, such as the closing date for submitting the assignment, and click **I'm interested** on an opportunity. If **I'm interested** is disabled, you are not eligible. -1. Click the link in the confirmation dialog to view the repository containing your assignment. -1. Accept **Terms of Service** of the program. You must accept it to move forward. - -You can find all the projects that you have applied to, and links to the assignment repositories, on the left of the {% data variables.product.prodname_octernships %} dashboard. -Use the assignment repository to complete the task provided by the organization and commit your work for the company to review. - -The company you applied for will review all applications and get back in few days or weeks depending on the number of applications. - -If you get accepted or rejected by the organization, you will receive an email as well as a notification on the {% data variables.product.prodname_octernships %} dashboard. - -## Accepting a {% data variables.product.prodname_octernship_singular %} - -If you are successful in your application, you will be notified by email. You can also visit your {% data variables.product.prodname_octernships %} dashboard to accept any successful applications. If no action is taken it will be declined automatically. - -1. Follow the link in your email or navigate to [education.github.com/students/octernships](https://education.github.com/students/octernships). -1. If you are not already signed in, click **Sign in** on the top right of the website to sign in to your {% data variables.product.prodname_dotcom %} account. -1. Projects that you have been accepted for are displayed above the others. To accept a project, click **Accept**. -1. To enable the {% data variables.product.prodname_education %} team to invite you to the Discord server, type your Discord username in the text box. For more information, see the [Beginner's Guide to Discord](https://support.discord.com/hc/en-us/articles/360045138571-Beginner-s-Guide-to-Discord) in the Discord documentation. -1. Click **I accept the project**. - -## Further reading - -- [{% data variables.product.prodname_octernships %} FAQ](https://education.github.com/students/octernships#faq) diff --git a/content/education/explore-internship-projects-with-github-octernships/index.md b/content/education/explore-internship-projects-with-github-octernships/index.md deleted file mode 100644 index f332579438..0000000000 --- a/content/education/explore-internship-projects-with-github-octernships/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: 'Explore internship projects with {% data variables.product.prodname_octernships %}' -shortTitle: '{% data variables.product.prodname_octernships %}' -intro: 'You can apply to paid professional experiences through your {% data variables.product.prodname_dotcom %} account and {% data variables.product.prodname_global_campus %}.' -versions: - fpt: '*' -children: - - about-github-octernships - - applying-for-github-octernships ---- diff --git a/content/education/index.md b/content/education/index.md index 930af96422..9499bf77b8 100644 --- a/content/education/index.md +++ b/content/education/index.md @@ -4,6 +4,10 @@ shortTitle: "{% data variables.product.prodname_education %}" intro: '{% data variables.product.prodname_education %} helps you teach or learn software development with the tools and support of {% data variables.product.company_short %}''s platform and community.' introLinks: quickstart: /education/quickstart +redirect_from: + - /education/explore-internship-projects-with-github-octernships/about-github-octernships + - /education/explore-internship-projects-with-github-octernships/applying-for-github-octernships + - /education/explore-internship-projects-with-github-octernships featuredLinks: startHere: - /education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student @@ -29,6 +33,5 @@ children: - /explore-the-benefits-of-teaching-and-learning-with-github-education - /contribute-with-github-community-exchange - /manage-coursework-with-github-classroom - - /explore-internship-projects-with-github-octernships - /guides --- From 7cde57d1f93c0486276a3cf8243e2cbd2cf71755 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Thu, 25 Jan 2024 05:25:40 -0500 Subject: [PATCH 21/23] Remove GHAE in Liquid and front matter (10) (#48830) Co-authored-by: Matt Pollard --- .../about-self-hosted-runners.md | 2 +- .../understanding-github-actions.md | 2 +- .../security-hardening-for-github-actions.md | 4 ++-- .../iam-configuration-reference/index.md | 4 +--- .../saml-configuration-reference.md | 21 +++++-------------- ...siderations-for-external-authentication.md | 3 +-- .../identity-and-access-management/index.md | 4 +--- .../about-identity-and-access-management.md | 3 +-- .../about-saml-for-enterprise-iam.md | 5 ++--- ...saml-single-sign-on-for-your-enterprise.md | 9 ++++---- .../using-saml-for-enterprise-iam/index.md | 2 +- .../configuring-custom-footers.md | 3 +-- .../managing-dormant-users.md | 5 ++--- .../viewing-people-in-your-enterprise.md | 2 +- .../overview/about-enterprise-accounts.md | 6 +++--- ...or-security-settings-in-your-enterprise.md | 3 +-- ...-management-policies-in-your-enterprise.md | 4 ++-- .../using-oauth-apps/internal-oauth-apps.md | 3 +-- .../using-github-apps/internal-github-apps.md | 3 +-- .../managing-your-personal-access-tokens.md | 3 +-- ...-for-code-scanning-with-codeql-at-scale.md | 2 +- ...analyzing-your-code-with-codeql-queries.md | 7 +++---- ...ading-codeql-analysis-results-to-github.md | 3 +-- .../securing-your-repository.md | 2 +- .../secret-scanning-patterns.md | 3 +-- .../about-the-github-advisory-database.md | 3 +-- .../securing-accounts.md | 2 +- .../end-to-end-supply-chain/securing-code.md | 3 +-- .../about-dependency-review.md | 3 +-- .../editing-wiki-content.md | 3 +-- .../installing-github-desktop.md | 2 +- .../setting-up-github-desktop.md | 2 +- .../getting-started-with-github-desktop.md | 4 ++-- .../managing-your-theme-settings.md | 3 +-- .../contributing-to-a-project.md | 3 +-- .../types-of-github-accounts.md | 2 +- .../writing-mathematical-expressions.md | 2 +- content/graphql/guides/using-the-explorer.md | 3 +-- ...analysis-settings-for-your-organization.md | 2 +- ...ing-the-audit-log-for-your-organization.md | 6 +++--- ...he-forking-policy-for-your-organization.md | 2 +- .../roles-in-an-organization.md | 2 +- ...ation-member-to-an-outside-collaborator.md | 2 +- .../repository-roles-for-an-organization.md | 13 ++++++------ .../deleting-and-restoring-a-package.md | 3 +-- .../installing-a-package.md | 3 +-- .../publishing-a-package.md | 3 +-- .../automatically-merging-a-pull-request.md | 3 +-- .../working-with-forks/fork-a-repo.md | 5 ++--- .../troubleshooting-cloning-errors.md | 3 +-- ...ithub-actions-settings-for-a-repository.md | 7 +++---- .../about-releases.md | 3 +-- content/rest/enterprise-admin/index.md | 4 ++-- content/rest/gists/gists.md | 2 +- .../redelivering-webhooks.md | 3 +-- .../viewing-webhook-deliveries.md | 3 +-- content/webhooks/types-of-webhooks.md | 2 +- .../using-webhooks/creating-webhooks.md | 2 +- .../using-webhooks/editing-webhooks.md | 3 +-- .../actions/about-actions-for-enterprises.md | 2 +- ...-runner-management-permissions-required.md | 4 ++-- .../audit_log/audit-log-action-categories.md | 2 +- data/reusables/desktop/get-an-account.md | 2 +- .../enterprise-accounts/messages-tab.md | 2 +- ...r-usernames-for-external-authentication.md | 2 +- .../github-connect/sync-frequency.md | 2 +- .../outside-collaborators-use-seats.md | 2 +- .../organizations/team-synchronization.md | 2 +- ...forks_from_private_repositories_warning.md | 2 +- 69 files changed, 97 insertions(+), 144 deletions(-) diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md index c7f0397242..8d51406611 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md @@ -144,7 +144,7 @@ The self-hosted runner connects to {% data variables.product.product_name %} to {% ifversion fpt or ghec %} Since the self-hosted runner opens a connection to {% data variables.location.product_location %}, you do not need to allow {% data variables.product.prodname_dotcom %} to make inbound connections to your self-hosted runner. -{% elsif ghes or ghae %} +{% elsif ghes %} Only an outbound connection from the runner to {% data variables.location.product_location %} is required. There is no need for an inbound connection from {% data variables.location.product_location %} to the runner. For caching to work, the runner must be able to communicate with the blob storage and directly download content from it. {%- endif %} diff --git a/content/actions/learn-github-actions/understanding-github-actions.md b/content/actions/learn-github-actions/understanding-github-actions.md index 0a9884d808..d37d4bf5ce 100644 --- a/content/actions/learn-github-actions/understanding-github-actions.md +++ b/content/actions/learn-github-actions/understanding-github-actions.md @@ -30,7 +30,7 @@ layout: inline {% data variables.product.prodname_dotcom %} provides Linux, Windows, and macOS virtual machines to run your workflows, or you can host your own self-hosted runners in your own data center or cloud infrastructure. -{% elsif ghes or ghae %} +{% elsif ghes %} You must host your own Linux, Windows, or macOS virtual machines to run workflows for {% data variables.location.product_location %}. {% data reusables.actions.self-hosted-runner-locations %} diff --git a/content/actions/security-guides/security-hardening-for-github-actions.md b/content/actions/security-guides/security-hardening-for-github-actions.md index 702d4a4bd3..6b0d61b4a8 100644 --- a/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/content/actions/security-guides/security-hardening-for-github-actions.md @@ -328,9 +328,9 @@ SBOMs are available for Ubuntu, Windows, and macOS runner images. You can locate **{% data variables.product.prodname_dotcom %}-hosted** runners execute code within ephemeral and clean isolated virtual machines, meaning there is no way to persistently compromise this environment, or otherwise gain access to more information than was placed in this environment during the bootstrap process. {% endif %} -{% ifversion fpt or ghec %}**Self-hosted**{% elsif ghes or ghae %}Self-hosted{% endif %} runners for {% data variables.product.product_name %} do not have guarantees around running in ephemeral clean virtual machines, and can be persistently compromised by untrusted code in a workflow. +{% ifversion fpt or ghec %}**Self-hosted**{% elsif ghes %}Self-hosted{% endif %} runners for {% data variables.product.product_name %} do not have guarantees around running in ephemeral clean virtual machines, and can be persistently compromised by untrusted code in a workflow. -{% ifversion fpt or ghec %}As a result, self-hosted runners should almost [never be used for public repositories](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security) on {% data variables.product.product_name %}, because any user can open pull requests against the repository and compromise the environment. Similarly, be{% elsif ghes or ghae %}Be{% endif %} cautious when using self-hosted runners on private or internal repositories, as anyone who can fork the repository and open a pull request (generally those with read access to the repository) are able to compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which, depending on its settings, can grant write access to the repository. Although workflows can control access to environment secrets by using environments and required reviews, these workflows are not run in an isolated environment and are still susceptible to the same risks when run on a self-hosted runner. +{% ifversion fpt or ghec %}As a result, self-hosted runners should almost [never be used for public repositories](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security) on {% data variables.product.product_name %}, because any user can open pull requests against the repository and compromise the environment. Similarly, be{% elsif ghes %}Be{% endif %} cautious when using self-hosted runners on private or internal repositories, as anyone who can fork the repository and open a pull request (generally those with read access to the repository) are able to compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which, depending on its settings, can grant write access to the repository. Although workflows can control access to environment secrets by using environments and required reviews, these workflows are not run in an isolated environment and are still susceptible to the same risks when run on a self-hosted runner. {% ifversion actions-disable-repo-runners %} diff --git a/content/admin/identity-and-access-management/iam-configuration-reference/index.md b/content/admin/identity-and-access-management/iam-configuration-reference/index.md index 21ba515a2a..7cd1bcd89f 100644 --- a/content/admin/identity-and-access-management/iam-configuration-reference/index.md +++ b/content/admin/identity-and-access-management/iam-configuration-reference/index.md @@ -1,10 +1,9 @@ --- title: IAM configuration reference -intro: 'You can view reference information about configuration of authentication {% ifversion ghec or ghae %}and provisioning for your enterprise on {% data variables.product.product_name %}{% elsif ghes %}for {% data variables.location.product_location %}{% endif %}.' +intro: 'You can view reference information about configuration of authentication {% ifversion ghec %}and provisioning for your enterprise on {% data variables.product.product_name %}{% elsif ghes %}for {% data variables.location.product_location %}{% endif %}.' versions: ghec: '*' ghes: '*' - ghae: '*' topics: - Accounts - Authentication @@ -14,4 +13,3 @@ children: - /saml-configuration-reference - /username-considerations-for-external-authentication --- - diff --git a/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md b/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md index 67539a65c0..8e7e41aa4b 100644 --- a/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md +++ b/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md @@ -1,11 +1,10 @@ --- title: SAML configuration reference shortTitle: SAML reference -intro: 'You can see SAML metadata for {% ifversion ghec %}your organization or enterprise on {% data variables.product.product_name %}{% elsif ghes %}{% data variables.location.product_location %}{% elsif ghae %}your enterprise on {% data variables.product.product_name %}{% endif %}, and you can learn more about available SAML attributes and response requirements.' +intro: 'You can see SAML metadata for {% ifversion ghec %}your organization or enterprise on {% data variables.product.product_name %}{% elsif ghes %}{% data variables.location.product_location %}{% endif %}, and you can learn more about available SAML attributes and response requirements.' versions: ghec: '*' ghes: '*' - ghae: '*' type: reference topics: - Accounts @@ -19,7 +18,7 @@ redirect_from: ## About SAML configuration -To use SAML single sign-on (SSO) for authentication to {% data variables.product.product_name %}, you must configure both your external SAML identity provider (IdP) and {% ifversion ghes %}{% data variables.location.product_location %}{% elsif ghec %}your enterprise or organization on {% data variables.location.product_location %}{% elsif ghae %}your enterprise on {% data variables.product.product_name %}{% endif %}. In a SAML configuration, {% data variables.product.product_name %} functions as a SAML service provider (SP). For more information about authentication for your enterprise, see "[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/about-identity-and-access-management#authentication-methods)." +To use SAML single sign-on (SSO) for authentication to {% data variables.product.product_name %}, you must configure both your external SAML identity provider (IdP) and {% ifversion ghes %}{% data variables.location.product_location %}{% elsif ghec %}your enterprise or organization on {% data variables.location.product_location %}{% endif %}. In a SAML configuration, {% data variables.product.product_name %} functions as a SAML service provider (SP). For more information about authentication for your enterprise, see "[AUTOTITLE](/admin/identity-and-access-management/understanding-iam-for-enterprises/about-identity-and-access-management#authentication-methods)." {% data variables.product.product_name %} provides integration according to the SAML 2.0 specification. For more information, see the [SAML Wiki](https://wiki.oasis-open.org/security) on the OASIS website. @@ -63,16 +62,6 @@ The SP metadata for {% data variables.location.product_location %} is available | SP Assertion Consumer Service (ACS) URL | Reply, recipient, or destination URL | URL where IdP sends SAML responses | `http(s)://HOSTNAME/saml/consume` | | SP Single Sign-On (SSO) URL | | URL where IdP begins SSO | `http(s)://HOSTNAME/sso` | -{% elsif ghae %} - -The SP metadata for your enterprise on {% data variables.product.product_name %} is available at `https://HOSTNAME/saml/metadata`, where **HOSTNAME** is the hostname for your enterprise on {% data variables.product.product_name %}. {% data variables.product.product_name %} uses the `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` binding. - -| Value | Other names | Description | Example | -| :- | :- | :- | :- | -| SP Entity ID | SP URL, audience restriction | Your top-level URL for {% data variables.product.product_name %} | `https://HOSTNAME` | -| SP Assertion Consumer Service (ACS) URL | Reply, recipient, or destination URL | URL where IdP sends SAML responses | `https://HOSTNAME/saml/consume` | -| SP Single Sign-On (SSO) URL | | URL where IdP begins SSO | `https://HOSTNAME/sso` | - {% endif %} ## SAML attributes @@ -82,7 +71,7 @@ The following SAML attributes are available for {% data variables.product.produc | Name | Required | Description | | :- | :- | :- | | `NameID` | {% octicon "check" aria-label="Required" %} | A persistent user identifier. Any persistent name identifier format may be used. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."

{% note %}**Note:** It's important to use a human-readable, persistent identifier. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} | -| `SessionNotOnOrAfter` | {% octicon "x" aria-label="Optional" %} | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec or ghae %}your enterprise's resources{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | +| `SessionNotOnOrAfter` | {% octicon "x" aria-label="Optional" %} | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec %}your enterprise's resources{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | {%- ifversion ghes %} | `administrator` | {% octicon "x" aria-label="Optional" %} | When the value is `true`, {% data variables.product.product_name %} will automatically promote the user to be a {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %}. Setting this attribute to anything but `true` will result in demotion, as long as the value is not blank. Omitting this attribute or leaving the value blank will not change the role of the user. | | `username` | {% octicon "x" aria-label="Optional" %} | The username for {% data variables.location.product_location %}. | @@ -136,9 +125,9 @@ To specify more than one value for an attribute, use multiple `= 3.4' type: how_to topics: - Enterprise @@ -15,7 +14,7 @@ redirect_from: - /admin/configuration/configuring-your-enterprise/configuring-custom-footers --- -## About custom footers for {% ifversion ghec or ghae %}your enterprise{% elsif ghes %}{% data variables.product.product_name %}{% endif %} +## About custom footers for {% ifversion ghec %}your enterprise{% elsif ghes %}{% data variables.product.product_name %}{% endif %} You can configure the web UI for {% data variables.product.product_name %} to display a custom footer with up to five additional links. The custom footer appears above the default {% data variables.product.prodname_dotcom %} footer{% ifversion ghes %}, to all users and on all pages{% elsif ghec %} to all enterprise members and collaborators, on all repository and organization pages for repositories and organizations that belong to the enterprise{% endif %}. diff --git a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/managing-dormant-users.md b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/managing-dormant-users.md index 274da19541..26edd4985f 100644 --- a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/managing-dormant-users.md +++ b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/managing-dormant-users.md @@ -8,11 +8,10 @@ redirect_from: - /admin/user-management/managing-dormant-users - /admin/user-management/managing-users-in-your-enterprise/managing-dormant-users intro: '{% data reusables.enterprise-accounts.dormant-user-activity-threshold %}' -permissions: "{% ifversion ghec or ghae %}Enterprise owners can manage dormant users for an enterprise.{% elsif ghes %}Site administrators can manage dormant users on a {% data variables.product.product_name %} instance.{% endif %}" +permissions: "{% ifversion ghec %}Enterprise owners can manage dormant users for an enterprise.{% elsif ghes %}Site administrators can manage dormant users on a {% data variables.product.product_name %} instance.{% endif %}" versions: ghec: '*' ghes: '*' - ghae: '*' type: how_to topics: - Accounts @@ -28,7 +27,7 @@ topics: When assessing user dormancy, we only consider organizations, repositories, or sign-on events that are associated with the enterprise. For example, a user who has recently commented on an issue in a public repository outside of the enterprise may be considered dormant, while a user who has commented on an issue in a public repository within the enterprise will not be considered dormant. {% endif %} -A user account is considered to be dormant if the user {% ifversion ghec or ghae %} hasn't performed any of the previous activities in the past 90 days.{% elsif ghes %} meets the following criteria: +A user account is considered to be dormant if the user {% ifversion ghec %} hasn't performed any of the previous activities in the past 90 days.{% elsif ghes %} meets the following criteria: - The user's account has existed for longer than the dormancy threshold {% data variables.location.product_location %}. - The user hasn't performed any of the previous activities within the dormancy threshold. diff --git a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md index 41a7e8ea2c..5ebe6a6dfd 100644 --- a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md @@ -193,7 +193,7 @@ You can view a list of all dormant users {% ifversion ghes %} who have not been ## Filtering by member type{% ifversion ghec %} in an {% data variables.enterprise.prodname_emu_enterprise %}{% endif %} -{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, you{% elsif ghes or ghae %}You{% endif %} can filter the member list of an organization by type to determine if memberships are managed through an IdP or managed directly. Memberships managed through an IdP were added through an IdP group, and the IdP group was connected to a team within the organization. Memberships managed directly were added to the organization manually. The way a membership is managed in an organization determines how it must be removed. You can use this filter to determine how members were added to an organization, so you know how to remove them.{% ifversion ghec %} For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#about-organization-membership-management)."{% endif %} +{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, you{% elsif ghes %}You{% endif %} can filter the member list of an organization by type to determine if memberships are managed through an IdP or managed directly. Memberships managed through an IdP were added through an IdP group, and the IdP group was connected to a team within the organization. Memberships managed directly were added to the organization manually. The way a membership is managed in an organization determines how it must be removed. You can use this filter to determine how members were added to an organization, so you know how to remove them.{% ifversion ghec %} For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#about-organization-membership-management)."{% endif %} {% data reusables.enterprise-accounts.access-enterprise %} 1. Under "Organizations", in the search bar, begin typing the organization's name until it appears in the search results. diff --git a/content/admin/overview/about-enterprise-accounts.md b/content/admin/overview/about-enterprise-accounts.md index ce6f34dad5..f64a7809f3 100644 --- a/content/admin/overview/about-enterprise-accounts.md +++ b/content/admin/overview/about-enterprise-accounts.md @@ -1,6 +1,6 @@ --- title: About enterprise accounts -intro: 'With {% data variables.product.product_name %}, you can use an enterprise account to {% ifversion ghec %}enable collaboration between your organizations, while giving{% elsif ghes or ghae %}give{% endif %} administrators a single point of visibility and management.' +intro: 'With {% data variables.product.product_name %}, you can use an enterprise account to {% ifversion ghec %}enable collaboration between your organizations, while giving{% elsif ghes %}give{% endif %} administrators a single point of visibility and management.' redirect_from: - /articles/about-github-business-accounts - /articles/about-enterprise-accounts @@ -25,7 +25,7 @@ topics: Your enterprise account on {% data variables.product.prodname_dotcom_the_website %} allows you to manage multiple organizations. Your enterprise account must have a handle, like an organization or user account on {% data variables.product.prodname_dotcom %}. -{% elsif ghes or ghae %} +{% elsif ghes %} The enterprise account on {% ifversion ghes %}{% data variables.location.product_location_enterprise %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} allows you to manage the organizations{% ifversion ghes %} on{% elsif ghae %} owned by{% endif %} your {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} instance{% elsif ghae %}enterprise{% endif %}. @@ -91,7 +91,7 @@ For more information about the differences between {% data variables.product.pro ## About billing for your enterprise account -The bill for your enterprise account includes the monthly cost for each member of your enterprise. The bill includes {% ifversion ghec %}any paid licenses in organizations outside of your enterprise account, subscriptions to apps in {% data variables.product.prodname_marketplace %}, {% endif %}{% ifversion ghec or ghae %}additional paid services for your enterprise{% ifversion ghec %} like data packs for {% data variables.large_files.product_name_long %},{% endif %} and{% endif %} usage for {% data variables.product.prodname_GH_advanced_security %}. +The bill for your enterprise account includes the monthly cost for each member of your enterprise. The bill includes {% ifversion ghec %}any paid licenses in organizations outside of your enterprise account, subscriptions to apps in {% data variables.product.prodname_marketplace %}, {% endif %}{% ifversion ghec %}additional paid services for your enterprise{% ifversion ghec %} like data packs for {% data variables.large_files.product_name_long %},{% endif %} and{% endif %} usage for {% data variables.product.prodname_GH_advanced_security %}. {% ifversion ghec %} diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index fa575a61e2..bba89655aa 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -13,7 +13,6 @@ redirect_from: versions: ghec: '*' ghes: '*' - ghae: '*' type: how_to topics: - Enterprise @@ -127,6 +126,6 @@ To prevent confusion from your developers, you can change this behavior so that {%- ifversion ghec %} - "[AUTOTITLE](/admin/overview/accessing-compliance-reports-for-your-enterprise)" {%- endif %} -{%- ifversion ghec or ghae %} +{%- ifversion ghec %} - "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list)" {%- endif %} diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index d607cf44b9..e2d51499b9 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -135,8 +135,8 @@ Across all organizations owned by your enterprise, you can allow members to invi {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} -1. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -1. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes or ghae %}invitations{% endif %}", select the dropdown menu and click a policy. +1. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes %}invitations{% endif %}", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} +1. Under "Repository {% ifversion ghec %}outside collaborators{% elsif ghes %}invitations{% endif %}", select the dropdown menu and click a policy. ## Enforcing a policy for the default branch name diff --git a/content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md b/content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md index 55c431d426..d35f1ae774 100644 --- a/content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md +++ b/content/apps/oauth-apps/using-oauth-apps/internal-oauth-apps.md @@ -4,7 +4,6 @@ intro: 'Some {% data variables.product.prodname_oauth_apps %} are internal apps, versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' shortTitle: Internal apps --- @@ -13,7 +12,7 @@ Some {% data variables.product.prodname_oauth_apps %} are internal apps. These a Some of these internal apps are automatically included with {% data variables.product.company_short %} and do not require user authorization. These apps will not appear in your list of authorized {% data variables.product.prodname_oauth_apps %}. -These internal apps will appear in the user security log, but will not appear in organization{% ifversion ghes or ghae or ghec %} or enterprise{% endif %} audit logs. {% ifversion ghes or ghae or ghec %}For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)," "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)", and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise)."{% else %}For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)."{% endif %} +These internal apps will appear in the user security log, but will not appear in organization{% ifversion ghes or ghec %} or enterprise{% endif %} audit logs. {% ifversion ghes or ghec %}For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)," "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)", and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise)."{% else %}For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)."{% endif %} These {% data variables.product.prodname_oauth_apps %} are : diff --git a/content/apps/using-github-apps/internal-github-apps.md b/content/apps/using-github-apps/internal-github-apps.md index dc0a3b2f89..1d4976859c 100644 --- a/content/apps/using-github-apps/internal-github-apps.md +++ b/content/apps/using-github-apps/internal-github-apps.md @@ -4,7 +4,6 @@ intro: 'Some {% data variables.product.prodname_github_apps %} are internal apps versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' shortTitle: Internal apps --- @@ -13,7 +12,7 @@ Some {% data variables.product.prodname_github_apps %} are internal apps. These Some of these internal apps are automatically included with {% data variables.product.company_short %} and do not require user authorization. These apps will not appear in your list of authorized {% data variables.product.prodname_github_apps %} or in your list of installed {% data variables.product.prodname_github_apps %}. -These internal apps will appear in the user security log, but will not appear in organization{% ifversion ghes or ghae or ghec %} or enterprise{% endif %} audit logs. {% ifversion ghes or ghae or ghec %}For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)," "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)", and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise)."{% else %}For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)."{% endif %} +These internal apps will appear in the user security log, but will not appear in organization{% ifversion ghes or ghec %} or enterprise{% endif %} audit logs. {% ifversion ghes or ghec %}For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)," "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)", and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise)."{% else %}For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)."{% endif %} These {% data variables.product.prodname_github_apps %} are: diff --git a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md index 59c7fd1629..9c5a44361d 100644 --- a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md +++ b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md @@ -14,7 +14,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Identity @@ -100,7 +99,7 @@ For more information about best practices, see "[AUTOTITLE](/rest/overview/keepi 1. Under **Token name**, enter a name for the token. 1. Under **Expiration**, select an expiration for the token. 1. Optionally, under **Description**, add a note to describe the purpose of the token. -1. Under **Resource owner**, select a resource owner. The token will only be able to access resources owned by the selected resource owner. Organizations that you are a member of will not appear unless the organization opted in to {% data variables.product.pat_v2 %}s. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)."{% ifversion ghec or ghae %} You may be required to perform SAML single sign-on (SSO) if the selected organization requires it and you do not already have an active SAML session.{% endif %} +1. Under **Resource owner**, select a resource owner. The token will only be able to access resources owned by the selected resource owner. Organizations that you are a member of will not appear unless the organization opted in to {% data variables.product.pat_v2 %}s. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization)."{% ifversion ghec %} You may be required to perform SAML single sign-on (SSO) if the selected organization requires it and you do not already have an active SAML session.{% endif %} 1. Optionally, if the resource owner is an organization that requires approval for {% data variables.product.pat_v2 %}s, below the resource owner, in the box, enter a justification for the request. 1. Under **Repository access**, select which repositories you want the token to access. You should choose the minimal repository access that meets your needs. Tokens always include read-only access to all public repositories on {% data variables.product.prodname_dotcom %}. 1. If you selected **Only select repositories** in the previous step, under the **Selected repositories** dropdown, select the repositories that you want the token to access. diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md index a569886a6f..f88ec3b351 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md +++ b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md @@ -21,7 +21,7 @@ allowTitleToDifferFromFilename: true {% ifversion code-scanning-without-workflow %}If you need to configure a highly customizable {% data variables.product.prodname_code_scanning %} setup for many repositories in your organization, or if repositories in your organization are ineligible for default setup, you can configure {% data variables.product.prodname_code_scanning %} at scale with advanced setup.{% endif %} -To configure {% ifversion code-scanning-without-workflow %}advanced setup{% else %}{% data variables.product.prodname_code_scanning %}{% endif %} across multiple repositories, you can write a bulk configuration script. To successfully execute the script, {% data variables.product.prodname_actions %} must be enabled for the {% ifversion fpt %}organization{% elsif ghec or ghae %}organization or enterprise{% elsif ghes %}site{% endif %}. +To configure {% ifversion code-scanning-without-workflow %}advanced setup{% else %}{% data variables.product.prodname_code_scanning %}{% endif %} across multiple repositories, you can write a bulk configuration script. To successfully execute the script, {% data variables.product.prodname_actions %} must be enabled for the {% ifversion fpt %}organization{% elsif ghec %}organization or enterprise{% elsif ghes %}site{% endif %}. {% ifversion code-scanning-without-workflow %} Alternatively, if you do not need granular control over the {% data variables.product.prodname_code_scanning %} configuration for many repositories in your organization, you can quickly and easily configure {% data variables.product.prodname_code_scanning %} at scale with default setup. For more information, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale)." diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md index 7e21626253..afaeeb50a9 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md +++ b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md @@ -6,7 +6,6 @@ shortTitle: Analyzing code versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Advanced Security @@ -66,7 +65,7 @@ You must specify ``, `--format`, and `--output`. You can specify addit |--------|:--------:|-----| | `` | {% octicon "check" aria-label="Required" %} | Specify the path for the directory that contains the {% data variables.product.prodname_codeql %} database to analyze. | | `` | {% octicon "x" aria-label="Optional" %} | Specify {% data variables.product.prodname_codeql %} packs or queries to run. To run the standard queries used for {% data variables.product.prodname_code_scanning %}, omit this parameter. To see the other query suites included in the {% data variables.product.prodname_codeql_cli %} bundle, look in `//qlpacks/codeql/-queries/codeql-suites`. For information about creating your own query suite, see [AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites) in the documentation for the {% data variables.product.prodname_codeql_cli %}. -| --format | {% octicon "check" aria-label="Required" %} | Specify the format for the results file generated during analysis. A number of different formats are supported, including CSV, [SARIF](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#sarif-file), and graph formats. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghae or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning)." +| --format | {% octicon "check" aria-label="Required" %} | Specify the format for the results file generated during analysis. A number of different formats are supported, including CSV, [SARIF](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#sarif-file), and graph formats. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning)." | --output | {% octicon "check" aria-label="Required" %} | Specify the location where you want to save the SARIF results file, including the desired filename with the `.sarif` extension. | --sarif-category | {% octicon "question" aria-label="Required with multiple results sets" %} | Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository.

Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|{% ifversion code-scanning-tool-status-page %} | --sarif-add-baseline-file-info | {% octicon "x" aria-label="Optional" %} | **Recommended.** Use to submit file coverage information to the {% data variables.code-scanning.tool_status_page %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page#how-codeql-defines-scanned-files)." | {% endif %} @@ -99,7 +98,7 @@ This example analyzes a {% data variables.product.prodname_codeql %} database st ```shell $ codeql database analyze /codeql-dbs/example-repo \ javascript-code-scanning.qls --sarif-category={% ifversion codeql-language-identifiers-311 %}javascript-typescript{% else %}javascript{% endif %} \ - --format={% ifversion fpt or ghae or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %} --output=/temp/example-repo-js.sarif + --format={% ifversion fpt or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %} --output=/temp/example-repo-js.sarif > Running queries. > Compiling query plan for /codeql-home/codeql/qlpacks/codeql-javascript/AngularJS/DisablingSce.ql. @@ -119,7 +118,7 @@ To include file coverage information with your {% data variables.product.prodnam ```shell $ codeql database analyze /codeql-dbs/example-repo \ javascript-code-scanning.qls --sarif-category={% ifversion codeql-language-identifiers-311 %}javascript-typescript{% else %}javascript{% endif %} \ - --sarif-add-baseline-file-info \ --format={% ifversion fpt or ghae or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %} \ + --sarif-add-baseline-file-info \ --format={% ifversion fpt or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %} \ --output=/temp/example-repo-js.sarif ``` diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md index 70a2a7aed7..e22ce63068 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md +++ b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md @@ -6,7 +6,6 @@ product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Advanced Security @@ -105,7 +104,7 @@ You can create a SARIF file for the failed analysis using "[AUTOTITLE](/code-sec ```shell $ codeql database export-diagnostics codeql-dbs/example-repo \ - --sarif-category={% ifversion codeql-language-identifiers-311 %}javascript-typescript{% else %}javascript{% endif %} --format={% ifversion fpt or ghae or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %} \ + --sarif-category={% ifversion codeql-language-identifiers-311 %}javascript-typescript{% else %}javascript{% endif %} --format={% ifversion fpt or ghec %}sarif-latest{% else %}sarifv2.1.0{% endif %} \ --output=/temp/example-repo-js.sarif ``` diff --git a/content/code-security/getting-started/securing-your-repository.md b/content/code-security/getting-started/securing-your-repository.md index 9eeceb80a4..dffe233aa3 100644 --- a/content/code-security/getting-started/securing-your-repository.md +++ b/content/code-security/getting-started/securing-your-repository.md @@ -85,7 +85,7 @@ Dependency review is a {% data variables.product.prodname_GH_advanced_security % 1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %}Settings**. 1. Click **Security & analysis**. -1. {% ifversion ghec %}If dependency graph is not already enabled, click **Enable**.{% elsif ghes or ghae %}Check that dependency graph is configured for your enterprise.{% endif %} +1. {% ifversion ghec %}If dependency graph is not already enabled, click **Enable**.{% elsif ghes %}Check that dependency graph is configured for your enterprise.{% endif %} 1. If {% data variables.product.prodname_GH_advanced_security %} is not already enabled, click **Enable**. {% endif %} diff --git a/content/code-security/secret-scanning/secret-scanning-patterns.md b/content/code-security/secret-scanning/secret-scanning-patterns.md index 66283bcfae..9969530fd2 100644 --- a/content/code-security/secret-scanning/secret-scanning-patterns.md +++ b/content/code-security/secret-scanning/secret-scanning-patterns.md @@ -5,7 +5,6 @@ product: '{% data reusables.gated-features.secret-scanning %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: reference topics: @@ -66,7 +65,7 @@ You can see these alerts on the **Security** tab of the repository. {% ifversion If you use the REST API for secret scanning, you can use the `Secret type` to report on secrets from specific issuers. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/rest/secret-scanning)." -{% ifversion ghes or ghae or ghec %} +{% ifversion ghes or ghec %} {% note %} **Note:** You can also define custom {% data variables.product.prodname_secret_scanning %} patterns for your repository, organization, or enterprise. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md index 6f6567d90f..fcc02e43c0 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md +++ b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md @@ -5,7 +5,6 @@ versions: fpt: '*' ghec: '*' ghes: '*' - ghae: '*' type: overview topics: - Security advisories @@ -43,7 +42,7 @@ Generally, we name our supported ecosystems after the software programming langu - Composer (registry: https://packagist.org/){% ifversion GH-advisory-db-erlang-support %} - Erlang (registry: https://hex.pm/){% endif %} - Go (registry: https://pkg.go.dev/) -{%- ifversion fpt or ghec or ghes or ghae > 3.6 %} +{%- ifversion fpt or ghec or ghes %} - GitHub Actions (https://github.com/marketplace?type=actions/) {% endif %} - Maven (registry: https://repo.maven.apache.org/maven2) - npm (registry: https://www.npmjs.com/) diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md index 324e695df6..280714217a 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md +++ b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md @@ -22,7 +22,7 @@ This guide describes the highest impact changes you can make to increase account ## What's the risk? -Account security is fundamental to the security of your supply chain. If an attacker can take over your account on {% data variables.product.product_name %}, they can then make malicious changes to your code or build process. So your first goal should be to make it difficult for someone to take over your account and the accounts of other {% ifversion ghes %}users{% else %}members{% endif %} of {% ifversion fpt %}your organization{% elsif ghec or ghae %}your organization or enterprise{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. +Account security is fundamental to the security of your supply chain. If an attacker can take over your account on {% data variables.product.product_name %}, they can then make malicious changes to your code or build process. So your first goal should be to make it difficult for someone to take over your account and the accounts of other {% ifversion ghes %}users{% else %}members{% endif %} of {% ifversion fpt %}your organization{% elsif ghec %}your organization or enterprise{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. {% ifversion ghec or ghes %} diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md index 22178c2729..28498fcec3 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md +++ b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md @@ -7,7 +7,6 @@ versions: fpt: '*' ghec: '*' ghes: '*' - ghae: '*' type: overview topics: - Dependabot @@ -49,7 +48,7 @@ As a first step, you want to make a complete inventory of your dependencies. The ### Automatic detection of vulnerabilities in dependencies {% data variables.product.prodname_dependabot %} can help you by monitoring your dependencies and notifying you when they contain a known vulnerability. {% ifversion fpt or ghec or ghes %}You can even enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests that update the dependency to a secure version.{% endif %} For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)"{% ifversion fpt or ghec or ghes %} and "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)"{% endif %}. -{% ifversion fpt or ghec or ghes or ghae > 3.5 %} +{% ifversion fpt or ghec or ghes %} ### Automatic detection of vulnerabilities in pull requests diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md index 793ff72d64..0f52ecc7c2 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md @@ -6,7 +6,6 @@ shortTitle: Dependency review versions: fpt: '*' ghes: '>= 3.2' - ghae: '*' ghec: '*' type: overview topics: @@ -44,7 +43,7 @@ For more information on supply chain features available on {% data variables.pro The dependency review feature becomes available when you enable the dependency graph. For more information, see "{% ifversion ghec %}[Enabling the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph){% elsif ghes %}[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise){% endif %}." {% endif %} -{% ifversion fpt or ghec or ghes or ghae > 3.5 %} +{% ifversion fpt or ghec or ghes %} ## Dependency review enforcement diff --git a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md index eed6b3423a..c8bb19abdc 100644 --- a/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md +++ b/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md @@ -15,7 +15,6 @@ product: '{% data reusables.gated-features.wikis %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Community @@ -48,7 +47,7 @@ You can link to an image in a repository on {% data variables.product.product_na [[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]] -{% ifversion fpt or ghec or ghes or ghae > 3.6 %} +{% ifversion fpt or ghec or ghes %} ## Adding mathematical expressions and diagrams{% endif %} diff --git a/content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md b/content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md index e519ad42b6..8167fafbc6 100644 --- a/content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md +++ b/content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md @@ -14,7 +14,7 @@ versions: ## About {% data variables.product.prodname_desktop %} installation -You can install {% data variables.product.prodname_desktop %} on supported operating systems, which currently include {% data variables.desktop.mac-osx-versions %} and {% data variables.desktop.windows-versions %}. If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can connect your account to {% data variables.product.prodname_desktop %}.{% ifversion fpt or ghec %} For more information about creating an account, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes or ghae %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} +You can install {% data variables.product.prodname_desktop %} on supported operating systems, which currently include {% data variables.desktop.mac-osx-versions %} and {% data variables.desktop.windows-versions %}. If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can connect your account to {% data variables.product.prodname_desktop %}.{% ifversion fpt or ghec %} For more information about creating an account, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} {% windows %} diff --git a/content/desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md b/content/desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md index 29c38345bb..ab7c30dde0 100644 --- a/content/desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md +++ b/content/desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md @@ -23,7 +23,7 @@ If you have an account on {% data variables.product.prodname_dotcom %} or {% dat If you do not already have an account on {% data variables.location.product_location %}, create one now.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %} -{% ifversion ghec %}If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes or ghae %}If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} +{% ifversion ghec %}If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %}If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} ### Authenticating to {% data variables.product.prodname_dotcom %} diff --git a/content/desktop/overview/getting-started-with-github-desktop.md b/content/desktop/overview/getting-started-with-github-desktop.md index 43d122334c..d2d45ecaeb 100644 --- a/content/desktop/overview/getting-started-with-github-desktop.md +++ b/content/desktop/overview/getting-started-with-github-desktop.md @@ -33,7 +33,7 @@ After you have installed {% data variables.product.prodname_desktop %}, you can {% mac %} -1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes or ghae %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} +1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} {% data reusables.desktop.mac-select-desktop-menu %} 1. In the "Preferences" window, on the **Accounts** pane, click one of the **Sign In** buttons to sign in to your account on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_enterprise %}. @@ -44,7 +44,7 @@ After you have installed {% data variables.product.prodname_desktop %}, you can {% windows %} -1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes or ghae %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} +1. Before you can authenticate to {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you will need an account.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} 1. In the File drop-down menu, click **Options**. In the options window, click **Accounts** and follow the steps to sign in. For more information on authenticating, see "[AUTOTITLE](/desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop)." ![Screenshot of the "Accounts" pane in the "Options" window. Next to "GitHub.com", a button, labeled "Sign In", is outlined in orange.](/assets/images/help/desktop/windows-sign-in-github.png) diff --git a/content/get-started/accessibility/managing-your-theme-settings.md b/content/get-started/accessibility/managing-your-theme-settings.md index 30a9c404fd..043c2bb661 100644 --- a/content/get-started/accessibility/managing-your-theme-settings.md +++ b/content/get-started/accessibility/managing-your-theme-settings.md @@ -3,7 +3,6 @@ title: Managing your theme settings intro: 'You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses a light or dark mode.' versions: fpt: '*' - ghae: '*' ghes: '*' ghec: '*' topics: @@ -21,7 +20,7 @@ For choice and flexibility in how and when you use {% data variables.product.pro You may want to use a dark theme to reduce power consumption on certain devices, to reduce eye strain in low-light conditions, or because you prefer how the theme looks. -If you have low vision, you may benefit from a high contrast theme, with greater contrast between foreground and background elements.{% ifversion fpt or ghae or ghec %} If you have colorblindness, you may benefit from our light and dark colorblind themes. +If you have low vision, you may benefit from a high contrast theme, with greater contrast between foreground and background elements.{% ifversion fpt or ghec %} If you have colorblindness, you may benefit from our light and dark colorblind themes. {% endif %} diff --git a/content/get-started/exploring-projects-on-github/contributing-to-a-project.md b/content/get-started/exploring-projects-on-github/contributing-to-a-project.md index e372b8a48e..f7c5afe1a0 100644 --- a/content/get-started/exploring-projects-on-github/contributing-to-a-project.md +++ b/content/get-started/exploring-projects-on-github/contributing-to-a-project.md @@ -6,7 +6,6 @@ permissions: '{% data reusables.enterprise-accounts.emu-permission-fork %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Pull requests @@ -33,7 +32,7 @@ This tutorial uses [the Spoon-Knife project](https://github.com/octocat/Spoon-Kn 1. In the top-right corner of the page, click **Fork**. ![Screenshot of the main page of repository. A button, labeled with a fork icon and "Fork 59.3k," is outlined in dark orange.](/assets/images/help/repository/fork-button.png) -{%- ifversion fpt or ghec or ghes or ghae > 3.5 %} +{%- ifversion fpt or ghec or ghes %} 1. Under "Owner," select the dropdown menu and click an owner for the forked repository. 1. By default, forks are named the same as their upstream repositories. Optionally, to further distinguish your fork, in the "Repository name" field, type a name. 1. Optionally, in the "Description" field, type a description of your fork. diff --git a/content/get-started/learning-about-github/types-of-github-accounts.md b/content/get-started/learning-about-github/types-of-github-accounts.md index 2a039836e3..da39482db5 100644 --- a/content/get-started/learning-about-github/types-of-github-accounts.md +++ b/content/get-started/learning-about-github/types-of-github-accounts.md @@ -75,7 +75,7 @@ For more information about all the features of organizations, see "[AUTOTITLE](/ {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %} include enterprise accounts, which allow administrators to centrally manage policy and billing for multiple organizations and enable innersourcing between the organizations. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)" in the {% data variables.product.prodname_ghe_cloud %} documentation. {% elsif ghec %} Enterprise accounts allow central policy management and billing for multiple organizations. You can use your enterprise account to centrally manage policy and billing. Unlike organizations, enterprise accounts cannot directly own resources like repositories, packages, or projects. These resources are owned by organizations within the enterprise account instead. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)." -{% elsif ghes or ghae %} +{% elsif ghes %} Your enterprise account is a collection of all the organizations {% ifversion ghae %}owned by{% elsif ghes %}on{% endif %} {% data variables.location.product_location %}. You can use your enterprise account to centrally manage policy and billing. Unlike organizations, enterprise accounts cannot directly own resources like repositories, packages, or projects. These resources are owned by organizations within the enterprise account instead. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)." {% endif %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md index 3db184a546..7e0401d029 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md @@ -12,7 +12,7 @@ To enable clear communication of mathematical expressions, {% data variables.pro {% data variables.product.company_short %}'s math rendering capability uses MathJax; an open source, JavaScript-based display engine. MathJax supports a wide range of LaTeX macros, and several useful accessibility extensions. For more information, see [the MathJax documentation](http://docs.mathjax.org/en/latest/input/tex/index.html#tex-and-latex-support) and [the MathJax Accessibility Extensions Documentation](https://mathjax.github.io/MathJax-a11y/docs/#reader-guide). -Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes or ghae > 3.6 %}wikis, {% endif %}and Markdown files. +Mathematical expressions rendering is available in {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_discussions %}, pull requests, {% ifversion fpt or ghec or ghes %}wikis, {% endif %}and Markdown files. ## Writing inline expressions diff --git a/content/graphql/guides/using-the-explorer.md b/content/graphql/guides/using-the-explorer.md index ef48253441..02f8383f9c 100644 --- a/content/graphql/guides/using-the-explorer.md +++ b/content/graphql/guides/using-the-explorer.md @@ -7,14 +7,13 @@ versions: fpt: '*' ghec: '*' ghes: '*' - ghae: '*' topics: - API --- ## About the GraphQL Explorer -{% ifversion ghec or ghae %} +{% ifversion ghec %} {% note %} **Note**: If your {% data variables.product.prodname_ghe_cloud %} organization uses {% data variables.product.prodname_dotcom %}'s IP allow list, you won't be able to use the GraphQL Explorer. Instead, we recommend using an alternative GraphQL client IDE. diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md index 673e16d231..ca72e32bd0 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md @@ -51,7 +51,7 @@ You can enable or disable features for all repositories. - **{% data variables.product.prodname_secret_scanning_caps %}** - Your changes affect {% ifversion fpt %}public repositories and public npm packages these repositories may depend on.{% endif %}{% ifversion ghec %}public repositories, and private or internal repositories where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% endif %} This option controls whether or not {% data variables.secret-scanning.user_alerts %} are enabled. {% data variables.secret-scanning.partner_alerts_caps %} always runs on all public repositories. {%- ifversion org-enable-code-scanning %} -- **{% data variables.product.prodname_code_scanning_caps %}** - Your changes affect {% ifversion fpt %}public repositories{% elsif ghec %}public repositories, and private or internal repositories where {% data variables.product.prodname_GH_advanced_security %} is enabled{% elsif ghes or ghae %}repositories that are eligible for default setup using {% data variables.product.prodname_codeql %} where {% data variables.product.prodname_GH_advanced_security %} is enabled{% endif %}. {% data reusables.code-scanning.default-setup-info-link %} For repositories that are not eligible for default setup, you can configure advanced setup at the repository level. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning)." +- **{% data variables.product.prodname_code_scanning_caps %}** - Your changes affect {% ifversion fpt %}public repositories{% elsif ghec %}public repositories, and private or internal repositories where {% data variables.product.prodname_GH_advanced_security %} is enabled{% elsif ghes %}repositories that are eligible for default setup using {% data variables.product.prodname_codeql %} where {% data variables.product.prodname_GH_advanced_security %} is enabled{% endif %}. {% data reusables.code-scanning.default-setup-info-link %} For repositories that are not eligible for default setup, you can configure advanced setup at the repository level. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning)." {%- endif %} {% endif %} diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index cf5e9b0418..df59cd81fe 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -59,7 +59,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | `enterprise` | Contains activities related to enterprise settings. |{% endif %} | `hook` | Contains all activities related to webhooks. | `integration_installation` | Contains activities related to integrations installed in an account. | -| `integration_installation_request` | Contains all activities related to organization member requests for owners to approve integrations for use in the organization. |{% ifversion ghec or ghae %} +| `integration_installation_request` | Contains all activities related to organization member requests for owners to approve integrations for use in the organization. |{% ifversion ghec %} | `ip_allow_list` | Contains activities related to enabling or disabling the IP allow list for an organization. | `ip_allow_list_entry` | Contains activities related to the creation, deletion, and editing of an IP allow list entry for an organization.{% endif %} | `issue` | Contains activities related to deleting an issue. {% ifversion fpt or ghec %} @@ -81,7 +81,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | `repo` | Contains activities related to the repositories owned by your organization.{% ifversion fpt or ghec %} | `repository_advisory` | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories)." | `repository_content_analysis` | Contains all activities related to enabling or disabling data use for a private repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories)."{% endif %}{% ifversion fpt or ghec %} -| `repository_dependency_graph` | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)."{% endif %}{% ifversion ghes or ghae or ghec %} +| `repository_dependency_graph` | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)."{% endif %}{% ifversion ghes or ghec %} | `repository_secret_scanning` | Contains repository-level activities related to {% data variables.product.prodname_secret_scanning %}. For more information, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning)." {% endif %}{% ifversion secret-scanning-validity-check-audit-log %} | `repository_secret_scanning_automatic_validity_checks` | Contains repository-level activities related to enabling and disabling automatic validity checks for {% data variables.product.prodname_secret_scanning %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository)." {% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %} | `repository_secret_scanning_custom_pattern` | Contains repository-level activities related to {% data variables.product.prodname_secret_scanning %} custom patterns. For more information, see "[AUTOTITLE](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." {% endif %}{% ifversion secret-scanning-custom-pattern-push-protection-audit %} @@ -89,7 +89,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | `repository_secret_scanning_push_protection` | Contains repository-level activities related to {% data variables.product.prodname_secret_scanning %} push protection. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %} | `repository_vulnerability_alert` | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).{% ifversion fpt or ghec %} | `repository_vulnerability_alerts` | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}.{% endif %}{% ifversion custom-repository-roles %} -| `role` | Contains all activities related to [custom repository roles](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %}{% ifversion ghes or ghae or ghec %} +| `role` | Contains all activities related to [custom repository roles](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).{% endif %}{% ifversion ghes or ghec %} | `secret_scanning` | Contains organization-level configuration activities for {% data variables.product.prodname_secret_scanning %} in existing repositories. For more information, see "[AUTOTITLE](/code-security/secret-scanning/about-secret-scanning)." | `secret_scanning_new_repos` | Contains organization-level configuration activities for {% data variables.product.prodname_secret_scanning %} for new repositories created in the organization. {% endif %}{% ifversion fpt or ghec %} | `restore_member` | Triggered when an organization owner reinstates a member. For more information, see "[AUTOTITLE](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)."| diff --git a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md index 7eae76a7bc..d2a8d9d5c4 100644 --- a/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md +++ b/content/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization.md @@ -1,6 +1,6 @@ --- title: Managing the forking policy for your organization -intro: 'You can allow or prevent the forking of any private{% ifversion ghes or ghae or ghec %} and internal{% endif %} repositories owned by your organization.' +intro: 'You can allow or prevent the forking of any private{% ifversion ghes or ghec %} and internal{% endif %} repositories owned by your organization.' redirect_from: - /articles/allowing-people-to-fork-private-repositories-in-your-organization - /github/setting-up-and-managing-organizations-and-teams/allowing-people-to-fork-private-repositories-in-your-organization diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md index 144586237d..abd854411a 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md @@ -156,7 +156,7 @@ Some of the features listed below are limited to organizations using {% data var {% endrowheaders %} -{% elsif ghes or ghae %} +{% elsif ghes %} {% rowheaders %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md index 742aff444f..0067c1dba2 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/converting-an-organization-member-to-an-outside-collaborator.md @@ -22,7 +22,7 @@ shortTitle: Convert member to collaborator You can convert a member of an organization to an outside collaborator. For more information about outside collaborators, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)." -{% ifversion fpt or ghec %}If the organization is owned by an enterprise, converting{% elsif ghes or ghae %}Converting{% endif %} an organization member to an outside collaborator may be restricted. For more information, see "[Enforcing repository management policies in your enterprise]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-{% ifversion fpt or ghec %}outside-{% endif %}collaborators-to-repositories){% ifversion ghec or ghes %}."{% elsif fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +{% ifversion fpt or ghec %}If the organization is owned by an enterprise, converting{% elsif ghes %}Converting{% endif %} an organization member to an outside collaborator may be restricted. For more information, see "[Enforcing repository management policies in your enterprise]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-{% ifversion fpt or ghec %}outside-{% endif %}collaborators-to-repositories){% ifversion ghec or ghes %}."{% elsif fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} {% data reusables.organizations.outside-collaborators-use-seats %} {% data reusables.organizations.outside_collaborator_forks %} diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md index 1d74e0daaa..af01ef8211 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md @@ -11,7 +11,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Organizations @@ -102,7 +101,7 @@ Some of the features listed below are limited to organizations using {% data var | Create, edit, run, re-run, and cancel [GitHub Actions workflows](/actions) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |{% endif %} | Create and edit releases | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | View draft releases | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | -| Edit a repository's description | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion fpt or ghae or ghec %} +| Edit a repository's description | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion fpt or ghec %} | [View and install packages](/packages/learn-github-packages) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | [Publish packages](/packages/learn-github-packages/publishing-a-package) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | [Delete and restore packages](/packages/learn-github-packages/deleting-and-restoring-a-package) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% endif %} @@ -161,16 +160,16 @@ In this section, you can find the access required for security features, such as | Repository action | Read | Triage | Write | Maintain | Admin | |:---|:---:|:---:|:---:|:---:|:---:| | Receive [{% data variables.product.prodname_dependabot_alerts %} for insecure dependencies](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts) in a repository | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% octicon "check" aria-label="Yes" %} | -| [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghes or ghae or ghec %} +| [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghes or ghec %} | [Designate additional people or teams to receive security alerts](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion fpt or ghec %} -| Create [security advisories](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion ghes or ghae or ghec %} +| Create [security advisories](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion ghes or ghec %} | Manage access to {% data variables.product.prodname_GH_advanced_security %} features (see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)") | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion fpt or ghec %} -| [Enable the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository) for a private repository | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion ghes or ghae or ghec %} +| [Enable the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository) for a private repository | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion ghes or ghec %} | [View dependency reviews](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |{% endif %} | [View {% data variables.product.prodname_code_scanning %} alerts on pull requests](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | -| [View and dismiss {% data variables.secret-scanning.alerts %} in a repository](/code-security/secret-scanning/managing-alerts-from-secret-scanning) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %}{% ifversion not ghae %}{% endif %} | {% octicon "check" aria-label="Yes" %}{% ifversion not ghae %}{% endif %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghes or ghae or ghec %} -| [Resolve, revoke, or re-open {% data variables.secret-scanning.alerts %}](/code-security/secret-scanning/managing-alerts-from-secret-scanning) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %}{% ifversion not ghae %}{% endif %} | {% octicon "check" aria-label="Yes" %}{% ifversion not ghae %}{% endif %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion ghes or ghae or ghec %} +| [View and dismiss {% data variables.secret-scanning.alerts %} in a repository](/code-security/secret-scanning/managing-alerts-from-secret-scanning) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %}{% ifversion not ghae %}{% endif %} | {% octicon "check" aria-label="Yes" %}{% ifversion not ghae %}{% endif %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghes or ghec %} +| [Resolve, revoke, or re-open {% data variables.secret-scanning.alerts %}](/code-security/secret-scanning/managing-alerts-from-secret-scanning) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %}{% ifversion not ghae %}{% endif %} | {% octicon "check" aria-label="Yes" %}{% ifversion not ghae %}{% endif %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion ghes or ghec %} | [Designate additional people or teams to receive {% data variables.secret-scanning.alerts %}](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) in repositories | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %} {% endrowheaders %} 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 06242b31e0..89de698d26 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 @@ -11,7 +11,6 @@ versions: fpt: '*' ghes: '*' ghec: '*' - ghae: '*' shortTitle: Delete & restore a package --- @@ -193,7 +192,7 @@ To restore a deleted package, you must also meet one of these permission require - For organization-scoped packages: You have admin permissions to the deleted package in the organization to which the package is scoped.{% endif %} {% endif %} -{% ifversion ghae or ghes %} +{% ifversion ghes %} To delete a package, you must also have admin permissions to the repository in which the package is published. {% endif %} diff --git a/content/packages/learn-github-packages/installing-a-package.md b/content/packages/learn-github-packages/installing-a-package.md index 8529be0bca..14db3a8f9e 100644 --- a/content/packages/learn-github-packages/installing-a-package.md +++ b/content/packages/learn-github-packages/installing-a-package.md @@ -10,7 +10,6 @@ permissions: You can install any package that you have permission to view. versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' --- @@ -25,7 +24,7 @@ After you find a package, you can read the package's description and installatio ## Installing a package -You can install a package from {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. +You can install a package from {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. 1. Authenticate to {% data variables.product.prodname_registry %} using the instructions for your package client. For more information, see "[AUTOTITLE](/packages/learn-github-packages/introduction-to-github-packages#authenticating-to-github-packages)." 1. Install the package using the instructions for your package client. diff --git a/content/packages/learn-github-packages/publishing-a-package.md b/content/packages/learn-github-packages/publishing-a-package.md index c2b6e34ff1..6d2eab10aa 100644 --- a/content/packages/learn-github-packages/publishing-a-package.md +++ b/content/packages/learn-github-packages/publishing-a-package.md @@ -9,7 +9,6 @@ permissions: Anyone with write permissions for a repository can publish a packag versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' --- @@ -30,7 +29,7 @@ If a new version of a package fixes a security vulnerability, you should publish {% data reusables.package_registry.packages-classic-pat-only %} -You can publish a package to {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghae or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. +You can publish a package to {% data variables.product.prodname_registry %} using any {% ifversion fpt or ghec %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. 1. Create or use an existing {% data variables.product.pat_v1 %} with the appropriate scopes for the task you want to accomplish. For more information, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages)." 1. Authenticate to {% data variables.product.prodname_registry %} using your {% data variables.product.pat_v1 %} and the instructions for your package client. diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md index ce87da14f4..3f8077b5cf 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md @@ -5,7 +5,6 @@ product: '{% data reusables.gated-features.auto-merge %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Pull requests @@ -48,7 +47,7 @@ People with write permissions to a repository can enable auto-merge for a pull r {% endnote %} {% endif %} - {% ifversion ghes or ghae or ghec %} + {% ifversion ghes or ghec %} 1. If you chose the merge or squash and merge methods, type a commit message and description. {% endif %} 1. Click **Confirm auto-merge**. diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md index 34ada22ea9..13a47e7d09 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md @@ -13,7 +13,6 @@ permissions: '{% data reusables.enterprise-accounts.emu-permission-fork %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Pull requests @@ -61,11 +60,11 @@ You might fork a project to propose changes to the upstream repository. In this 1. In the top-right corner of the page, click **Fork**. ![Screenshot of the main page of repository. A button, labeled with a fork icon and "Fork 59.3k," is outlined in dark orange.](/assets/images/help/repository/fork-button.png) -{%- ifversion fpt or ghec or ghes or ghae > 3.5 %} +{%- ifversion fpt or ghec or ghes %} 1. Under "Owner," select the dropdown menu and click an owner for the forked repository. 1. By default, forks are named the same as their upstream repositories. Optionally, to further distinguish your fork, in the "Repository name" field, type a name. 1. Optionally, in the "Description" field, type a description of your fork. -{%- ifversion fpt or ghec or ghes or ghae > 3.6 %} +{%- ifversion fpt or ghec or ghes %} 1. Optionally, select **Copy the DEFAULT branch only**. For many forking scenarios, such as contributing to open-source projects, you only need to copy the default branch. If you do not select this option, all branches will be copied into the new fork. diff --git a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md index 91ff546b46..19d3fca253 100644 --- a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md +++ b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md @@ -15,7 +15,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Repositories @@ -95,7 +94,7 @@ If you've previously set up SSH keys, you can use the SSH clone URL instead of H ## Error: Repository not found -{% ifversion fpt or ghae or ghec %}If you see this error when cloning a repository, it means that the repository does not exist or you do not have permission to access it.{% else %}If you see this error when cloning a repository, it means that the repository does not exist, you do not have permission to access it, or {% data variables.location.product_location %} is in private mode.{% endif %} There are a few solutions to this error, depending on the cause. +{% ifversion fpt or ghec %}If you see this error when cloning a repository, it means that the repository does not exist or you do not have permission to access it.{% else %}If you see this error when cloning a repository, it means that the repository does not exist, you do not have permission to access it, or {% data variables.location.product_location %} is in private mode.{% endif %} There are a few solutions to this error, depending on the cause. ### Check your spelling diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md index 78e1fa17be..9bc7f52c94 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md @@ -9,7 +9,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: how_to topics: @@ -123,7 +122,7 @@ By default, when you create a new repository in your personal account, workflows 1. Click **Save** to apply the settings. {% endif %} -{% ifversion ghes or ghae or ghec %} +{% ifversion ghes or ghec %} ## Allowing access to components in an internal repository @@ -137,8 +136,8 @@ You can use the steps below to configure whether {% ifversion internal-actions%} 1. Under **Access**, choose one of the access settings: - **Not accessible** - Workflows in other repositories cannot access this repository. - - **Accessible from repositories in the 'ORGANIZATION NAME' organization** - {% ifversion ghes or ghae or ghec %}Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal.{% endif %} - - **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - {% ifversion ghes or ghae or ghec %}Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal.{% endif %} + - **Accessible from repositories in the 'ORGANIZATION NAME' organization** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ORGANIZATION NAME' organization can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same organization and their visibility is private or internal.{% endif %} + - **Accessible from repositories in the 'ENTERPRISE NAME' enterprise** - {% ifversion ghes or ghec %}Workflows in other repositories that are part of the 'ENTERPRISE NAME' enterprise can access the actions and reusable workflows in this repository. Access is allowed only from private or internal repositories.{% else %}Workflows in other repositories can use workflows in this repository if they are part of the same enterprise and their visibility is private or internal.{% endif %} 1. Click **Save** to apply the settings. {% endif %} diff --git a/content/repositories/releasing-projects-on-github/about-releases.md b/content/repositories/releasing-projects-on-github/about-releases.md index 2c1ce082eb..097ad5e67a 100644 --- a/content/repositories/releasing-projects-on-github/about-releases.md +++ b/content/repositories/releasing-projects-on-github/about-releases.md @@ -12,7 +12,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Repositories @@ -29,7 +28,7 @@ Anyone with read access to a repository can view and compare releases, but only You can manually create release notes while managing a release. Alternatively, you can automatically generate release notes from a default template, or customize your own release notes template. For more information, see "[AUTOTITLE](/repositories/releasing-projects-on-github/automatically-generated-release-notes)." -{% ifversion fpt or ghec or ghes or ghae > 3.6 %} +{% ifversion fpt or ghec or ghes %} When viewing the details for a release, the creation date for each release asset is shown next to the release asset. {% endif %} diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index 5086bdc4c8..cfaa25e36d 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -66,7 +66,7 @@ http(s)://HOSTNAME/ ``` {% endif %} -{% ifversion ghae or ghes %} +{% ifversion ghes %} ## Authentication @@ -78,7 +78,7 @@ These endpoints are only accessible to authenticated {% data variables.product.p {% endif %} -{% ifversion ghae or ghes %} +{% ifversion ghes %} ## Version information diff --git a/content/rest/gists/gists.md b/content/rest/gists/gists.md index 78a54aed2b..33ee48d992 100644 --- a/content/rest/gists/gists.md +++ b/content/rest/gists/gists.md @@ -19,7 +19,7 @@ You can use the REST API to view and modify gists. For more information about gi ### Authentication -You can read public gists {% ifversion ghae or ghes %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)." +You can read public gists {% ifversion ghes %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)." diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks.md b/content/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks.md index d0e07aad29..0eff4b0826 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks.md @@ -5,7 +5,6 @@ intro: 'To help recover from failed deliveries, you can redeliver webhook delive versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Webhooks @@ -86,7 +85,7 @@ Only the owner of the sponsored account can redeliver sponsorship webhooks for t {% endif %} -{% ifversion ghes or ghae or ghec %} +{% ifversion ghes or ghec %} ## Redelivering global webhooks diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md b/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md index 7cc86d78f2..0080e72ede 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md @@ -5,7 +5,6 @@ intro: 'You can view details about webhook deliveries from the past {% data vari versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Webhooks @@ -89,7 +88,7 @@ Only the owner of the sponsored account can view deliveries for sponsorship webh {% endif %} -{% ifversion ghes or ghae or ghec %} +{% ifversion ghes or ghec %} ## Viewing deliveries for global webhooks diff --git a/content/webhooks/types-of-webhooks.md b/content/webhooks/types-of-webhooks.md index 05cb216827..6f3470710d 100644 --- a/content/webhooks/types-of-webhooks.md +++ b/content/webhooks/types-of-webhooks.md @@ -43,7 +43,7 @@ You can create multiple webhooks in a single organization. However, you can only You can use the {% data variables.product.prodname_dotcom %} web interface or the REST API to manage organization webhooks. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks#creating-an-organization-webhook)," "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks#editing-an-organization-webhook)," and "[AUTOTITLE](/webhooks/using-webhooks/disabling-webhooks#disabling-an-organization-webhook)." For more information about using the REST API to manage organization webhooks, see "[AUTOTITLE](/rest/orgs/webhooks)." -{% ifversion ghes or ghae or ghec %} +{% ifversion ghes or ghec %} ## Global webhooks for {% data variables.product.prodname_enterprise %} diff --git a/content/webhooks/using-webhooks/creating-webhooks.md b/content/webhooks/using-webhooks/creating-webhooks.md index 3b466bb0a6..287bca5a68 100644 --- a/content/webhooks/using-webhooks/creating-webhooks.md +++ b/content/webhooks/using-webhooks/creating-webhooks.md @@ -64,7 +64,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface or th After you create a new webhook, {% data variables.product.prodname_dotcom %} will send you a simple `ping` event to let you know you've set up the webhook correctly. For more information, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads#ping)." -{% ifversion ghes or ghae or ghec %} +{% ifversion ghes or ghec %} ## Creating a global webhook for a {% data variables.product.prodname_enterprise %} diff --git a/content/webhooks/using-webhooks/editing-webhooks.md b/content/webhooks/using-webhooks/editing-webhooks.md index 5121b8ea2e..904aa29426 100644 --- a/content/webhooks/using-webhooks/editing-webhooks.md +++ b/content/webhooks/using-webhooks/editing-webhooks.md @@ -5,7 +5,6 @@ intro: 'After creating a webhook, you can make changes to it.' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Webhooks @@ -41,7 +40,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface or th {% data reusables.webhooks.edit_webhook_make_changes %} {% data reusables.webhooks.update_webhook %} -{% ifversion ghes or ghae or ghec %} +{% ifversion ghes or ghec %} ## Editing a global webhook for a {% data variables.product.prodname_enterprise %} diff --git a/data/reusables/actions/about-actions-for-enterprises.md b/data/reusables/actions/about-actions-for-enterprises.md index ff8b663350..fcab11d99a 100644 --- a/data/reusables/actions/about-actions-for-enterprises.md +++ b/data/reusables/actions/about-actions-for-enterprises.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} allows {% ifversion ghec or ghae %}members of your enterprise{% elsif ghes %}people who use {% data variables.location.product_location %}{% endif %} to improve productivity by automating every phase of the software development workflow. +{% data variables.product.prodname_actions %} allows {% ifversion ghec %}members of your enterprise{% elsif ghes %}people who use {% data variables.location.product_location %}{% endif %} to improve productivity by automating every phase of the software development workflow. diff --git a/data/reusables/actions/self-hosted-runner-management-permissions-required.md b/data/reusables/actions/self-hosted-runner-management-permissions-required.md index bb0d3ca716..cace04c370 100644 --- a/data/reusables/actions/self-hosted-runner-management-permissions-required.md +++ b/data/reusables/actions/self-hosted-runner-management-permissions-required.md @@ -1,9 +1,9 @@ -A self-hosted runner can be located in either your repository, organization, or {% ifversion fpt or ghec %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif ghes or ghae %} enterprise settings on {% data variables.location.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: +A self-hosted runner can be located in either your repository, organization, or {% ifversion fpt or ghec %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif ghes %} enterprise settings on {% data variables.location.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: - **User repository**: You must be the repository owner. - **Organization**: You must be an organization owner. - **Organization repository**: You must be an organization owner, or have admin access to the repository. {% ifversion ghec %} - **Enterprise account**: You must be an enterprise owner. -{% elsif ghes or ghae %} +{% elsif ghes %} - **Enterprise**: You must be a {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/data/reusables/audit_log/audit-log-action-categories.md b/data/reusables/audit_log/audit-log-action-categories.md index 59f9d9a827..8edec38eb8 100644 --- a/data/reusables/audit_log/audit-log-action-categories.md +++ b/data/reusables/audit_log/audit-log-action-categories.md @@ -67,7 +67,7 @@ | `integration` | Contains activities related to integrations in an account. | `integration_installation` | Contains activities related to integrations installed in an account. | `integration_installation_request` | Contains activities related to organization member requests for owners to approve integrations for use in the organization. -{%- ifversion ghec or ghae %} +{%- ifversion ghec %} | `ip_allow_list` | Contains activities related to enabling or disabling the IP allow list for an organization. | `ip_allow_list_entry` | Contains activities related to the creation, deletion, and editing of an IP allow list entry for an organization. {%- endif %} diff --git a/data/reusables/desktop/get-an-account.md b/data/reusables/desktop/get-an-account.md index 9b0f616534..5046f5105a 100644 --- a/data/reusables/desktop/get-an-account.md +++ b/data/reusables/desktop/get-an-account.md @@ -1 +1 @@ -you must already have an account on {% data variables.location.product_location %}.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes or ghae %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} +you must already have an account on {% data variables.location.product_location %}.{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} diff --git a/data/reusables/enterprise-accounts/messages-tab.md b/data/reusables/enterprise-accounts/messages-tab.md index b69cbccd53..351fbf17de 100644 --- a/data/reusables/enterprise-accounts/messages-tab.md +++ b/data/reusables/enterprise-accounts/messages-tab.md @@ -1 +1 @@ -1. Under **{% octicon "gear" aria-label="The Settings gear" %} Settings**, click **{%ifversion ghes %}Messages{% elsif ghec or ghae %}Announcement{% endif %}**. +1. Under **{% octicon "gear" aria-label="The Settings gear" %} Settings**, click **{%ifversion ghes %}Messages{% elsif ghec %}Announcement{% endif %}**. diff --git a/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md b/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md index c52e1e5433..4f21de27d3 100644 --- a/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md +++ b/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md @@ -1 +1 @@ -{% data variables.product.product_name %} normalizes a value from your {% ifversion ghec or ghae %}IdP{% elsif ghes %}external authentication provider{% endif %} to determine the username for each new personal account {% ifversion ghae %}on {% data variables.product.product_name %}{% elsif ghec %}in your enterprise on {% data variables.location.product_location %}{% elsif ghes %}on {% data variables.location.product_location %}{% endif %}. +{% data variables.product.product_name %} normalizes a value from your {% ifversion ghec %}IdP{% elsif ghes %}external authentication provider{% endif %} to determine the username for each new personal account {% ifversion ghae %}on {% data variables.product.product_name %}{% elsif ghec %}in your enterprise on {% data variables.location.product_location %}{% elsif ghes %}on {% data variables.location.product_location %}{% endif %}. diff --git a/data/reusables/github-connect/sync-frequency.md b/data/reusables/github-connect/sync-frequency.md index 0905f58853..6e73fc3a37 100644 --- a/data/reusables/github-connect/sync-frequency.md +++ b/data/reusables/github-connect/sync-frequency.md @@ -1 +1 @@ -{% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% elsif ghes or ghae %}{% data variables.product.product_name %}{% endif %} sends updates hourly. +{% ifversion fpt or ghec %}{% data variables.product.prodname_enterprise %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %} sends updates hourly. diff --git a/data/reusables/organizations/outside-collaborators-use-seats.md b/data/reusables/organizations/outside-collaborators-use-seats.md index eb0dcd94e9..60f4db2c29 100644 --- a/data/reusables/organizations/outside-collaborators-use-seats.md +++ b/data/reusables/organizations/outside-collaborators-use-seats.md @@ -1 +1 @@ -{% ifversion fpt %} Unless you are on a free plan, adding{% else %}Adding{% endif %} an outside collaborator to a private{% ifversion ghec %} or internal{% endif %} repository will use one of your paid licenses. For more information, see "{% ifversion fpt or ghec %}[About per-user pricing](/billing/managing-the-plan-for-your-github-account/about-per-user-pricing){% elsif ghes or ghae %}[About billing for your enterprise](/billing/managing-your-github-billing-settings/about-billing-for-your-enterprise){% endif %}." +{% ifversion fpt %} Unless you are on a free plan, adding{% else %}Adding{% endif %} an outside collaborator to a private{% ifversion ghec %} or internal{% endif %} repository will use one of your paid licenses. For more information, see "{% ifversion fpt or ghec %}[About per-user pricing](/billing/managing-the-plan-for-your-github-account/about-per-user-pricing){% elsif ghes %}[About billing for your enterprise](/billing/managing-your-github-billing-settings/about-billing-for-your-enterprise){% endif %}." diff --git a/data/reusables/organizations/team-synchronization.md b/data/reusables/organizations/team-synchronization.md index 520d1c96b4..4579230ca7 100644 --- a/data/reusables/organizations/team-synchronization.md +++ b/data/reusables/organizations/team-synchronization.md @@ -1,3 +1,3 @@ -{% ifversion fpt or ghae or ghec %} +{% ifversion fpt or ghec %} {% ifversion fpt %}Organizations that use {% data variables.product.prodname_ghe_cloud%}{% else %}You{% endif %} can use team synchronization to automatically add and remove organization members to teams through an identity provider. For more information, see "[Synchronizing a team with an identity provider group]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} {% endif %} diff --git a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index 138b26ad77..063818f4f7 100644 --- a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -6,6 +6,6 @@ - When [LDAP Sync is enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %} - You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. -- People with admin permissions to a private{% ifversion ghes or ghae or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghae or ghec %} or internal{% endif %} repository in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." +- People with admin permissions to a private{% ifversion ghes or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghec %} or internal{% endif %} repository in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." {% endwarning %} From e650358cd8abdadd011ccff8d0f7a7cdd0c67659 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Thu, 25 Jan 2024 11:54:45 +0000 Subject: [PATCH 22/23] Expand info on reviewing PRs in a codespace (#48820) Co-authored-by: github-actions --- .../help/codespaces/review-suggestion.png | Bin 0 -> 148235 bytes ...sing-github-codespaces-for-pull-requests.md | 2 ++ ...ewing-proposed-changes-in-a-pull-request.md | 2 ++ data/reusables/codespaces/reviewing-a-pr.md | 7 +++++++ 4 files changed, 11 insertions(+) create mode 100644 assets/images/help/codespaces/review-suggestion.png create mode 100644 data/reusables/codespaces/reviewing-a-pr.md diff --git a/assets/images/help/codespaces/review-suggestion.png b/assets/images/help/codespaces/review-suggestion.png new file mode 100644 index 0000000000000000000000000000000000000000..d0bf0250a6fd1836df8b57d1edcebe0dac19cc69 GIT binary patch literal 148235 zcmeFZXH-+|)-{Y6grF3oh=6E>C`y&4(g_L#5s)q&m8Ov*p+i7|C@M%m0qGz}FG}xK z1?jza=`GX*2<6*B&$+od=RD{6e!S!T^D+j57_;}j_PSP?Yp%KT`kt~p4K*`085tRk z0^+tB85tFXj12Ug>KO12Vt!iz_;UoMCND#l(R6MG_=l6}eFZZmB{ELnH5D1?2s0T4 z=_A0e7kVe*ZlhbL7vbf%js_|M6)m zNX*fHyaqi7K22uL78nKm0ox#SP-J9hE|GqZD5$}f$jD{56>h^dociWVA3L4Xj9Q%W zN2Ml8t(WdJh)WP0h8Jgx+6M{vmUi`ayH*1YCChsT_iT9iDcsXY1=X}M$q(Oq3y%{A^j>)jds$BrG-@bD;~otslH zEiFw+Oq92GbWF|2;O*?~P3AQyiWe0X)o^tcV-#<+c)Ho9nbZ6@nq)&VGU-WrMKlMK z?`U8Rr8jA-$jFu+-Fgr8+=C*diRbp;AQQNN0Wp#PU;OVX3vP|m=#4kJ#2+|}-6XyD zZyQJn3xOdUbQn-hGik@k$e^psme`oRxy;T9WOrvpMfbDK;v!d#;R@-#fuz>^Nlt`B zk2pi()ZW?n>VB@xbdrCOEvfF`Z(lwLZ1GR4{7QvZhOw^CP6*F+rmKe}S-*=mwVPTC zdSW$UmFfg}9hsik5qEsGQ|bLA3vQuZD@jGdY3IHW!ajEF?T^w~r$Ob;`!w^^unwInq8Cj^mH3p>Sn#HI+U{^o>eRl0TSH`YN7tUuoXsq#j2J&jL zYMe98kBs9Br%B;JM&{Pn0z-_H<9XoZeN+4IkYP7Bco9p*&D7}uEP8tHQn!AYcee2m zJH1wI?^ceN_0E0BR<Q84-h_M-~A0C;imAx#i}-Rg64(&;pm@c|S&!*oas}qjTi&885NjIVu#rd+Xg- z3sp~ZUeVY;VB>470=B|qLGN$-p^1e;H2rGsevNloG8eI~AS<1trk$8D#hOzulNB(%`*~OQa;pBU{ z)?i4BB<22^o;TDG;22NO%+AX9Q)#&uKi^|(zv*C40I_D{Hki~Ap@BxMLZ!c2@tF;h zIw}I1_mX1n?Yq)Q&A&TW2pq%uN+pGG{6?yFw-uG{-f|uxB(?8RqJcze{)KBb3aXQX zRm|(tRc_e}UCD|aGjFxk9OABM+)LVD&7a6Rl>4(4Ru>0`8Z#xsr#&*0uvjcGJkDp$n#(^D|%f?lY zrKcoj4$r4bxp&>YaP@m|nWyK6fh*Jue;jnX=ifM}?;EJ6&BoJLR}*TdPl%~W2P~-h zKI4ivS$KNQF!a0t!~bk=^9~RgB(XBqYkJ8n+_$Mk_Jcw%%OGD{p>%-ROz_TCXWV~v z9&)DFv2QOm^YGCMVTxTF9CT1^erNhE{6!dw)mC<|YJ4+Hs{Q#>RXtHzSk!UxT>0|; zMm_F2a4-KzE&>;ZLEs`+mmtNRpZ5$Mdrm7(YAw?CInH%l>cZz`W#z2 zH>am=3v4@Z@&e*wapy<=N51&^-fC-c(%GfM_S04-S`qskFY+hc07tz6C%+n1%Z%m9 z?@DDiayO;sn-VMT$ZGVId7U(>VRPiyLJ4QK^}wvH{brwic4pDceQf@(y3YT&2Y;>G zhypxM5n!XMUwY$Pzw<&7Q*P`fS(ehtcr7c-M2B(Q=P|t+KOe0n?57h-J zcR3&uvJ;$3dh8psjS_stS0*S@ub@W0i6Ccd5lHo|LJRDy%y(bcGE3^yU(axkqx z((Zr73_Fm{_gv^;Qu{~J4E4uhK<=hOXE=v;W`LAO7=DIymOU10j{jvvlPf-}&ywvWba>Q&N#W4^`TaOiEI6{>$$BRr5{H zMt}K^9+KvVo>k#@PU-!UAnkJfpQY;`rPxFg1Qr1ONyvZl51iy8`wJrbfBy~G;s2Of zuIZmxTTf2A5v_(C-Y~%OqBkiRNhRcE>3&h8->=-iclKXE2EXg)cb%Ps@3n3`5n|xv zHCoV2y}_EDvuTrWvlzfx1D}w;Vv;B7uhv0MzJ}kun-zI;VQ^yNFNs_^W6(tOrV~+HT=GK?}re zqYPo}JHOw(7@5Nj*z5CiW#(iJylSk^lWRfK-_*(fgLm zDzNJ3%-hAsOF&&OWszTajgLZT;0Chq}xx=I77jl{6x* z7bj)3moy$285TXnH*)tY1Ggiqdxld@Db1T&N@gEYLdy=IlSH&K5lErG3ki^)8DKuQ zHGlD|UrRo}-TQ7x^1FMo!x3S&g}rKJEpPfs>QM87XOD z*VlivmCi2v=Oy`f2`ACGDyO=KkSCVBEYZSG{yHh8uC${wSFkc@^nyoY-by4h!Cd(M z)Q3GQq>sLZn0tmI!@^C5PuYxBnc)OkVrOi#(V&?`Jx7y)Di^1Jin%%N9v@#CDK6A^ zRHK&DDa&&*Ub{!Hl$D<5sxHReTq_MEa!z3%Uo_Gwk(Urez6#Upd1(1| zgFCX|DJx;z*RspbZ=zU5FWR-f64kZI($DL?-gRN8ZY!d>c_{gOc%E!&k&S~$0@Ax3qyNc-)9L(zj1=tqJq69Z3v`XJf z`BkTxjRp|EHg0UT^ntwVy`jjocQWXoq$6QE|$(b0L*@R48cSB-z-KAbK4k13&5b6DXR z`+3;evrora#hsN01)RS!*|&BMo^p(xsCbP!&H0jvDJX`;fzAUPA>$ptvf%e9U-d|I zP;S_x-K~J9!uF<-x*E1Uck1UBq&(sTENI&5wOtz}6~4(Mui-47()DA5QDxbmlpAZU zglHbOCT=!nWO79-P*Z-AY8Yfd#mYpZ+Op7Ev2f;{0K;2DAwzqae8Knkf>l9H|@{w_bdgA-$n_T${I~MxREpvqoobgv4?nS6^ z2Y$lpv!jO^DP_tj=bK-b-h04zMOF_LxDTRzfBdJ=Icu;UX>yJ2ZxH_rHCGYBwx3w9 zx$w39V$Ix+!1p+oQ`uaN{K86>r#a=wm@YwWFXK!_C3<=H)^(Gxk5}etnrUm2DByAe z)5r3K0)}aH9r3r&iKn z`S=XLE|Db?N?-Vu7FfRZ*=5X_?O8w3JFPCP# z-~7l^d~p1FAU>bHo%TtzFSAWn`f~jP9*qJekt=i1*&TsdnMcvrRpp9r2DCx~s2T8A z=_htCh_#D6Y{sq6b$8CRC;DaR7yeH5Zo_|TMM$+g@i&POmswguG>Bum|elDp4S!dj^A}wM6r0kIdN6vrl}DlpMGp*YJ~a-PgeTyhAdGN8QyX0 z^F`kN^Ddc}$0P7E-(T|;>kn(kkGp^JeuGzxRY&w4=Yp4CSVbBfKRfw$d~Jes3#AF@ z_}8V=56d&~k54U3w{lr|Q#&h15cJ-KJPbzDC`rNh3zS;#e_8dc*LlhQ2X8J3*5?(U zXKxoBy5SlrqMYzTUpHGtIAW{qDN+&@1ym{qP7@xgMWf7=A0ckJR7bU+JkDSxdz46YamP2sGja|j1f0-LYKbEokaIm@KuE3D zO|mI=AEjpCx^b+l{;8PjrAZm@7TYnkmMdqAO=#pdOMZ8+j)10Pe_{zu`6$rk>Af%r-o~rpMB#3-LfALg;zOmCd#hWb$NLTANl+>jU^A4 zk>V&ZWSDf{h^3ES>e=F(-ttc?7I%&_ME54V{D7Rl-4x0T`2W`Qf@1dt@bb^FH-^U< z987Y2&tF}3^q-=sU+wSdNg8tcMH2`3w)+2EgZDc?xT8wu8;zq^GsT`#^PspKUEK%$ zDE-eG0W1VH1Cwr2fo*Ox^XnLb!lTZ2r}@|z1m@R@eGR|l(MdkXqbyh@+L?0iU2I5HB)IQbvpr0Ps?j{-1}|URzM$nyPN|703@|7GTzw_xR5+`IZg?&*Ozj)S_^EE z(Y_kk+%pU87l2kGx67~tDfIG@gCXi(09%`eFJ8vmLcuxp>KQAMvmbYH844_M?u(s%d1i#~ktdcQDAyZz5~;Jz0K|M1RDo(u<-oAo*GM#a@kL~O>+0r`bbgGw-qrEyoG z9#66G{zpa>vx*{QwaF4lZRULX$3?Z?umC<$g!t6H70`7ut;hB9Hx_054<|OjZnsj2W?rPkvvL{2`*&Aqh!!Rb_&rOmoTUV(IEVTVF2+pRB*)C1HE0)A1j zzQ~_wKcS&$AZ&9zx%|4Gts<+Hy^{h?Qunc|Uw>I$W;F@`KbZuB564z3;}{J}CyL9L z29`V?yBnvpXBixc_6@Z8B+plCZvV)7&KoQ9ro`H{ReC7=)YT0qba`U4QLZ>^NM^XD z+Q(;X-FI=;lI}m(4LyLqK_uTTp+>6jQ(u!Ie|MiH`Yw~-=(aEZB)64!oJqj@_op~E|T-0IrQ=iASZ(rMhnbPW&b`h7@)js<bPjt}6P6S5lc&{}w6r43+pa54T-2sVbW$!eVy55;!=-ox+g=dcM5MhQ1M7^S2AEt$+xMvgkA5X8Y-r!7kWkZTQne}%!O;Gxf%Rn@E z(*>N1>{`}AV&~6@1G;(lI3b^lxi@jIdD-~cNX+XWy6O+T0!0>z}9|~cT_1CZGWa|P~aB%mc)@^U;edFvOg45D2ajc{7nXv{o&hxQxl{sko}+j zZ}Mo{k%}X!wK02dFG#s>14**RpY(!#!e1B>gZ}jL z@qJOXzs}za_7L4D1%Y##dA^NYLbSBCJ$z02JO%^;|G5s;N!asi*ZzK)nKAz}urEYe z&3{kc7QI62i(_SmIAHX&UrT6q@%Cr>nzIr z17kQp8Pe6LAkaUHWJ8cy$rd=tLq>nw^Upf7c1AHEtKIt;5QMEIkRC2C4>%y{NI3

kBFqIgDZm?@8E_PyHp5*`RS45Eti@&b<}7(u%A^c-nxJr4c?i_g z35JNN21Q0j#t9&779S?M*gYt7F@Z;YuJ6uxC4rw^KQCPTFl4K9TYtTAIlF^2Ndu^w z&a%ArXOYF}=}HrmlMrBsv5=j9L31T1WB90KZn|@vsFUqcZ;8LG<8T)2eZb>(?eP6x zpw{hH3~21Jg~hdtn2d}JRTh|&mGf5y>K4&q=g#$lCSU@16qSW}mzxSuFJuM zF5d;lnpo(itzt1g-HYTpea|1BC;28|wv#Y2#>1B(%t1XFJ>sFB_!%Z}QE{<6FkM`! z2*6597eFhs>+dx1tFNSXF2)%pwV`=t6BJe(@o@`ACrNk2564JtHVJbfmbNM7uTK8u zBsNuuD}RN~#-CZM8#Y1EQt9UGRw)DCBzgPac2haYc`q0_mlz;kEl|9UZ7!midw#FsVLQ39iTiWlc zG-PP3Uhk4S0pZRVLgH_@pLDZ~GCKJ&S=x+adf@`eOh6p{vCTycDD=c3-@dwAS9hn` z-5e`zcHv8Od1j`y1|=BJD)mTo_tH&z9>h}57&&UYLVBc6>jvv_9p>1Hr~B^v_yWvg z`(Y^q+h2hV0#|rD$&=5Fu^dP$8_WJ5jG7T66s}ll84w$K7x+{Ye4e0v7gQll6njaql{pKGH6=s6f^gBQF&b14pC(8~U|VOI_s|IGLp&lrE;-%<$s zOb8RW1=Fl+(8Mpvls!0QO)6s=ZR3yhTBl0p{}M`9{PSsXP?9Hy!{iS z{>Q)ghK6MTE5Z9H!BJ?!M=*q&r~ei|-JiXtf=IJ{N#HtoOX?HWmX>~3fm|ti7uql9 ziXE{aY9~}1iS9*?lIH{0F^(aWMrsRpB=5-<_d0Amm2a8j9n2bb>hJ4I`yzeQ)YMc5 zjzQG;jF*uTBeunP?t1DCMxoS@g#48LXmN8HkmJs-?-Oywiw9OQa4450uN_LXWytn* zI(PR{P~{7I77SjN8lpcpBTP&<({Vrh?0_ILeI2L6;-FgtjDTCuWf!<)E>BKQ>cTy5 zUm^el5;*2|PK-@7n9gT+`;~UbnkMCyvA^6M0g{tBnAW5^-813j%a40^481^&jg4g| zAmj5^*CKZoLW;#H!Jtyoge%t;S-QSziR07mb|t3m;F+iaQcj|rBltQLaZRo7i$`|Y z&0<*z;-c#M0+IKlbY=A^6}8%1zXKU?R(iVslJbB0!!ZECohQ0ws)bo8s)m!M;$ZT$ zLFbk}hm|VRUqLO;=Zo!UAt?QYuN7@n00}P8j|}Uh0+K$W80u-@XOyPxDCyYs0^Id< zK z=vLazFCCR1nwbyA_!9M@Q2h60rWn`fi)Wu!B`pYS)BVO#vR* z-Y;!2mo8%7y`u$2(QN$IkJ7>95x5fOtUZ80d|=K#U0~Y@I{71=*MFvjRQBT4JXRu+ z|17saS^uW{?Gfzs!ANQUi8}+Mnj#hTr%#10l7|M2w0%|tf%P#UOoK*@f3MTh^hoY@ zAN5J`qHDuXhut?|q}s@I7IstS;BLU~zh^iI7iMN1fi-Rd0N@)toSgOY^!z*wL4Oee z&4%=ZNZZUtmOSai*$$F`2cjEVnQw*5!GQcroiPWkVRLwk=kqDSpElztz~9QLasCtk$O*cBI{w(4TYJYO7_)G5F9{o}>`IyA90#LlXP9kKRs(CLg! zi-|cu9pqab&{#gH8GS!n8^V}&iFQmjgP5$I zxbLU04WqjsQh;w~HB{0?Z>SAQEeahhs^o`G4|WGboYr3*hxC*Ru)|eU_OT`@yiMjt ze$vdgDsbHWDE+qTuX=fQ{g53($1;;9-m}1=lj#T zG#50uxR6)p|4I>t>w-3Pyjjcyu$jw_IQT-8Ngw1rz zMP^S@IMBnS|6JxamaOFT=;5O_OOJuSC7KcdoGWzW#;Jd`20i#tie=q4#DMyy&OBU# zz$_j={(5_VBY^NYa64xYUB+%%9@zOEHVyz(DJdyw`8;RZU)xB;|8&rbJT>Iz4usj~ z63Oad`e`O`Uw{AO(fN=0li%>*hLeL&S}6F$#Kn=S z39!t6whREKw&6OA_-Doe2YazfGRO7nVf3C22%DLF^!`9#SKX{MN zSq~XAat9BE3wh)KV3(Ph`L0h)YUtA{Dk=Fb?~esFMmIa|9I$vYn|j| zRKHz})#twJt`VOTetDPeM7Z8)$dmllG-3UHhuM$gjYgwuGtI2doX#(ivudl1pP#5K z+vTF0oaXv`@_5|*%;{ob9+a`C2a8u!8uo4poo}+=@pxBcpje>g1N9vK*I-sv9qk2D zxlL4getrnF5<11}kRs1GnJRx~T&Kuw!R6a8S0bgx^6r`S?KhD1ft82C=_bg5DJvvW zy|A#5v_BgHh$Xm#=hlxwF7DFoqKc<{{YFpohIh2icz+XW8>5k(9GbV_q3Ltn`|vb7 z^UHO5GG{3+o9M)}tBAMFUoCf2pKN+;sVnN4m!7_Yx87@b%ICUaK7a~$m@2W(XsrB^ zyUWv8zWZ^VDZ3n{K9JdJbEQT<)c~0o-#PXEOM~Z@W=gE{ppPWwI;D1M#09s0r(9dB z9r>uz6Za;1C^be0hy6K4cxRgDU$f1H2ANxE*qysPDt4teaLGS}XszA4x9#~vQZulX zz}97+x&6Ah!Lf5UjKXto>LcOJ!k);Fr&_~J#ZR_Vo+ESi#IZI&j;%C zh(zg@Pa+Zb!S0*+N~zC!FFWEn6~tFVS7(P*0=k90UwTjKbEc}FOqpk%f+4(cG4bVzZJ`$lMY9XTVMH~j zn(~+P!&|NQJM9uakRtRpwqoyJD%2sU{~TILV*)Ub!RGW)6?ADxNOaerG zBrOCfJEv1r^~cUs7|;s{LH`RdkIUpZa`mhfJ$txS;7uLWnXm{-UbepzC%z8Qff z11N+Cp27zIU`R-|istk{B9V9D5v6-@H zG9o;_{w?1E9Z)x@lNPmoQ(JSaCFSYYOVdtNB$(QQh6x{ZX{-lTU| zSUUsXc3apAx_<5J6Wou&*64L%^|bCz*3*=;TFDD<4YLhzbzL4VGsZl5%5?&*VoC9& zzp6WJCb|AXsk)`pq#;swb5IADlJIC0_qrr;Fm)KL+WvEFy1P(VdqICUL0HLg(;9bP zeE8Ipnm74X(bh}CjrPdltSWT*%YJU?#p3dK{nbM&h=8UEd_So=?^joOrB> z506d_OKwg=&zZXd?yz-kzRulxdRMzKKO>~1X7*<}izs2lHEDQR=i3}-U~c_-tu4_( z)$*rryaXljdZTb=@%k^Rk8`U0i?K1NI`cdD>~6P&hN9~NY`Ph#`bIOgsl(-Lwl&iu zxOeVGT@dQTdX2$g*)DVdlKbL`xt%Cp#i6?wyoQ~-L_$jVg8rgzg2M^En1(d~1a!3oZcF%vVc*PrRk0bq~3#(P;GHG7sWj zKKj|xx}Atz8T&fFeR1$h@wrcL7|)-WeUU3AB^IoFX9$ITfs1h}N1ocGO&Km8*jfx3 z=5dY|#z`dN$5pZ=%jbkuMnn)d5%hDz-Yf*wDEq=)TfXrkt+H+8oZu@WD`GqfwlaSb zCJoS1oQFCy&K;nEh`313%Dco2yJk(xx7|{=#j?nNj0adTBp}Ju9vOol+6hb zKFev?(zlA5njEJ=VvQ%Ox;scJ&M2qFp&V++hk?EKNl0zQnlg8q83f8fV`e>b5EjW2 zAZpXKQ$4I(qcHWg^idV>RL3$(O;hdQb9&6{=&l0p71#z8M3mqPh@cghlNTc|SHMHBM)C;Kt*m>cc5#83B`7GBqJTJ20b z=*!}aR*mfuO9fZj__*eJ5tP+VO}wNljTdnO^+GJV^D)y8uE@Tvo1uoljbq<+nMk;{ zg{B%2q^p^`rwn2BVmG6`QeKxoLn|#jQ}*M7!&ddp%BObGHpBkuO%o;{aD27yo|VG$ z@0)jTL|viQ6@W)+PMNQLGLfKs?M``V#ek*R5xctiEM={GZ<5&!F)o4t+NkDX3N9*< zjRx7Gy{vCC1?Az(1MhD~Nnk)E=9cp?jyuHM;_b09fb?@v($brO{C;-aP@fzLGEJR( z2ZhHXDYLtwp4smW&DgNYt09aNp)t>W%N*Y=4wYHyJ?nvb zM#zg!FH8li5{J?JOGU+fbuvT0JoXltk=MzKapC^yd1lPlDxW)7;1i7`<{3+M3udoY9RugU=C4^Tw@l?&XFjH7{c1s{GqAbU(s0}#{ecm}X>$xb&RhWK zYCQvzk?rgVXyk1xSu|5C>s17lonDEfa?(2^)4;8nu3DLuFYaQlk*K`Mcv9LWo;k(2 z1!485H_R|>6J7hs6)6v6zpxL=?3?+%CBl(|iFeXyMOQ=JS5ZifL|^)l*21<*wyAd= z3YQ`$*jy9!!93qdeK%9VLXPE$aa%vwymuhkcBd zN?h#m?Rw3DtG9be=Q2JFp|x?)Eu;XCp=l#n^)Jy4T19FvI^Ua$v;0=#n-$WW_*p8t zM1|-OAj~PL(Cq2^r7IIj$54w4+KCwL^7NmI5LoFMQoTCWC%P)Dx!R--?>GHMg2mg0 zGjp(Vy%n(pa}>6$*}*aPmQCzRZi2jKuW-)eV5{ z>>}tQt?rA6MNf!aYhLRx*AMCaf?@eA=v8g#g)@+1-zsjL{c_&z{Cu;2KTe^f8O}Bg zf9>A=W0e&qsNPeqenZKv!6kF6x3gIz9tuxuhL^xGPJ6sQb}_dkL)_#-zsr_vN|j!k zE<|)mD2(^MAJzjrh^OT2q8J^(5J|o|M2=IE=xltU_gR3V(ACxD-V{N^+&b#0Y?Qop zEOVc@j6i*~D;m%}R-sEhlJn@!I7>g>%TO5?+-qCGQ=WD|LKb@Unb-dOVJu0-z#IA zoOFWWyE{A2<}giMthl*3MS~FWFU@3Ma84W0%I4vQtYFR-qKOVgsS1V>&Ke{}ev#JM z4^c@2kg$tEW!CsP<{8OEP6SllN0Bl$_e4c#8+N8q)+&yF0a;pqr55|H_9ejl*xd)& zZ+&REMvOnoV*#2NasA?W>=n!M6Wn+}Q_xQT8SjW;NzLuD_3Vb_aH(zdH1a&xJ=c1v zW$~TzkS2X1f;c#r@Nz*Yh&B_!sw5EDA-QGbIQFJWsW?qUunSx}j>%nv7vP92k@;5e5EDtt(M8LG&nE((DbHM? z?FMs}7jJDTOqKLgnE~uCr7$zCshFH*vo0K*r)vJ#qmH^m<1AnB%ez>psKj=2_3-yX*% z=oe$ODq^ZwaxyNW;`-nyZ#3X8bj?nDXETQM&p9Z70Be~!*|=PC8@(Q0`AZO0eT?EZ zKJ@GWo+IVtaiA%e7`rEG91*F|Hu@mpYNioGj*6p)TFI#~l(bgJyHD^A^ur`4XRxMPZy7Uf_!(4HBgVT1v>zlAkMpiV1T zo~j$XIG@Bq11Fz}$@X_}FlhUBy|kd;mkp1+()?Ap&i!M#%6xOKZvlQxK@KY|hY&;C z4p#Bp2tZ(^qckO4^rH+4@msD{TMeqBT90NLlz_4_E_Nk!IM=YuYc`LYnmW3GXMuiE z6t;5i8w<>bfRhpWnFg6O6eXAZS-|o27?>UyrCmIP`Dexf%FJf#k`O)MIx-*#v_%k- zlb=t_@avY^*z^#V>Ym+>{$h2jrEHWMGX96yuB63)>}LHFpq_@b(xR(zezuNtROQG( zVjviq2NIpqw&tY;LmFziPJn3;NpS1;(C1IXLygX!hGBb8t?`Qr8J7}R`p=~EQHwN5 z5}!AmUQ&1v;9~i>EO*;;dXx^;;2K0=69^_JKNLS&O;U>2S zAh)pRc&pL48zkrIKlynu+Z-3sqb>_$a~Nl@-L^OpchU>w zELGIozdn!)v*2+FrS4}wDRP&!*6$VSsG?khTPr$e=|ketImLd_>V-%rD>$|5s{l9N zRTuT>ucGXwcM`VV3B`GaD2p=-wss z-#+~;0W0#ul8F-VIk{HHa82_7jQ}9VG6)RWEH;itOYaWV z?F4={9(QBge0L&WLsnoBOzP{%0wHWZj2TZ zSH7U=<8$;wV4=+1mivuou~qoBj!`s#5BWFOxXA@phAhju*<-}&qBfEcWW9P{~n)L94wo@aG8%-P(TVgo>m2rIy8_OC5eGr+K} zV{4W>7EfaYZ`{R7mx+z-q~V*a1GrZM=9>m?M|nAwdj;+o%uR?{^e6IBnw3Ac*%QkQ zQTS?hO`#1%uY!dJlppU>(_%5x8!faT*s3i1#t)y`2Y0Y@Y=@Yif93C`6IuwsTtE2d z+w^xHp+PYvi#FIOBh`l(5Yq8{PF`e*O(>~pZwh6b38jGD8|iGfNf@xh_(z80TpGH9 z1yBtigejshAbf=yiWkQy8W602oikvv2uK5kAK2@X1^ztDFvbQ(o(O}S!01?drEOC54!o6WVKqspTMo2;!MD8bDB<9_$C z73rt!3%o$KN(;kMtzC)!iGnu*rl3Q(7!!|f7ogR0#`RW|QfGr+(Ta=U%-NdZ;=rhF zmlu&#A^G0hjZjC}z{{TMY-%>lH{+lJffG1(q5v)#=&^YJ`_N;}9y4~-H#Uv6ik zSo1k*MKm~|#ZVMAN8rtGth?4)8fT5a+1>gD>^OEQ)dClLO69_-j5wt(0{}C@w$9PR zs63RJ{LVc#$ztsF0%b%7o-}E+eU=~;({B2e5-hGqX zkr{#ZWTWLOKFvXVGdVkNb%}X4cjYO^&)f+54jrM@?>=+iYuZEmojzT8QWJ;q6tuGVX7lp!KIQat!Sz9)P}cDK<@h8Wbnv}@*3Tu zeY3uAQBcpP#;DkGzBd<2cs~EO=IX`%JLiiAJ2?cYzpaYRtw()ZnZKmi&)k*5$RYkv z2=yXZ2Tmf>U`Gz|or61~h>`CXNTYEVIn3hXqUuSQ&$kl4+{*}?vegt0y8XETY9n53 zNVeIX*M$03GT+FBv+ zhI)6xQ7POO$=;(>5JaUL>G22^aYySuNw2ohOtByHahJp26+0fYa@yUkU~b8+uW~Fx ztBSJ0$z2mahS1)~WUY0{$;q9sP7cJjwz+6z*>S(S%`pVz_j#OYy)UB-UNKR-015}9 z6ab`p2|GjQrb?tj&jDTDbXxe{kf_`)%S^U6kyR0ffD&L=5KD34uXqs9`iJ+k@0{4p zkPTarGyswt);p@teQM=KV;(>;Iqhcj6+g2YU%j++?nJlay|jHGG)|B%H|w=_KffH& zRL;oG3KVG^CQ3qj@iQuz&Y2aR`DiC{-9_c03qCM@yAsv6CpGOVwaFpcK^kh-f)34n z?k*`}D^jKOu@#F!Okfum7b=L;2}lm`s1wmYnm;h~`1nTukkR>^9XE5v-}AJ<7%`*f z>ydqY4bAzYMM~zqv1;oht|Cw72ewBr`nQso5%e)dGcTv?3d6p@zI>=ap)l3pWGaZb zpcuUiwwH2NnYOgsK)yarhkC8d1SnCt3*F{O#Zd6c>0W9o$iRJ^J8=vv9Kz-9VYJcO zM1yR2)&_^o$%!TI1}jU?Sb)1L&mjTK@uS{CBUOFg1bWss#wsXx&{Apkwiwot*Mlp` zOVRP&_4AE%i^h(29j0p7irJAO{wh(6bV9qS)|ZOiyEnZ+q~t&anK#@~j#;&?itDn^ zPnc+4gL?id2qbzu^i$4nW@Br1CQ)Vfcg$?CF=ln`p2=g@Y0JEXdl~6F5+~%b(ixHB zxBwH}Qtt4nP#X3t8mkSZo^uBHuZha5W3KKNJBGKZ^}iF(!B$v5G~jeIhv5P&@7xWT z9%N<~bK4u^jIC|9o8s9J^tfRP39mQqUAZd3Okaot?&j~GsXRpEfypHX6nFYisHkr< zFfc^zSi#AsHeFp^!H{qCunjk4q{!vKuK6U6eQF&pFhrb=k27Iz(9P z(c+p-=3%#|xqa>hLKA@2#SKsREJj#w-qQbh0^&2YQ34$g6CI|6V@8^U1;5+fc4!0VxS}g}&)sY;1Q3vn*O{wSkZ(lCSa;kC7HM4WkDnUc z6br8)wW&_rN@UGk zlO6cjv}KzDU;lXSS{|3VwAVWHMz z<<~$=OywQG;hN2C0ML38AX;>e4d7Mkc}|EV0vf#7z0y^LP8)8D<1NQAh87PZaSgDe ze6*hWb=R}W_sdbQIg3_ZGa?~vt*R263dj#;mJzRBFa0lJ>f}_g# zjX*BG4z|oz@v6_lGrGNHn?M^y*^esm-T&DK+ZB2g*F_)zde zXIjW62>@IVz(K)MwQ0wJ2l0C4_03ZhMntGY39;u^MK!G@Pwo`@{lZ~rEk$locAb#^ zb)K4<`KE{YsX~s|lCH0()9Ip)Z|%hpq?}*V+V3lKBL6pPHFpf?F-D&Ne6_%DaR4+- zIV832r5e(t`~{`SW3Qy|quCQFDbH%(mlyYNvtq5D+*Hr#>ZU7e_LEJqvwppf3lPnW zP?4dv8m0d5F&-r&mwV?`kR77_%C83!-T3caK8<}C|1{w>GxiVdk}B%*|DM{XNE75$P~YCR*e%;iIpg9 z3Qjk45RRd>RR*(s%hLae;EF0gZtMF(b=*};=G@n99)(_s*XsE@+eS)0Bh7m&%^KAs z>tlqE0A|Ms9U{}3PnS0!Mi^LO^wG4C+UBE2j{HUU!_8*!;rj(b0rnCOL-PRwW zmA=lW3V2DlVB=($-S>l9-IVS0^mKmG6#W(0gyoQ+Lr$53Wh#um(g;0Qp5&FNSor%K zhi9olBnfR3y(cZB6Ak2?sGW}-^q|V%LyXBWKwl&+WZoODe+n2HS|7>*$@qUKF`l~p zmuiEp^6#q4M6Y3hYakBDoB)IvJUl$Xq;cNg6%qeyh4Dcd#lIf(@41ckEBg~x6x&}C z+W%hye$S-)qNf5}Cjvv!&MZ8M9uA_4WHJD_q{1{j}LU{Nu#eW4YT zV(Kb)kdPHC|FeJUH`voV!&l_j+(6(!vO_|pCU;kW7#=Oal(j}fdTO+7*G)9 zyB8qx0Srj=sZDcQ?vvihohQipXQanpbCaH^U>ymqe1EAO;^A26bjfNW$r<*azaWur zbcX_wmK4ehsN?)jU`S3*&V6Qp`PHeC=2Krv-7Ez7$kaU6dw?R_4$TT?u)qP@;=j(n zaTW2!I&R(YEx~#P82sfp?6gdY-@EnuX$sP~(DRTH8A+q2K|Wgu52B@`!^E3P4$$lY z57+5M?g7tZcLJRvaKY9V&lmlP>Az$2oix_i<=N-3FAu#wo9d++7(E*L!6|I@)5RWF zOfj30Pu-EdTHlejz8G0)ZLWDgQ#jq`QBSk_z!%NZJlpAr3;l*1OmNI+7F1^e!SF^{ z(2kC-i(Yo@Le@#VxrF$#g4+$Zf7+U*Qgz{mlSeu+*U4qP zSrX?JOAIQ0@uwie$vqA|n2`8h3h10>LRzHv6?%y0(twa{XlQW`AH}T*W!?KdpNG&u z21M;&Pn4pz?vSw2&8cgY;2%84OBU%28#SHR^)UFU3q7CQCE~uF`_&OAsHo9eY1|xX z&2XQ%JHD&QS#I@q&NWOmueIdIM)M7rFk)$T?dSft7Z4=z#(l?tNwn*NzqN3UXpsFd zYo%0UiuUwzx}g^o>ols_6V%f|aie zI?El;o;yk0gKRTh*pi(#4__@Ku5WZoOy<64fL(ENbu*TG-RQk|@qHaP>Tc_+_kZ-F zz=JW?KG30n+kewJML#7~gK$zrzo5#2-EL`Z9i4-cp1Bi7J-6H5ezxwM zbo@@^2BO=*rLf(t{T^F#Wem(VF4nFR!{=80n@v+WramN_PX;A>Fo#>_Nl6w9)vl_l ze(ohq_R(bEX389oH}dxquX9YG-q~Se3dCDN!_j+#{Em}ntm|mNG^g*n{AA|gW1le% zw{xeomn`2aVj!bepv=Ng`t79mT0I^+uIdFs?k!MyqK20rAzvQd2@_zJ>I4`$3gbqe z;pj^7?A>jMfev3!#6Mt2vbLLyUy|md|ree(}{^dIg zJ2F%F*{t8-{pu|<270u`agg}ZgJ&)LE9V!B_*b9TmccOGdQ08@nYno$9&T2(b9Jsk zz0@Y<+(Fp1W|1*Lh>wZOHe4amvBe?O)(9_>FqE$-`n=I%mEuBSlNNn)wL!wS8|;0K zLC)^Yfcjo{XCYkU+0T>_+U-W~6sH-EtH1zrsz}oR9IoVtfSxC}{m6B8PY}%-f0NFc zHw0^HeM0A|-;Fs&sq8!j`H}{ZaYoHhUCa`^E%^G`545P-x#Bb5t=*#1Tycom1NN$W zprm!MIwz(MGr@eu2@n{)KL~91F(x~^9rzkM;L)N`G`=l)q>u(*>m;Qswof0iSbR| zui1_+H<;>kwvN6u;@w>5h5wmGF&QC-5fe2HCNH%%+f0b}7&=J<`ButZH7iX?@KeU! z5Aub2`d0aGmaqdFboRN=f)erB;`%2y0!C3mq(}`aRjTwJ0gOonE6E9OOd;*Q1Pu&my)L+%-(-4$7_w*(dw*NBb zthJ!%5F|RsAfZF!G?7+(z2XkQ{vCgC9RDD?tpzKvT8XCs*P@B=WJhT_iexN z)%&9~^t+f?JbG->(aZS2qMPxf4z3*bFT_uL+r(o|utXQ=V?wm_Lad(cyKPMLt2>d^ zA1AZJrfGy5sJO$fpd5nXW5&|i4TfRv{#!8*RK@DVscUwManOK4gs*|9Cnsi0vy2bV7LQPpcovFu5yS9{l&wul} zhQ+pPZ0XL*$PvUS+3V5KjFTc6LYenve>AQdkL(DQ2+n+K!tXF#HfI2bG-h&g%6hGY zMYFYmjhyLd%W_B~Pp5?nf{VSYLnGG(H>N@Z0RcPl9tCjE z*%i>oHI4@r6Lxeed0cnT(Tt{^F5}P(3~FMmir*!F5(+NC{X;|NT=+HR^JFX9Pl{7%|P=-=Q*g4<1J@z z1OCjwuFQV&u9Cb&dZB?@42Q0GpYIt^y2AF{Of$24KCdTKlrAv@L+rDxdp&h=j#y?D z=RC3EFSvW#l@F_Je2guNm^2;lUIFu3GdU5hb9mX@7jFQR*l zPM|`E52P#am6-Qy8uV#tnT*<>5pm>uq2A2h2wAT~p4f41MFl<-oX}oMY*u>*#I+?S zO;jn?JD>rI>f4QEGM(#59V!xTvNS~kN-NFcdPb7L{r46|R#&HQy3?ayo{^VaSs^@B ze}CwXEERbJvB5QeM`W-7ZexWTI|a2g59&!WLE;#gn-Kzmz#anP-nyJG-avb&xjPu4C7wVW)YLL3igZ^@9aXS*y~`k06KS&QJF zX)R^eo!akU$V_pP6`wbQY1?)v%a;sYFk(29i~>cwR-oJQLbdbG*EsQ1knPAsQtIz| z;w7CP`_7(O8DZ}|JXbPvvF(;P2eoj4>fS4-DmJqn#sPm1ChtO^z5J;sN$k4MGZykA z9a?d+MX5ZX_?^lZAwf|Rp8vQoiET0Sv`OE{S+hE+@G^ZD(6H~=t!WNt%b)EKy(Bf3-lcliFf`G0 zYTq7^bL|<*+i86D&6f*FE7+c8DvWl8vIOI~70;r4-9Jt4@!tX69zq$N z9d_GBP&&2MC$<$7@ZQ`7+wH;TekE_P^TD3yKZ|n^sD8&AEt@LIl4c6>^FL6Fu~?4< zTR@-#yI|EeJ6tfQeumH>`Z(wfsoJC6>iBW!IhimBafFoT+niUX>sOjY8`kT=L8n@v zOmRA!^7gK|2w*(jLzuQ$JFqDx7P;qpp)#tchJ_2TviE=vC~c}5?$6=zFe=Nfxv3z;A8 zlsTwh71YQ$CNz7GetR{heF7?Fbkja$d4xIpeCY8;VJ3;yi%B)T1!vq6ZOI30OG_K9 zF?yQBp58OdgvZj)@`(xx5sJq7wx^2Oe9)(7Bj4oER@ZHBJ~`?32*{}9&L$fw+_Num zm;N5nQH~Q^YB#B;*~ei0V5fl*Es1aU@@XjF^TrBCD;y)zNz9-Fl=-tL3Y+s^qXOQe zBit+IubD+_$~ zWgsBdDkhoF_#Z%;+_{r|4pR4%!D4yzWQft=;(av!_{ki`YP`;o`_1PIRu)~4p-$ZV za8_sEujds1^Ev-_nb?I8J13d3a_ORmoy^u2443wj!^)R;&9kq5KQd~yN+{Qm=Zo{C zS|4hBslxi7lt1e<*ge~zPIx6+8mHbPoF|jkd*uS>IUzo>O_?caZEyRM8Q2x2Okf{RH1b{>g+ivx6l0Aw=U>nhaU5^S<;= zbbsU5^#ZK_v>Gd$tOk|o{v!o|`hy7m(GNntMyUb@?=ZNmqGBK@YQ+ASoVea23F?*U zVAc(ETB_F*K45T_&2L9}awN?NMmg>-cMU%qUY zzK<>Dd-vSAo#M@`tonWzk4c~mL(xtzy4)Cs6E@|8>KD~`po8a7Uho*5cUN+=3_J5r z_S`xw|KtQoqmOkV$@XgGb^FmL@lPaN)9|pXk%i0H-US+` zOwAdq+I_Q$l3ZJNIU23>BOI^#zyA8n`Y3V2zBv1rB*36StY=?ydc6|msQei1@P?$J zmfXb4YbQk-sJ-vrOV%yXQYlgF$%)m`6)96Dzl%>0*T4&?JWfkjAxSSDkHaZNOQoHA z#emp~sEpYUjnd7z;y%>2M|@vEzE+op=tO3I-wFGE{Ie4=4LJ^hTEs9+!gZ;Ek)U?b z6>>yU@|apqoQj&5uPa%nK!}wAH4NLgdww~k<(Q{iH_!xo_s9yIT!p3|BZsXj&Xq5Ftck5_^NlK^7l&&Og zWl&tXdJfME7UBK5Y|@WV_fRs?eh@#1GaPn$nP10``X7JIFj5XcK&M}yMYn-6IT~rH zHz@15@7EL&!C;1wXT=QUsBCcPF@~-BsyB}(p{%n~x`^(*Br-eSLQ(d1>g1N?kTS@F zml2h#3ht>*v|T&$P|7)0+IVL+O9kXwdmLG0jI&6afsgO64_>2}ABOzq?FV`5htf9y zeFuV$a>DA8zT9M@Xq=i<VHaHYs+~0Qu;W>9yXXyQf7HzFpw;l!XJx}L} za*_#oT&z2b4cVnOFFPWvn&;v#RgheKOYMwRGEa%seO!9+o4&(pA;QO!vt0?wA;Qt~ z(jULLGpSFW|Ng^w-nB;Z(goy~MLgvVF-?mUK=H^Tr4TflVh2ZXw`B3;ooTL10cDpXU zVpZw3Vru)uQd7&&XxHN~@qB+||Kd4It3WQZ$8<(;}&sonpnVWj-KS{eCfpbCvIYeMZh&$$7!ugs>IXMhafLm<4uo zV`W0Q3-5m2uDjTmO$zP}1*d&-cGsPY69R$man5Vk)LpOPeO^Z(L}*_{0h?_NtO z;)jm~A-I-XSz~>798lZ$3Zz}br*^z%3m~@(?5Go%6*z`Jo^CtGNtP~3Rxihk?5my6 zcV*TX8I&NMNBUVlVz#ZFEESo!WohSnT=p=X5=P;1Xc%@b`$|Ax(7^19sn(WY)Ygtn zrhOl@y6mG|c@j{{D>-A|-22?TqrO&@CO-T?u)@k1ZT(_1@0f-g)KaZ3`eeTK@uU2J z`Bv9433;!^FW5Fdnl|?UU5%2$o5pdR8D}9rHOB1Mzm8zSr`U>M(Bv2Af(~&?71u#Ua!>~Zu+#KF@IL6nQ}9|wJKf@Ep(uFR zJg`PDm`&9k%hd0jeDYCUBWYKpF4YLlnFa)1a2QS4ft)cWnHjkbTBl^7tUs1!=GEQf zuBN!D2u7=HLEgOFPzYF$ zCgkR-20}h9V5{AM4SgfsDCc$gwwzaDuixWIO5jpck97Fvs^d$I9fNah^dUw#t)_a=|WZp~K*N zP+5KEq+t$85|cTKZ&`!oj@s@8OHMX(6n5OfIxxqKMs4e%h?)uJeE^`<@g$NP4Tz z4+}BQQuVx|MqBQ!*qzNxP`TYG259I~AY_4ad-9Q*CjpE>347>8IU{_@%hf{A$@cD8 zFL%mlC%@zfyA~_D4er3Y6uySZWRVAL9*OAwg0x@1k^%v1psI!N{Q3|y0DF*)vTmI_ zm-2-jY3SNXQ(oYn@0~AP8AzgVgSORP|>N{ z517@DwK?3SPnHXbVp;^9faK1b&AKX4Gh_T=&J;PasDU_S~R0B`}`DEO^= zSO^<>NH>1<$7~3g1Z~FW8yOb8UCoIjr4re)J@em9cyl!PYf4D4ok{Pn+&?Ww#mL@ksWRn{wim|IA85-U<>|lZhu}e!Gm-jNT zkpCv72w9B(HhaIlyztA9T91y71WV0aY{DJ}==Ypxd9SHgg(&N>2IH5e)Lfoe{WiP|0sDT7GGxf`q`njW)|1?6$OEfR-6FJ%7A!e2Fnr(Rt!?65GD@FW zk;nM*!)V8GHsY}D;ya3C+Bf5&kY+>xBXxqZ07-u@-@I*Z{QxCDn0<24%MZeJHKI`# z=~ob_+vDOYdoi+;Jn1_+ZakvqIIgAleO$#?YB91Hqn1z=q`mJ-3VJQ{@aom!O8@**dEi~_6_*7 zwz%GjZ8qG;6;JjQESewTM2ovU4-kE}{l#`^ZES^}T^KQd&-s3R8HLu|~l^3wxbx~pz;zvwdNMJ=$s%Hm)x zl`K03^MhoWgc?T=#aSxhSk8Yvr*_gbB3Y~Cl(IC_wtXxF!72xi?KeikIj}Lq^@qng zpX0_cN*9m}P`PMh-HZKZhh1D!bE3Z#5f_9P%f>wJuSZ#6`Mp-H9^Uu*754bzxun8D zeVhDY6!^8j41`9Qqp~B%*!OceWoN-hd9MZOGxA>PUqoIWu~dIIoG}|hcR-z>8XZMJ zOn5MY`7%IP3^(wmhh+^*NR~cRRv&v@qRMYRy9qB1f(11uOSEIGLI%8Yaup2uiV19pyeO9q3F2&=W)MC-ZF|rI+O< zT!`n(>MDIPi>mk=!KP2c;SCXIyw{z|H$UW**7>I|w3}kuCcCjWn}i%Dv>e|oeO2J! zTiv|f?Z=Or1|Hp0k1ci5flE-G#~w)c=NBR6CnX1nxQKe2)E{G#%q$~99`|U^yZfnI zvE&kOIuD8aS_@BCjW{=~$I$@mNy9*DcY|-A^(VrhD~mCR%BHvr{Qf{EaT>gp3?UmO zDn}Er><76Y{3_z(YjX1wI-JW;yXxQxo3%cV)XiPa%sR&Vi*=B2!_8P?;fL7ekPHfP zG#vXtH6+y@gK(JZ=>0*%blg{p7DBdi;Ec{bDgm=*t93WQbvLP52P~W^`Vx}iby`~e z6FP$c_cg0Pvy8kS>{j1LCWowT$0&v}R-npMYeKz>5bPFgOvd5Ovx*c$$TEP_tA84t zS)X0Z)aL~k@afv!1^*zn*7qKSZrl6oBhBE%2=$urKzK%isuTgeQY!sGWhB;2IrxVG zYO=8T!h61LZ*Si*42TFv3TQ~X?n37-QkQz|vF;69Zn{qF$KB4KKd%qC1ZtzX)so`k ze|V}CLvdKO+tT)554Lx2pGIjo7LLjZgdiAEmnl6xJ?le(&G|VU@NA!O!L@UW5(+9C zqDCU8Ab@Qa3c%&~L1sok@7;A5`O}1f9|N2|l%4f@<1S*R6R$>IQbeAJzykdTxbL_vU#2NogW`~(9*{M_{QrvpC;76d)!HY|1@+D#cNb9&!d z;0{lFtejpS!yQIF7wb>OX|`$U@H?ac^Kx3y|EM3zdf+{j_1Cdj9|MqJv!*)4j>rB@s7}PBYuw?W_=j05&Uhcy8+fKLN5!3Dh#70Q$9x!t%qxyPN z$RHK%T!IP?0Q4|jOIw@KMaT#~nmrp)xo<3Xl>Hcg-ps|1Bc6r%!sU+Evxs_ApjH6= zER>b024wvkY>bete^_7qwmNQz&sZXIP}^Lz?b;?R>G|lZ zS2ILTIR`+@fEzV#x48b!SR?r?`r(_4V`HkV*tU3rCIB1d`16WppOvCBRO1fFw|;(P zpKOi^99bRfHE;WPf-_%f(AunD%9ax*LFsf8nXWPon{^vM_+nNAX+ob;o$bssH}@{t z?ej$POi`k$T|F;PXXr|ls)c}RNK4e@&0CZ-9^RecxzgO_)zaKLu-`unt=gO$I?SXg zu90Zdt2##JjdH5!v>edhBHbK|zsOFYbxdk}dV9`}Bx^+bMl0{lNSPoSeG{QL{GG^+ znbTu(c7C1Q+xJ`>3xDJaOY7J#O=){W6zOKmUPwyj^|wNkdCgo+x=lU`-!4!8s)4R6 zLj_k!HW3Z+qD-1a%IG6YXXqZWCOzipR33Gg3=?ehcUj?6Z)F;5AJijB`SRaniV{BK z5ILz~NL)GB=Xz$rS9ow^in< zIX(~nzz(fPC`$Dxp~7LMtN9rw=9k2GofCH-zJy#H4MAUD3v`|oBBMYzc=R zZ@sRF0ElMq)8stG`JzQuGpEUCkVEfFkI{IM$UMeMGtx>+&MwYI&1M`zv}<`1FJJ*0 zFYvcuWrl0Te&sKmoEC8d^$#JkFLbHM`qnaGa*_=k@v3x7`)_ae6fc$=5|5Vgzdb*;ZL zL1c7{Xpxl<$XrDy>G0NyhM?!{*Obb#)E>EU-?4Z~gPFz|p|S8tDUAt}nKF83ZdkY2 z+Y89&;VMW!KBwN!3jx_oPe1(dN+e6#-|Q6GDJ4NZG-l7OT-(RXCG`SMx9AU131()L zy|uF&Bj~A5gR~#<`V$9!Th^Cmwm|yy)TULTv-CGpU>+dPc&EX2Z|=A zf0+m7)y-vfm!!Anc+Ny4ciEox&3HH{nSI@dK7X`2nw6tm(8}>~GkZy@0y92gOY|ri zQ{7bFOmdg*=v2%AtN=?*t=#J|gBoHDM z0(o&?waCQ9xhc+|bD02!9PhvCb}9kYf6$#`bVVoP207(3p46Ez?KKNFq8$|q$yAu> zb31nE1$IBZt@ z_E#$79g!I``Z+0Aj^^E=aGCr)_Sk-M4kmXeg``9gl@&l8gI(rNYtQH_Pj2p{VmJ5Y z+|X?+Dq32}fGi=Q261qh@@IAvgzPcRgQmFwGe`OYm~kKYQmzpN(jEBtPq-P~AUO8K z2OD2QhpJnbQ_^f*o?A(&41B>IKTL2O{UDCNO#-Y?s0n;PHs5`i$DI>qaG0A%TmIX` zQ6<^R{pJ&KuP5Rv%XTg?;U%7EAUqG9OyBk1bzk&R5^RrNdnG^YIgPtGl!tm`Q(5jb z+xQ+jgJ$aK=c{pra+2XN16!qWMMb$#K{^3t!=td%kVie*+}Tu^N=5CoNt=KLPI}2s zj;26Pf6xm=V4t3H?dU20QG9zuI{8F=;OaI``=E9ee@ICmxzR<};C>83cAad-k~~o| z*D%NZARzUS8oM&Cj6XGG=J>&wmLa@iob>2ql}p#{S~H2jWrrUX0?31hDy$r6!|%$3 zavq$$q{LPjfr)0xUeIhQ<`|Q*1vo6FwfOZV-X#a6i7K7&&@!8vMJE9zW2>G0D$nu* zl7*umF{|x0SK@Q9(hLU+qAC8$?tOi)u=tmtcFBoyZR8i5p2xz)ZL;!SmkItHSD2uR zm#cA2Z6>3JOxX<3_(efs6{o5mM^R$@fd7tphch2lZ^<nKFgTHUBbzj+1^6y%);WPoHv4`!amaUTdgsB(n5(|fL52c!Ci|5clwa$ zUUrSoV=YX&zdIdmPtn)bpdJA3WZw@x(aTO@^;dXc&!nx5GXfyty-)9-a~m)ILQLt* zMKseD z*hkyw(8cKoBT69Qttv&j@pBnsmpT)!evNTb>-B?l^zJhg_5S*9`6@E_c4wKI+CxmW zme$*-`o1!rDUoATgFwZ4?3=OP$Sx4_XU@VL6**xnXB{ppLcHx2yi#5>YspjK++8g> zNVy-{7N&Qb_pXIhvcut;Fu^*IQfXDBslE)^*KV1!lYCoHka;SStA@q=wY`yRTI&=(Fcstg1tHVM|y%agkjI$S}mP-Oq9^$7Ug1s9+U1!LCC%) zzQ614pz0!E0dMCA8q@0GsOLlMcGFUi#$eo95p&%JOMV9UJkI^OdC4H(&CgaXY6CN)U0iN;HlssU?)B4ARvF6V~nRS#(aCEr}@eftu=nA#K0Oj zeHZO-SmLR6>qSYl<>HfidQX}BPjzdwydOmKp?+VFIa6=6W(&vO?t(X3X|6fOBr0re zzq0d(bYDrKIF~#*>Bv~>M2f?yJ;$;AO-V{gC2Xu|w#3`Slqt{GrNz;JKl~=VEB@M+ zM|@6FdchV@E*#G0CfLQ+lH}_LR#`c|0N>n<@Q6R*QQA}^LS8d*<8kCi58*w8p13&R@s` zz9&TspBY*eVl7j9mfrEqskETynOzMDw;w80#-*1d50HF9;&Dpnic=P*v*lA?i-T1P zPutuJRB*jy)~>Cu64@6BBNN+4iqx!fCBp(Eb54(^IMxjWx9w)ln$2%81f0NHfC(@m z;lB}a>ygxg>jQkc9UZMvktYeGHt_{#s-)Nuuq;&K>1^>i_6?6T1IFqH#-s3>t~6)- z<2@icU@>j-u@H8V%r*$R{obV>XOU$g_=dloTsR`~n0wK_X?~`2N@%FWZ`%U*ysJDi zSkOsOiCd6^m{JpA8lLF z<%44^B9z9S>9;Gx=O|{ahw~PAS*0$^AGsvy<6|!GWlp&GgY~Xv!mZ}hAIXpN<>tm| zW^{_GXx{Bd&(gZ5yO4UtKc>>?A!NV*$l{rsDsypwI5*VK3fOpQzLv#rX==N)^}!k& z1kwzTKfFlYK(sE^lmIl~#(*WLx#4bN#Cp~$gU`7)A zuz$oZ+%ucZKkE8Tku}z9?r4_P5h>w^p!bIAV*a@|Wtn5W!vb1?68ae3of8X;J)h*f zKw|F77rdaJBG>n83$??`!e8zEIr_OC*^cKdm1uCXVCEZ=SDC4&;tEsSd>FzR=wO5n zH&L_g^4Yc`wY*N88VK1oVtf|gP0Sf-lE@_n=wNpg%hN{RNFozdr(G^Ri{z}dcxa7` z`iJ;;MA(WMsxqA~1^6p`s|^By%=3zU7j+WJ{vmm7PoN&P2Oer)Gn@a~fRWI6bwJ^; zZKp9vEUQGD&XUdw*_XP%FP2o{+wY60#j)M~h z%ga%oqRy|9AVx;Ms+i=2%~kK1l`!b+w!x_WC=^s7yjPow(9e!X1C;5K}Y-uaqLyn>?SfK(~W*WXF)?p&QaIAROf2 zUoNK02rDx2k2iYp&IROV>rMGDz-_$g4p9YJ-$O&ZXFPskz|G{62YdL>e7{SB3oq6U$FkTIK88teI%O$2w(CPyT#y!hb3gNjmZ&@XbwIN8zO zew_@avh(Ys$kDvesI@}|FU{=PKy2bNoP;@KgN>L0B^vyEwWOqEeJBR#PokSjq&{&! z8ula1>0$ha>=8jx&j?A^33BWajL<=Rn1Jp%5d2fWf4zlnUAlNh<9ArRxH_N|DIO9E zxL%HZ)gT42{#{#yH3Xf@BD#qtB639sq54DV9_lavDj8@nD0EbTUyRa*pTN=7M$o^f zgewQ>4o~Z24pjNz%HrMiF+hspuf>*8Y}>SS(R+cVsj$|AooB%IzxUrK{tr}t%jRDQ z0*P8hgJL&-2+Df=%SnF56C7)nT;BcngPn@r9D=$HfCFo(7w@^|59Qz|gkcequA!Ly z)GNM;vj;qK*bfxq_qsVP>db=F1v6L-05behkco+je@GGl+IrJUNJTpdVk;i+<$+c-u zg})z&oPQC%QC9+}1-4@QeTigQ_xa`7QA+nhQt>LbFQwzi<0O+K=z+i90t1pfIh&s0 zAFdh|H0%5MLHbxcu96>Pe%K8rB_u8)9yx!Goya=6supr*u4ZQ> z9=9lTGkPy&Dtx{eeat-d;zkm@k;|XO<2n<;S&={abgJ<&aGYu=i~G=n8=m;zZ>^4{ zQfgo_=6UYt8ZOpou5sIyI3*U6(@^pcpH0+ryTTaG z)I1GEWjYh}aCIENEeL5>(dBaRZY`$Yf7}f{^M~LDhNv7mrg%_CvIJGT73i!y<-Kl~ z*Z1VDDGD+!yM8O=gqe5xtS6?|?|th3A`yWaWRbZk(OgvCTG^Tn{|l zec`NG@K?ZFIQQPc_TSPdCn@`)HdWu7J2v6*GAP>1_UzL8L7~!e$pdOt_?>5Bjv8@@&q(*+KA;U zxb{K2OHs67OAw5HGWs9|?Yb}?LlV<-9ACM>^uVsEJSM(jS__DNLj@KWTY~OSpg-i} zcUu(P&>XGkJ@+d3z_#p1eyr5-%kth=iup$8+^6~UPLTXUkhtLtj4KxYr}$&3S2U#` zvyd}u>JRz!0=3=9$ScK|IiV^$mwN7pvwX_)2R(Ty-;_qBcdaT)X7}f69hQ9m#~gS3 z_BU)&?0=eBn(%X&%m9eWVA!qlx=We!{Ut#U`;@`PRavn%bxEzfGxqFrRd9Aw_nKwK zQ5{;fD^~wqLs_WY)MIJs#2O-Dc-MLv!&(k^>0kBgvivY`vKx68c3kX;%C8`l#XE#m zMJ|0iL*-mb0g!x_r-`U6l;<=2>(yX>kW+ns9GT$>ge(t8tHLj9Yro`VjF857GzLQA zG}Pa8g&lDHAaJO=(AvAV&1tZ#fDxiJFKCs^Ke*x=eq1 zwTbJ1Yr9#3>3kpnNx^#&m9KSOX>FxfFzv~_>4k4=coXE^7*Riufgi;CUp)f+9?BXh zJVnI1L7$Z2+x9?J?b4MvQm))Y%f*s&=oBkiWbLjoKwlq-l=}r{0D3}iGBO}JGB!3w zJFAEAETMn`Ejh1y2v28zO(V5a32V`;EN1AFMsI|liM9^pI*VT4|dIQ?o}JoK|p28;q+-SB@zqMM+a(x#L9e-seaO7C2U{u_XQ zDegW985n;%dkMF6XK8FjAXRYYUm=I|T3B#c2iP0ubt>ZzMM$(#X&9>iBUKm4CVA%~ zM2MrZ$aZ91AG0aa82>j-0`2+IyP|`kBBg zmu5%)ifw+430BnT4^^BaAUb6i4S=M!?jeL(KxaLuIS9nSuM5m*wyi6v!7T>ZF>Eu} zyMsm$A*DCp6&>&A0tVglVURPRK!i(5HhD|mK~SMpwzhy}J^_Zo!d%@&(AQGckYB45E_ zpoc#K;&<>w@`-1v$igqJ789R>8ul35#VMnj&iaaa|bmd*4BBEOnE0l!~U_v6mF9$4%6F zMl9W55wU|Z#nlSvy-m6MLCB-U0+Rg_IZ5i}$7-1kPE2p10*+pP$QaSG74|zI1*;*n z2owBQy(Xv!gxBu(V}ReP2<`Em%U4BI`WbRA=M{Y&{xUYAHm!Z(^Eb1UR!QEP`MT}e zdvPy;ccQX0XrNCS=m|xg7)}7r>bJq)Mut7!40qoH0k;RpYW06_iVKy4gCPH`qb0ym z3Wo~~n-p4^O4wwvQJPSgQNPp@L({;8RQ>ua%TX9(p0h zI{u?2F^{i5threQR6llIKoGZq;o(QH{UK>*KR;jkI487S`Y<_*lX0c%e7V{YV(V{? z0@Q{wb9io$nSLd`CDdz#zM3|^$3_*77UkV4d)xi@IFN>&>6Pw<5q z@%-kMfOJhd2)TiZ@>L4^Ll64kK1vx^P@nS!WS*$pR(EPHC??R%Ah;0UReXHkyxk81 z62p8+rs{DcY#IejrHQNM+Fksw`aeL+Wj9zot#k#NjTsH1$R8Ho_u(3v)cqc&3C(A7 zYsXF>N#kIFx?35MC0gaj2wz*r6_3$9reattgs1L-8|98E%LO~6vkkm7 zUlKR2?4QC_<;CUYccCoNTo*OP=H`~>{V-Hy_l`P3R1mYI77AXzxt)0elNB9p}gKqxjuF7Wql zz8K%BPq+9b69!&Zv0#&l{R4nbgW|RLE?{R=KySr@I~cxC@4Z#8q?5vhjn_zac|d0L z-sOj(48pw$kC)4eCs+H9u9rgq;0^9PYV!=FrT|0u&iUeQV9@q)UHuN!favqoU^Wkx zxsYZt`Z`fbTgVf-@%*X$TV}X!4a%GV{P@#WE6eMOceFkOyL+dG_rgZV7W$8_gxM6n zrp#xg1HjD~A2r18L*0?{a>&e&fB5GaPMv?PY^R<*>i1{RK^0T~zY+M}Lse{q1UX{= zQgcrK7mVI`4m&mj%-Qh2Sy|`*^0R-I%Wp3N+Ra6q-^}3yw@n-TxAIy9uq{8o|HGtg zsxDnezz<}ih1&(1zwSD_!E>5#0x$oUdj8k8Q}Ym|TCX`g>%y!y&`VS9RWHG+1^zc${o4r{%G`Vd{}cc%U4XAI;m-x6j`82* z^S`bU^(WbXP$_>a%UTawszo!z#FBs_)=quGBs)J0REAri_gnM_zL&Ukt(Jbi+AL2z zWQR6u27kI`?xgmou6k~QE#`G{x}1DyY0SQ!;;K%)9IKakWp`|k61$^b?_`RSzQX0A zPl}PmCubwvgRn!pgfP+GS9pMakkz@(iQWY!*_|4DBrK)c>qpx>RPaT8&IMGuwD*Hc zhig*tPjoy)scKoDD38-exux-e8dVhbTX<1CW#mmV?=X&0&g<15xtYIZT6X6hf=aFC zp6@A7R-sBPW;>YC#py3?N~3tVJlfd`|BEO+jk*Fg5i{F?5V*H%z-hv`g*UBT&&+QZ zEq<|kWc4yoj^|AZQZ8{xP>L4K@?NG*7&`XWNIEj9*X8-=E9{tXR=?_|8vSjUfZ_T^ z1YI=p($(URmm9eJ)5@0qkq1`p^Mz|BD# zDy4W|S*E_;`?$`Sj@$O3mFGs6Rfjk{(yvdy_r{fL)Jqu>dz-jEGU<|e$8wIg;ByU# z6_G%f`qajzx6N3s)uk&h{3Zz#Wa{>s0W8~plcj`XNFcmPUcK3@!VBE)q*K{hho13_ z#2V~gY5Hy=&Yh$xEBo^nP}zFww_2R(8+-FdPI)rUjlPDxkXK+Y=vX3ITyU$oP)1$^ zl$AXWgA9aRj!ub>ZqJH7I=1@JBOjCx$s!L;+kSKp)jY=%?QD^Dr=_6$N4N17Q0B6= z`XK{s2?LR%p{58gA*%n4VpurJ0XxM4nnOdZ10got?fER!bOq@{W_yD!Ysm-7Uss-b z?N7wOERL&zN;$h&!YO*ao43d*%PcwE3%iZ5@Rkw%cYwbkfo=|B_}(oCprSw}pFEX% z5$Der8Hftr5iMKB54%5d_3rA!2kKlXPFhW*^;{DSKte#))N#^m3hGAo0r~pkG)NA_ zU3jbo^8_sBWOosGR1kDgC0;ZYZ{7xHpn{Xh3oUp)2j_Raxi@}WYdIRBiugcTKA1sq zgqOXf%d5uAKvs1ew+dP~N<-MbNP4Owkubks->$tMF%VMjR2#{KWV!hZX-2%|1B&Wlc@_+O^ zA(l<28O?v0iNXz)zw%Byz(wHd9?y2kv+HsYx#c1E=sEMXT^y2ecZLp5Ivs7J1Ty9o zir4h#eJi>_#6-MCGAIO1S^7E{ z=fbeOJMrj~VV9@VNA=+aBH@r*sTpvkBybfMfg^$OdX_?|G$ zQr7b3ZJ^QEEv2REE>)l*8#5hBQ5Wp1+cmG21K7s;v@;z%dYh? z7kxn7te&n}h+yI_2qVrFnWra9HOCS(far@n8%r3=d3uR!9DWI8C_%Z?k7(bWOA!xskJL+1 zYQK!k416Jsx=>9Bh^a___``olWq`m5G;cyNuV%c^dsF3knOfR9e=6tjLp@FG!rgU8 zjx0Z5%X|29Ur@LC1fk(u3aostFE>$MS2(NNmQr45`}Bp{i^ZWC=|}w2-INPTVJV=x zcl67#Dvz!zgKQL{&8-GFC%mae9Kywv(M%dEdD zNOxG$CBq4wBPA$k^f}f9Nc1*UcxTAbaL2}Lm1ylGsULl1bp71P_oKeimN6|FOQz3P5eFELC1oDCNKZbT;NV!71nQ8ggfmC)pdFYC6e za+iG@j*#5(it8g})V8*@ul`4lMp@3KXkRo&C3jA6)OUcChG``pjBk9AgO4?w9T;hY zO}kCbo9#*P$5#qJcETm1D^=u>V`TGfH(Y_TuxYlVRt_2LmABLZ^W^;MzE|{2=;dJJ zR`(#;CpjbVT6~PTl$r3-ZX0Q7X!$OMmG0|q)q`g;10f;TKM+^gUM!j8$Es51`V=4N zCKfF9ggx{Sq$_Yu;gsQYQ~%(xeFZGqGMB66;HpB37>HV^0c!W=^8A15vh!C$S9j&F zHanTK?{^%~$e{o?1-_pALdjA`u=)yFIVeG4MpV-ZD82|i4v!=BaI8#JEsY)X0q^@H z@;$ucUtx|`Y55Ks3Q4QP6cG927Rtq>aA|Xqp%85Uk=p_D<`9QTP_=QFZd;u0N8X3# z<-=h^E)Mt5>AlIu+L=U=nS?hPD1AisyYq^!4J|l#a{7BOtZw!q@zYVsrTpKmw-d{w*N~b4TZ**N+u*rb}742N+Ajf*|TNKzLSv> zSz5?GO4*kr`>sTGS;kIT#y_@6Wwzq-;K; zpnC^aRb}@%V2-qLJPVuIrFKzYmO zDQ&!L8(x)rH)pBm%OEk+XTtCVKueo+UFtbScAZI#S4M(W zd%`$BxU0oq!5|O^=-a2+*b2SmN!Rc6>0pi*oQ1det|&ERFr93$avh)*b6$Gdo!t2f zQ?=0Vz8QOW^Tgc+rkAs3)*L9rs$9{wTZq?oT~4$aT2c)p3nsMq0$v_1@flcHI+!1KCC*M#3YlP5vY~O?q~HqQQ@XPF!c0Ej&W=}Tm_NMvUzk`J8{I2NgyzhMAB6wxU||u7*Cg$7RXm zyfUpuO_$&`YriOnGKL3D1AA|(Gv-v5a$pVbl5+I}EYhWsQm26{61Tpd5pNxyGjgs^ zFY6v4AnBT&<9gqHWrZ`)`4|AHOl_FJg+|v9TOwD(fq}8&*Pnxol$s2_Exok1{le6HeP6ZjAH5K zv3m8oTL{a=7gs5%ZeFsN#KzqEtQEyNu)UpQ9F|&;Y2@D$py~0f)>7o%GQifQwHMt> z1I#Xmic{Deb{DZ|oh10tIn1)nve}+p;Eldk#iMmZZYEi8AAa?Bq{lZ&S zi-*2Mt`(nxEH&LH7de2H*ds{}_-sD!zjC8XloF}8QHkkRUg%PE{5s|^ta<6>k=C-# zWMhtlnu2#IUXE{E-PbXV>EnYPy>apKMTsjKwOQ78b+ZE?8yLrW*V>$~xqSZm_`1bA zpw3#0HF0$|u{^V9|KqEYaCI+MSoZ{iMQtT& ztPS~W6hQ3};;dDG&qt>*BaoxT>pI{tG}%}2G9u#MGkA|QtcZUH3sYvV<5-(!}5STN1PB)kF z<_i_(RYlUlcUPWz@ah}r+^Vwu{6?4kKI7w?3{O0dP408vS@I;;Aj z|DtZ}fDU>ZbtZ%fYEypdwjmcetMAjW>$gK#od-4}Vn9_#n3=}I<4ZI3c?E%;_RU-r z=^#r4>?JMWqAli%hA9~EJPf+N8JE z*5C3DJ^j_lboH4-LpX?ku~yOSjn@1d@OTuf(8^rGv5T0B7BB!Vc?XFtS79Y_P=7gX zx;jxnmb1fgcoS6WP{{_ar(Q1dps&tG!4|oiYp+Zzz6JyYKPjpLIt=ok9EA5#h<1QH zkSM9D8RNJ6#GG@LKkvtRuYz{RRs&f{HW_N6rMJ>w$%NIxC>M;am+7IU&1$C70*XT2 z1^Rd^1zW=QLm?HLnXxEZcSZJtzgeuX=`AH@EjI)xGMyPX_!t|MZq%fQvHHWfHtXt) zd0r(?Ue_Q2QGPmGQf5ot9AjR0T}aPRwfW`$de^Nq<-^_U-&S6$)mZ9UmMExhSH}5?Or;P$tk?*j7%anOo|MF1m|9ahq&(f%=_>>`4k% z-?Hu#>>u>pg}`F9OEW^Ju5Bo>&vO^wYK|Wji|*%x)tOyM!f@jTa~vy^=&Q1B9Aib? zYC$|gA&Ry$4vX;ABQYbj-+pWngcm)kqpR2(FmOOeB>xa| zrX>FsJ(u>3*tsIQYBtIw%ystnnY44~i;M5oAlLBfnP9EHn)fBhOLASW&!dhNdy&ic zBWjGdpG=&m$*=`^H@^juL^cXy$la8Ipjh}_X}+GnL5V`ECfP->8))wzhydzP&wqB1 z0XiDpE8~+Eq&aqny>3dZZeExZjmkqv`&GB2p6FjeoxbpNezY7FB}opdK>!1SRG;rz znc;IfihSPuM=i2JMNug#c#P5$Y?el-NqPg>#nU+lZ`8z?x6$7AB z{{O*d(x=J*&5G7DrziNmwNi<}dMI;c<*wqlie!GKJda)gKm!Negx{q=T(PQjA3msv zK6rr%dUyQ6HXzYkCv`ZR-F5!-iRm9xUt)tGrmOoa-m%2H8}k4$CRHE!!{5KjKcp=R zAc4`212!!y8T-G$Kw()_kB7)(r|;jC+~S%QCS=J*zX<-z`N4lS;-5unLpVRJLUkq)=Ne`g_7keGc8QPkp)j6ljV=&$9^aTh2PE90|nTK zWVAQN(<~YWU%9URo@v zoA$Cl4STD-dYZ9<@h%g~05%{-%|68Jt24j+=HiCi%Xj<$Q3s9<0<||2`|nKqQIMcH zFcD5awfe3mK1cDu2X$X7OUcD}3_cdWiOjhpA!d4zJgbzTF1`8U1_J+BWrc3z z-7t1#Re^{3#R`FRS->bK3_gjGLS)IH+ z<2Et(*}t~ZAO?8`~dSihVn|XeCJLT3|^DH?gtLp*l%P?r%(g3<{qoU^rqL9j^&(wr|>>m)VoYCdT^THlVf3~ zK5%~9kVkF9Jc@p&x`TXg;Pvm!;%lJzTBohB<@tUhck^Vqjx)=L)s+{3B98dyLl9S~ z;^p!g{YLIS>{-?Rm75(uKyu4EL-%P=>j~y~J~6q0SG0GWJL7~+XP*Nv?5WNXMv;h~ zOBA~B3*A$<@4W`T(t7n~AWznN`&vKT=&Uejji=ht7e4|tK3;e~;1O-nC(>|pM)8*8 zG$r6tqocfepHf>^H1XYRgLL;5#h4$;)x{nA71-aiC<01^&(E^hY*y)^AKa+yPXY1Z z^))`vmjk9C*qf2eM^JXQ@y<2@D5z8p;HG_ETyTk0?M^r<@2=V)CP=~H)!D|5)o1AO z+MtH^c&be;A|U7H1NL*-GSkaBGwXzwgzgsKJf-@Sz89;L+g@!LRs=%@;|Y`|-ziyd zbgx;_{YKCThPlrY=vZz>eeDz|&0gAX1R$$r#zVH@-&M{fln#laS@GBDp0V)_p( zLj-3KJa?CgssT8_`5lKJ!9O;1rZ#9Bu+eq-+bs2N6hwEP5(VQ_TS~F3N6ObO zO<+>yaX96Z-Ni?D7FU`CCfc6AKrsXLFW$!vn?Qv(uw~3zmNh77AEBISd8h*lHpS`y z^Ge?0*xC}e+DL7dN2|r!k~aJO*)wD+OmQ|S`AhK*S}g;%j!Uvfpl|1Gr1UA1YFliZ zctVUP4nLFCmv9?=@p)Ua2m7S)(RUiwlf@E-Pa@Ujm%e@fwA>;ugn*A=;6W`3cf7j} zY#n;ubN{TCfgWPB`20&PA^DcGR2o}+L<6`=`uKyogQf?LK0EkSbp)UlG7gu#bNIOo zWe6Z2Qq0FI6XkJD<9yBbkcDO*X651zxc=}j1n=+sb-=c_DUbYAvEJQ_eP?djwUYu1 zhpl0PyO=|6ti!n06nzIb2SD`tlK6Y!Io#TYmrh5LR1+9d-Fia1nmGT#bV|+^=d(6(qK7nLyzZEdy7nnQ};W9X-OY@=WLm0PE zcm-NyeAS!TYtY@;XrUMd7;BY1!!AS!z7KW{uPd_~y24L1PT?SJmriV;<$;Fd%I(LJ z?HG_x1CNn@Cu`-S`|yzPvEFiPco4*ysYX(!OJo+U-wukB6HqT)_)u5WJsuSK*+Wa1?uXHk>eeP=W^}8e7@B7hUF6S zsSkf)NNvzk?6bRCnIK0Kj*~eNtrXw> zJ;o3| zT|1{lvr|5wHv=w;+@63z8?6oud6$YzT2To#JU~ykWc5X~CJVIKX60_{m1c`!a1K+? z8BgdZ5HOL?+_pCTF-mrH?~qFLECa>z^n@ArmNyUS6u6V0q7y|x;S~r7A?Z(inqEGr zS3w$ZQfpGJ^kv&8-=LxfMs~XN0e_A3_w*7nEz=*<#SJ$cYKzpfa_ARC$7W6z2L*j) z%_X})VNY+F;bFvoODsvq$M|Y<{Cv4?W45$QP<{$+KV0=a zrafg^N&^#FFGI@Cj7!e66nI@K9Kj^q^V(c588Ia|gp`?q7>1Yb04C1L6!|fph%kIu z&uAJKRv0Dcn)6uU$_;g`=V6j0XGOd%y~1_(C4fmIjkP5uZg>VV2YDs!cUv83d5SiB z5)b7l?b0^oFpP?0&!zcl_Eu-GZiS%v)MJ~emO#E`Kc`MHwF3y~{{MvM&cK#6_wXI2 zrP#9*84f3&ZLtyw4!J7mZ2D5W=4K2dI&BLgsOl;lEH#M1X-1yo>fcv6ws7TBnj5rV zs}!@~TBbgUC&xI+c({nI$@ON_O<(YZ+yYEjj5+OG+NPzOesquSou7VVrlD&GZ!?nh z-WKs!zdJx^8H~AdRbybrMJ)8rEegkb}`TTl?kIZ#k-dV zsi)sWXk6p+SE7RZ9SR(-WPfppyH3*NIs4bx#=1jf8dslBeuk3@`8ld7VI|8S_nvWy zy>P^iRp=3I6soMtEb6luO1S2$g31hbdsgs#z3!EDY4f}0AM@mx=e9HjrOuetQEoAP zDD<2PZoMe`Sb%O=nzO@fw)xumi3BfhtFUIr({3mR&QBGT+A8~~baj;7Xxx2bUWo;b z`*?mT*>>o_qDyr0=j9;E(c9r_+aBA5AYyNwH&jPJhYyy2E}3iIs$uYFETRhUU9fum zml6Vrc`v6GXxc6l+h!V5!AOV~oh_$x*^)k?59NkH#(z3suS@Jo#QEh*Y{uH3>&D6! z0(sXv67G9~45}1KtVo7{CLzQoBRfwa(Yo7+O#!K=$@(pCol?-F971>x)8V&&#qp9uj9D z&LMcl&JbzX6FL+3tZGH8cQ@Qu(r@7|=%Pyd&8gNP}EFmfBi$5H(8k0m9a4n#c=A8uf{hD00&g386T0l#Z2H*^EG*_?Y5<@DOp6fcthn z4Gz*HzA3=}*}I;eo1S=JLr#<<1YBkF81nHgrqAhYok5X(1qR zC^O070<&|r9Yg8H8?}u^O2M<91-6OB2gbLxJ{s9ngyC!Yy3LX#958BSvbe&e}`^fh#E^tMxr8L(uUw9>g z(C}`Qk-GM5%r;uN%tUJd^QC6cnJ4LK+E9Le=6t?}w4J&3zK73~z2}NVgU<6(Ij4zU zQ0$5*N*TE@71yUItz$ppTEO38oxIXD=8Lv#E|a+@fMaedjqLi*+?3 zWmYtE%Wm;`!;2sVQ-Fkg+yKdtyLWp}fgdE5xM#&QG&F#m1^kb}q6)29pKA3uWj$Rs zJ%`=*59z~l<57Lvc@++e%l__U(0m(wbmC}560MWKC@1dPvukGOKo_K+5$@0)1e?lB>f;$~#FzXvfYMO~-pK3o7QJBAjPQCi7Vy*s=?RuLrW{RGDLT0#3wH^M@ za5N>9*xk!K41xSkAATJ>$#X|~piuPw@e$2TJH43FemAQ+x#Xrw|7Jzn2=T;M*;IFM zO>R5`)`xlZ!{1)KpV)5pCD_Z`!1~N_1d=QLS{!=N?UV8HrV8tE_LT0TdaVnayvfUB zLl;h~Z1vB^qUrVpafFtZX9$^u$;PEcM;IV5nAqnSlp_Px+*oJ`W#Il~`C#?$;P6dIV zkXg(&rDj*tE`a$r2ytsm{=T1sg8A%*<8rWZsW&!!bK}WzdhT&0igIbxQ%45g$RFj8 z-^Il{ahrO&8cU#C(wF_s`bTgjg4o&&==GlC{3Ym%1YHrr$VVi^5bL)Hy=YrX{qDt! z1N^19=?yH|uQLgO+5@j>m$=tI>uq9UVm`#euDY_%g8(cCiw*=*xv#=mVoT$yY}EsG z1oHf&mmUo+b7FJ_{aNPs7rxQ|+~K1F3iG|mPJLwsnyI-4DpqGeSG4mNTAtpX$sECG zvN1{oZPQF|S`Ev&^yo_pwsZ9{_gjb?O>)~FmrBm8yBC&#o-Z&;Vso1*T77m1mO|U9 z*U}P8j#WO!&dDO$8s&5)_k!)X%+TCfZMA6ok9oo3eY7VrZ@)uB+gg4o2ThCDlt{Al zs!hQA5Ts6FG0iJ*y5hRg6O2?-;R0{JGmm`CvAKV0UOUuN0(5zl=NZ4?FjsNryIV6} ze!3VxzOnVpT*{x~$DH3{s-3St*?>3g3~nxB1zuH(k{Qhsp4N{(Lv{S=33V3&Z`9Ra zG97`u^Q*hauA{K9G!_#GF^pzrR}GMj+|n;|&$~em?PwdysOhr-eYaK47iPbsfJF}b zx~>PW3$` z3gZ;GvFgr9?O+rAqtaW~T-{su$~Gs~NkTorat!xe<5C^FLc)>B)pPbdM-ENSI%~IB zwtw@=oXHDeic8EgOoRJ!Gfhy-t~N)OLLOWelJ-wCMNtl|gYC z^Fj1vTg7L$l&#y?yd6z5F>mp6OGi?Dl(BNW=3;xltwk^{)W^MS6L(yW9O{k#4#Vb& z+J@I?(9>Xbd>=StH9u!08k;XA*YB^6hauV-HnA8?VK$-AY_ralIX#WuyeR2fU6AZPF#XD8~vHJsi?s#M0?hOf_>vU<_e$|B0(UXdl|qB^cR!&*i0)#^Urx z*S^5}2vU|@!feR#xF!AynqIBNp6A6Q(VK`3oDVRUbtT$Uv#90*YlQcw)1N)DZF;Lk zFvX$VXz4?@6T@}Df21D(_Z6=$n-;UXZIDMQVQxqcWymgBkSH1MWSrJZkM&7JULBgV z>l6|3dJH|3LW@0e^5`C4O!wa0u|U_HgM~Q zp~!anKTb`B>Ncak=d)Wtd2%QvppSWkRc4)>@5#>|sV4i1gxqVmHM`Q4TZH-ky?KFl zs5Z00hv037U!CP6Ds+*2IKu0_A4E+?2P1jDnD5g3XNfVON5Wjt4X5YC3${#c3@~N7 zrxWmJa+s6Sw1;OM9ITRK(&!>h*j{BeZ>*1>QwXyV7;V21<&>d=APsL0J^n<-G~irQ z<+saBK$M6l%#})e@+abw%YmQ>nche$87hT9Ghkb3-bYOP1QDddQ-lp{l+4FB)3djP z3%$3HX%``7IA{1N@VN757n18KY$881rrmhAFE{SAWdp^AmMn%EY(n6t>}UD<@Q>}R z@98a$AoU5Td`MY+0D8~T@_4^+ToRk>@WKu7MUUr%jUs>~xKrldG>Nf(!AYB|8Cbd;4Q>0TwZw^-j{ z7D<`35PbqPH#6VQh=)?C??bar(iHiskOr5)KL0zh*y^E7yQD0xCC;95A$J6l-k~%^ z$*K6>!%`_;*+@7-smCdIK#O)tTss?^2>LEh9n{2R2TL7(=)KBcz#|+9!`qmZ`&@F1 zM?wVKIqr%nBv?+$_!vGuy4fI->F45ghAQ2IpFvrX2mA-NY&E&{fk#}ECF9C%Q5!reskALMEu zyBlUuKf|k+OaS%+@cxwIi@xd%TB=4l03~GG)5VM*Fz|)aMoz*ue|05|B7<6qY*m)V zRWWDg=4Vnn!WI(I*M8*N`Jl)Ky_F0MH^z$}APPcX(RVsEik?=HIi^N2v?0dJA5VX|;1wWDW?ayH*VozzZpW)KZ+ z?gG8-g@b0zp>t2CX*9^q*FCmg9Ds5sJ-r8vx0-2&;<0&a1}b-{q!)t~o(oAePKiwf zM=5$vPW7t~Hv|%c3un`!*#^ZE&t$UwoDK#*h*Z+x#03vvX=2Zj z?fW4v;$k}=VX5u+v>rz=^jnfaMUUBx=?%<0Gyz>7A^<@QfPpmeON z4=Q)MPPqDce8F3k2sRI7K0aXd_>j7jY<4(**^w`6+xVct4wg_5) zWXXoXgAhoI7@Mc{yz2w**=qVJq`pJ=DtTQq^&Y{7EW=g$AdZD_>l6<|PCYE)z$Dn-2INydE#v1NVb`?UhKp z<%)QK4MBzKc=uJTy1cS*e@NJDQM7B&@UL7m3BnO!Jn-@42vWhU4>lV}pN&~bv#R*+ z5Jin60u3^H6&x00zLy$^4v48X*=ugHpzW}dC5_}bZ_UG@Qt0x+B+2*HBx4uJMW4c} zSh~>RZ&{YzulqrggeArV=M*-3E>u{jA8%)q>=Fmfj{ULaH_p5JOwPnYpbWO!Q?tga zp+1op-W%wmK$r0u5Bu-KdUp6ITu_%7C9Jy&#;m3lI@DEmr9vkzcj$Z0J2fL|zwIHG zA^Bf6XJ$^w-QA9%H1N5?>Zp&icbB+i1N>2*NXH6eKM1 zu3J5Kr!`ltv0S~mViY~w{~Z5hlPnIEULwj;jyc;?F3FD|EgLdD?x3^1_QhG0x4dfZ zTo152-wRAQ*~-j$6~3NxsW8HDCtFooHpk+zU$2G9PTVPd@HzIXULFY<uyDq~xGVj3=_yk;p_ATgf<&Y6*qyM1H}?{k zfEp+?gB?H^B~Y*t9O(B4v7VZ*>V^_tE)tsr2kpj4YA-qU&2vV!5l zV-G1{i5slCq;MD^&{SH~u$Q4svG;xGDU&&{hX#u~4nqRenWy;D$7^*}bdB44_@0wN zxw$c?C2uK9JxhoC>Ky+5s^VZj_6-hyhQ$q}l;Ac}a;3(+S2OI!^DLNhy_EME=nHG` z)ZGe`{l1S-{xO7bLX8ait(aWWA~UIvhw!akO;v%Vy;8gYO~u#~0GO(ChL+LKwrUYFgfou0q8CW;$XB?NMx!&Eg%`}yo3ovix(97huf%>zeDn&0MG#`?@k z%h&{xs-+IE-%yNQFX=jSa;wzLub@2t#q`pwu+S=wuz*1Y_Itbuaqzj4RmEF1SWuGd zicWj*VHt?Dgl8Cf6SWL@RbzL^rpo0Q;%1%3Yb;~3-jx5fH*(Ku%5)yn;(;&_P!&eC2 z`i<^iTYo`4fm{k2_FZ#{7ch}cD z1a0Quyw++FivdlBOw9UTFPFdE~rW~44#4FR4^z>Q@B6*4K!(Y zyO)ZDAS4%;&J6IcNNgshkC zttcFUN$TOi?;Pn?W8S_8j~XM%)Jh30Yx+I|9fuiyL()sZ2hu`={+RWlD9efuAA~+)sbMJ_ z56TEUnpq&a^ns{|Du(dZw=RMqAB4#=b4VH#Zq*do6h5%rPjZ+^1FkAh+UC<(!iD~& z*Aa;pQ6Uf^{qkL?=m@6aJUz5pL_#5f##aDe;l9F+K(az%%aeHL>%X4t88+-ABU9_< zI4@_`mA`U_@t=soG0VLnft9Q%PUP6%OSXf#&%k2zvN4tU_ zMCe`4_`2pUAt1M|@3|najUXL~67bancNP*6e>1}eN^OGjz{{dO)*!7M21nr`Bo7`v zsW2uw;@`|BH@MseSP)3by=X7vHNcj8|^VfH=2FU~b!D1V`( z5PS%Qb#!zT(y-Sl2i?>_a%!*W0j#(`VvEa*zZ99MQL_{=qg!h;ORPA3ulpepNAx-njAt2HJ z*lZW5{l%=JZ_384cjnbDF`R5I|JcH*Y^I7zB0;<;u$7H`@cYr=4K?3D$j43b78Tte ze}JWe#`_I<(;hSEYS;sYNz=y%57M^&8C+&0h?24H4JC%YVOdUy`nTJm2nTK#;LnQ(agJ}iS^*CP_Wd&{iEV+ekFaxAf7!b( z_*FmCU2#*OU`T=g{8lHDW}hMHpD9h0F9SCd%fEMR%oO}MLij1_tb&20+D_vp5K4Py zGx>1un0f1i;fN!kBx={`V)V-V!5Urt`wad&oC;>?_$ktA$ga&3qzz6O`>)PA ze?AsOz}Ayk5s{|kVBgS~5;U{*P7`0@SbAgE99;wV?A~WNc zv@1IL`xgO#vR6|i&OLT(71k>(n4E@kd7CCh^4Tl1tIczN!c+gby)9|g6hk?%UtsVB%O7eA|Z>w{+H1&aR%7X z&S#LwGPurHk;gIcYD0uf8zbM^SX*a0EKjt(5ko(rJ;Nc1RzGxH^eG;M;Xm0nPVN$Y z`kXRxwe|ewUay%)rb&8ah@8EIv*17;A9|6$vnoeI8^3;{- zyiIIF!I1ZKnfF}3m{~{4jb=suvQe<39$SW!X8k;%kR0dP-bijD)M{I{5>cSnmv0@n zGL62nTB>vu-i`qAEMl-Nz;W+;UvIsqj$S;JPfV_{9V&lw2sUvCzcP*aXfx1TG!~%~ z8)H-awP>YFCvJ7NPXaIiID?9+fr*NYNEx4U58coC)_tYuhWh$aG`0jQUEY0lADVJ! znl~HcB+y>c?-e(ar!EYYdzG}8dAPXfY6wLNn^FA)H3R>Ra*->Kkoh02hCuJ#yLTs$ zS3y-zZ?4~SsYwrGL*p{&mh5rZZ*$-N1E8PMvfVXBMM`I?bj@t%P=qILz{Tw_Y+|EL zFn)0B%L>sbAtCux>@;1$NOCGg;XfN{w?w8vtNoNA}t(S87yN5-jl5 zLpRBwY3b<$G>9Ax_DFH3drAhwzT_wG54w&VHk;|rxeg4fxFqEm_XhRU;rZ{M?D_;6 zfXP&YjH?~4@+%uzTWsK8I>xS=>aAhjy7H~;6Qe|Gvgok;&h~q7;r{T0_9W%w1&N-c zbq^lgU!}Z{3v2ih zoMaF!eMB!G$EzZ}{&uO3EtJSzd`dx<5_eh;FbM6AbLGySac@1e*iICl2C4zWqhDXh z)9%0!Xu&MNt#srohheeOUcEg<4#_1x%Ft(XcGE#mnqtmNm^H_Ky&5Ll z*NIQ{Iw5AyZiyg`OK;Y~WLeU5wHGfsN)|=upVFyKYrE7V*=$?B{-vkbDc$45mC%z- z=Epb6KthO1d5t#iMh~ko^e)h?jnljjXYSS{9e&a2gqWPfI_BpD5e*SPa3xjU?48>Chu7tiG4m z7}dfI8X|c0YF)GS%ARMH*o|CHe*5;bR=!mf-qxREhU>_tBk*f%jsy02C!30`)yNe( z)mBDUaR$Q1(s;Ns&c)^wjsqEFpb1xu#9AAmxig@}$?oyZes_v5tq&ZCz5WE$n$5ai%w`r&-6g zEIiz}b88T=jYdu}$h8|iJu1k`clP;|`x7Q%(?a|*3NMB0e=&c-(Z`&b`LQ=O%44o5 z5-aFJ6BSxbGPT^2&(aC^O>**_$*GO? zz?Pv?Q&R3T@axSyf@&Ao%+B=Yfy6!De8Dq3yF{A07s1c;5B!qQ{LP3GmcrKS_F@!ncN`!a8fQgE!b@V2eM0Ew=0vD6JMEhbFa@;Al7GCIeKZrnzyTJqWt2BO?Z zs9c^#x6H!zKbqg@$}jR$ir!a++3oC(A{iiJc}>J1>w4A?>~CifMg)k*f@B6*mOMh|I!g+CfWa@&fUJ z+3Wp)sjL`%zb26Wdgw{1QWJ1yRF1L>)Fy|RIk8fP_oKZ(R?H2Qcuc2W>_2g(JC%0k z-u`1XSz8l@c_>YNuX9<#;#Og@`fHIUEMCjcO6G`~1Ju8|CysS4cmeqp`QUN6?1$ty z)pO(;CXoV$NIcoiH}%v&J>0d=NE25_m>>|^4{>%Ka(iA(xEoz;Fl!a&?VaG z2B^~9fY7y3O(9@p2t~(PIeB=3bZj0&H(RWMKKyI`I=q$=n7*hmunWWk`)uJy%^ND1 z`R8rxf&m8fjV$}^saW(Y($w*Y^C9)~XQI#C)b})xzosiguy=YHW1TW0&Z&@K+%bW> zR4d>*Z(uvXU$H4PJ8kf43>X5|{fjO`Ugu}wzT1y zAsgRXeFkPGFZAYHH!v0uw-E{1xS0$-st=KcS+SBHxfe4v!J!b=N8>ApdD10pNE+7; zbSe}k()E`KHow;dyV*t#ZDiz~a#dER&|~{V&prRD4S2>1$;Te(ei)onWjS|G{hKv0 zgNNc!s`&8AHus%p*Taa!oPzB%4|$VqHDwhXoAL<0`^k$vx7RT%RG{l$hUo^`0Gna9 zN91%TV3vJY9+fYPSE6I@F0?aFuuNm;d|&zNBmCu=zis#|1B>gfb&UI9t0?_VxI&n& zNTl3rEB}MbCs6miXgSs)XFg)$m)?)8rs@fv*4u$qx!U8gfGHhf?f? zwk@N|mmdn+QkK9mMS}?9jUUC2j#=y7xbgiFS-kg#h3)a^79md1ondJ_7Qj`jgN3J0 zpN676*2iA8$M;rJv6yQEb1cC@<<{8uc#k|5OADOZRzxgGcOC3-rxlAE5IDu zKU%a`I%qtQJ9WUPwfd}PvWql81W%^7)}2zWpc$QL$O5A3OEBLx$Fi9RvLA2={YzwI zR7zo$`l*#kKoqyQu#q`ubfjzs3NiM{b(18 zXm5Hq-DikY_k#e3FyR-W@*hDi?OpDv_6)9+3&O*#bUVJNwFrXLgX)q5NrHpY8KRMP z68$xUYI?jWrbM5kyN}N?O!nO|+DzQnGpM)B>@>wJ%O$+Hc$AWE{pDpB5NaL!w2W!4YhKd-M7LWD^C@g&8=n z>%DoFhe1Nf;u6>@c@D#szAvZmi9DVx9e8he5#V1=>@iNuCe2{3jUsp?RqNo0?$pD2 zZe!t3kq}Ytq6(1sk14{$2TfWP;L`au8`WV^AR>JDVwwdR$QA_a#ji%$L#sR20;#A!9{rO=;%PcSyt5@bqmzv$d zJAyL`BziTJD@)@!M_+r`11G6Dxh!hae^gw7X8iVxg{JdEt|4hE zZ;SPSrM99+B&e&No$5!D?*F}t)MWmhH?}vIT1q;bg$6?U8TDMN2D-vdU8Jz*>j8P{ z${P@^i;3srF5*`E{jdWrc8QVX3c0 zqHRlN^Dk(|^_v!5j$V7^v(l;A3^s)}77nOr_4SI;a?A~1^eeo*zD-ht%nZj96f7yM zp91N5e&na(KfCTfaA;l+b>21}SA2PVZHRHe7?@)Yucp0nk`K2ss*JBBJUbaGv+ZgS z27h7PiG6h9H9rBFm7erIERp|HHH6=h`gEG-sqx0B5nkJY;&VUU+Xn|!!-ro#K536) z5{bK$)E6aW5?B%}YTf%Vt(dVBB)xbNq3*yBdxa**BqvvPJJ1Kje5?7I5frv2VRP=@ z9f#)W{?4BCX8U0Gf{PGDVw(nX=ww?qm4R{;jmUF-2cER$vTNTgz2)26?hL`J`imTl zn~gV?CvCF~%5jcl~LSFmw+?GsTP`xN-)_HQMkk~C<9SO)Afm&dc z4-AoQos?W^6dwGLV_f@)0@fW)y)11W(^mi*3LCa2AOveuaF2gF;j#;fVI^`M6r@j2 zhzS|iN!>V2DpgQlh8y%4u%@4qB&NJ42tJ4YK?5odZV6CF|3Y-l-AQgJ5uFC6f%rh8 zOkr;Ln#3XC2wGIVe<2+JlqwqF=t3LL!&M1^Xw^JaC1^ zZKAWyc=%j7-liaT$cK66egNt*i}!`^9S5RLOas?iO?*R6Rqf8hI0`woCpWEy&AqSh z;M61}H9={iTn7_mA8ZflwallU&^XyD9C$*?WuhlH3`2A*_XR&w+J&jfPy7L?jxJC}7W*U$n zuvgQTx<6W|DRCmY!;jp2EfB!Xv6lUb*`@z`hF0zuE?(XhJ+-|3BXJk(SWVT-eM*3` zw8Plsr<*(p!2ri}?gR>f1xHgV7Mx6S_q5g4G>!DarPfz=(FdwFb@qi>ok-`Vn@}uC z7*VI+=c5szj#f;0bE(zNe9Hf{Vgy8-qWCQZtaR;1(42VM!z#x6J0?z>TzjL%JyJDY z*%kqcqZ4l4gzYUG)jKVHY28T#!uhKG%E9k#28xj^GDM&MF97NFzZ_dqr$)x<{YB!h z0i+NMItiD=VSs<2*dXJ%_FiH`@&?y6Yuo9r%(+)GQ-v)xVgQBvCPfwO+45Pl(?2bZ z+YIQExq}2N=2zm|8d`=e@lw9w%+JZrIqFZjf|d-&dfPn`yiybO(d_8jw8{rbqOIzX zC_Q|FfPa261&zDP`nN;GuSzgXTZNpK7^_#p?>3E#FVwYh-=X20u~XqbpWE;r=_Kp(p33VGVTOOc1Hd$ z^fA(NuWc^>>tKN229W%oVe^aX1L$!J1fTjeSxb360rl|4g2@;06e(9h&`Z zDhlnz2NQk&f|LIpjQcguKjBAK&UXHN|77-qfBY*!H+=VmXn)`z-SYzdL*?ACht?bl z@D>Pkc`45ly=O*Das`ujJG-wp0e(jhycHO#cSjW7qMH4ZWG)$0lNtI! z^78T|`}hAE_}>#PQ~yT|bQjpN?4FRlaK)7Y>ZJsW(gd1|Ag51RIT&OO{+^7#k&P?; zf1zCa=!rE=JJ;Wsy*|YI1G#cVcB||T>`ez30G&-(WST!o{k{VPZ(3j7j|ySm^@X)9 z`KSqma2<&JfnX-$6tOiKZ11w~Mm{^X63CnWUFx$7TaO-ye6cIhR3@#QfDn#i0ZVfQ zK}ySU!Dn0Yzke@dkgbe)(jo}zjjC&CxSc{$GV=YZ(gPm>kifluyWsl2f=s`^^ z)e@v0zMo8|yq-NaBtei~k6jwN66dhp@Oyyf<`Yr+E!!JZvO{FVcsothUguVB13YWv zB81}(ji`dEj*bo;_0Y!R1Aet%^Kp!2<2ulw2qY2^ckB)}^ity!xLOSG;LrdRlP3^f z#g9SzA3TsPjMb~0N?Vi6af}8nMS{) zT?v&pK$iG5h>Mp!n`|W`_ph-8lY22HU?G7yLSQ@xzU_Siy-cTH((aVQ8`%m8ZZu7G z`{jNM{NVFS2IVZRE@Th@5RLv-0($K~9<7t>_aNLRb&O|z4}np*2_dL)8fXMrImrJ$ zXP3nl=CLnQFaO?MP8!fk}W9zRaD#RXUZyL6=r}PEYk~+rH3}hOC4W_SNX6w zu_@diKcOG_>nS3p%L5O}*?xb>$Nv-NBeukNa}XA}PQ70Jdm;j7J-`U$yZ6qZ$&h!e z(pWMDtS&VzZBdTcgy?q-E>V&E>$oYEyR{w~IYSA`KS7fh*9F#p4*d?EzjvSg_c+$C zU*4Vf^j}Zsjy1>IV-DZ57q9eWXJj0j1yE#~v;md?l1+YjI6GOJKqP)Rf{5~l2K)({ zhyJH3Sunc^DMgb>F-9Q2g@okNV}PVd0KfL@@tythFC67R9@!mL6DBMY_8Pd1Zhpj* zqaZTwxXTjYe@Rq0#OxwN(z46M+=rjZ55Nil)p=+CM?iPy`9I5ye_G|cPNw!?;u9~tcQ}p(s%d9m{D)=!vGN}yzeq@M*g4yZ$wP&c6@{K# zJzrw6+4m5sxf!($b|-psCCu=WF5@4C%bNV=#6s4llbXMN8e$mL&ekpIVv_ML6*j0O zN%kRZ^WE4kYdGV9n{#?}`1ttE0Lu>`Fmss@4-nT+B?o{N8?>Ag5fM>bD`r^z@J$5{ z#2-iF8zKdbZ)OqOP?`Z?U@m7IALRaPN`MqRg>--VzcuR`EwJ>P2V90`KL9wn(n;KT zW`fUWV=_5tyCI$u(;`8s=h{4bmt_U#^J3}xs!4XmI2of=8bgHt;FpChd|V<5EuLI{ z*e4@7^n~4)p#?%AK6+`CzkjJ2eNNh8{AoLg@fA`DU5$toaZS8NyG@LrHGsi(sp4RFdpVk;*Qz zPKp#|EZMS5*0GO$jA4AA@2OLC?$7=C{QmzPkH@+1$9XXGUS6-~a$VQ+dO;~TT7vZJ zp+iEdp3O>)R`p50L_LfI;CYLAdA!)F22};(0uWdGc$-FCbpk{3nlU@}o}+kO;J&Mk zs5A#sv`ax1@Slxq#{CKT^~upG9Jy19Ee`qVt0LtT3a=bQnf%K3Kw)6 zv|X>-JvxU|o?u2c5wczXQH>$I;<)U8Eyb&2)%4)kZdQG=Tc>1BA1Alz&ghtHkuJw- z;pautp`^JaMf*yi%Ii7B4SDO|o}((CQvb*+Sv+;3Usw5&ncNVF3Y0qC3th<0(8%|m z2(Vub^JAOE#HWfM!??E3%P*O>#FFS=>MBM!S&lHMRhBHoJ*m{=6$>#iH08=hwC$hferS=Vnsdmgl!l&CyW?go(Dpj}dy{4~iF@0z zF{x(@WI*v?x)WM&E^ih&_*9ZVpNah{W&nijfn+u~C0j#&ldA-zBH6`bpzhgd@pIZh z?_*PEK)=qUPoB@QyiZZe0+jmc(5X|Ww#|E;D|Akk0g76l%b2^nfBs}}$2@H$kLXND zh47$z_Uy!gz}(aaW9ckl$@Q(^P!X*kKG8>Q3~AIuX1x6 zRn&BDkHacg!p}9NN0oTd6nC9^6>wgz3C6UJhPhHw>A|y)hZI8}KUVTxv-Uc`nk46$ zU5;EiX`1v%8=KbL-JQ}SM7)}PtaHc#@<5b=L)$v)_88Z9ZoryH1C1l5(xl$zQII}G zIaEO(&L$L)DW$$l1^|)ypaidG;kSbE3hlVzdapfq1(h0$?VKbB?DSvIk`of%!SPx+ z4{reQU3?z*eh!xw9iR_QQuHX%^p1^K)t8K(>8JFbv>enc|2~9~`5_1$3}GluumWpX zzMgf2M^)kE+}!WZWaF|hH?0e__!IrT@3gocK? zZfyc;x$n&mfh67N!Bh`Gf5S%*ZtrGAn03rtu%J@GP`}G?v`YueR70&$&x`t*(L(Y% zN1o=x8^p9pD*9RlXOjp`C!4YXP#i5N@OBo*#QR^O1S`5t@``2Po*BM8RSj|yvoIf^ zE2>v+UxHs@z--7t@zGypVO_G6J|GBF@ z&)O9d^a<~8tqmHe(br1E%jB+q&UI69glUnwXkTgK*>P6xQb@Mduw`@L2e41QoO4HggIFuT^mL*ZlbEE# z)EgvO(oa8+m-&>Ne0_Ytx$gznjrJ59z5KXf>(+X5*4ZQ*v7w?IU(}PL?Sp6J(gzl_ zojbnW8n~2;JG(_Bd+mbYn8%>2-o8|g{aBQ9a#m#*)1&vNE!-1=t(+2u9O@iHTT6^v z)C~pZTMe1tO2jI=U4MtZsj4(`AXruH%f1Gc2ZKcpUgQ?uow8eRc-cK6;y~CI38I!{ zn7y_?z$-djDbP3fyueS5$BZd~dn$o5%RE!ujskBUOp%zg-ll?}e@rmYDPGIUHym)<* zHb_iX;r#?~cek?PHf7PqVeL7FyeVnW9@R>;A8jKHCM`#=t|!6v!T&v z)VEfRtW$FOZY7p4wRLP{Z?n5;;#f(Py!~71!hC*pQmwH3uDNOFFv{q_-ag^Q>XH7~ ziMPcl7SN)8j+7&K;Px3Fs8QTGZmW3_I>YC_vZqN;J?hhBFK9*&#pIdFk%VNsib|sM zF;zO3Idpn2;L|wkKJ65J?&$#*QS}s!N1NuOE0QKpJ+C)Rw|eST(>8AY;qJJJ&ur)I zXs4mZ)u&c{1lJ~-tlBP#2jWGS^h)EtAE~i;+@6xYV>OqPYwIJv;rrv8UXzLGf?~{@ zI&Jl|;;){5?m>uIBUXEor;q;0Fa-Vly8n|?@6>t&lB%UlY8JVh>zz?LHX)ygYCeX( z1hvJs?&eJMCH2qxk^dsH1!O=@JB}K+ASifFFWSoatYf5Zv|_o!C+3|_F?zDkO6!^m zJht4>@NDbSVmu~xVbwMdT*I9WIl+ofU!q8W+CoKC*`n}dpGSaq?rj$9j6J|67m0hnwG`F-hb*UaEsUO%|yt6-A2fuVXaRhlqp6 zf~oED?y^_*cpMDcu)FPQY|!zWf?^r9ud|P~wLX_oh$ifDI!RLs)*)rTTY(Ynma}aO zmx9q>9!I0=3HD?wR@Q7A!zO}396f$SS%GE_+i;o zm>kG-bIi<%*5(1QahQA|4^cndS6 zyf{C3SgB^1MuDWKptRkC?k+Re`dQ0P^UBMfqO)3}P1!9^HlN(43MMd)r}C~g?WxJ$ zwW=9!`lMt#(>j4MlX`Jmnd?NW7Sqlx;y2=VvZtsPVl^vT>*d3Duz#k7_j~OZ?6{-q3vE$d>lV+8v2k6Rpx_u-^^a!bzmSCtlo)%XI!8lvQHK;ukF-8N z_*Q@WOU2INV2($gxlP$5k-Vx%t^3??cDfUtu-I!*O<6ISq-QnFjYVxlv1|iJw05RD zn&e#DcEyYP*nL9Ys-=7G*S9Ea!R=_VOOlkDeBRniG7vnP=8Hn;QPa~*79n!h%^9$! zygImL+TSaYi@FnHdCwf*o?5d{x^>U4qn?Ygg>pCqI>1pQjwi zqHSlzV1-oNUDIRPX01D^2~e_sW)=B*n|tZ__?*V9*U|w8Y@B z=!=I=>{oTiGFlsy+np<}CR7ul6xNul!VNy-H6blNj!+xJ5T_yuAd>tegQr-x(Q~RM8z-sGlGUJq}9v4hH!zggP8gme>`{-oIHKH zaLdY_TwmjLx7TB&FTB0+RzK{D8+0n_cBcieCmlSz_5FhBo91V+4{f&dIV2{(Cq3F# zRJ|B&u)Sh8aeQ3N&JE_VrG~1#=04R_NR3#e8d+$zHX>pRqKkv@^GSsk$CaC=P5aTM zKwom!$6L(g0fG|V)NscH{u{^{du>dkBWAL|a;(BnWSFtE?xp3W`zC4B4k3~&&HC+1 zk2RV}2`47=*|`GlZI*LSA3CEKCEvN*;1Ej2*q08N%D`RK!uh71EwVgx7&GS-?F!4Y ztbJGbVPbE@0g|(ji-AH<@aax}+sdGquSy0o zcul>jmrH$7dTI+fd6J8=!ZYGCkYsq3L31_ad^?pzcff&gau+jWg=Vf&S6}g$PrgUI z!$hnW^x^HtYoVoVCkWNwFGSe?bEtZ0o3P%!+UPYLLQ!K2IYcF6pTZ;9;IkN%e;Sve z@0g41=96nhK9lb#%dEXOW8w0EGSrm*of5ONHGJeHH^?R(?~M>2ilbQkR?1vC3*zwh zlxKDN%u-5~q!ZhLI%t4jq(#Evr+dwmA5?%vt7 zxEo&9igpgf*7U8dcsIK*7Rl6s^nXv12#SK9Q>N{ z)`~+mqMq1kahqda(2-t89Q=N`=cVu8wF!q-`>0hL;ZKK^eA}JI?ekfU9zEG>u{p|L zQ0dJg{Y^Pe-G=VO>8WEu((-<#;d(UYNZda{$g9E=Xh9BkuXEd&cL=i}yN|AmFN2@|WrCDLq)tclDIQzM~ro)h2t-I@eBZ z*lCmQp(kkHB4JJp*S~j>YuPPEqwwoamA;F8I2@-ZZX7og2)yg}!xE z`X%eZW`b(rJAV}w_2wN`Iq89cfjPu_&ji9X<46DuH0SKn@aKZ5XDKCaI2bQ^^bqfp z@^kQ#fzcK%pR?0y`K2Q`nbqv~15|`^Po%cgRufNzS7!7upsvuxE`1gL_#)w-=}jaX zx&0Aa3+#YfT{0A{jl^NrTlAUdekGbDwb}2!CKVYwH`;r#RzQl4I+c1Zzg{%_h`f9H zaEfGsjrfTHT}SH46jAfqY(<-LEsLkhHb)uK4%E@YxbT5tx&H?HmC zgqa=2ieWs^H7(09?|=KU{a}LQ<=v;AD+$(t&`QMN*pdYoQvcuNo2;D7*^4kR!(iiY zB-~n3R9^q~#~1%+^}}y!CG5+8ZED~lEa73o%9kU+f3mU-17`4S}@Te=uYqmi_fK%9=>O)%yh)zuMTwSi9zK%{C5J9D z7YHqZQhL!upo~Se013c~YeTV$PL)rT-Lk4ku|7h1^Dvy!F#)Z{e*0MXeTQ4@8@rV0 zv)#4>-XlX(1NFLx4*3JY;b;LZFv~$?pvDO|eP?@&z19G^CA(t5>`+XNGne62aY;#+ zH82W!%ElG=zbJs?->$V5D^!K5(&6A==_PY7Jc`t5!fM{0->C?n`UIv?stU;^L#tU# zTsv2joqW>_Yg9>uSaLKDQz0~S^bO?ZLR!6t0z$fiMViWD-1JMB)iZx0e=WgdWXdC* zhOvb{rEOB#p^qKEi}BolviN-0mkY7h{3!;9DHQnvJ=+rMmGtaZg0V|GFUb=$#2pjR z>6h;|&AxIkPg#6@+zm`k$=7RMtu}f2YAzt$l!~(l9)+m@gy~b>r+ELu(|{XNOR?7zu!;M(^O@|VEGW>IyQmXKT7MrGFwr9hL!>4qm> z5CyJ)-v2xHY|;qQZ@5iinPRuX~pmzcQvsaIz@ow#1g5b;L!nV~;(mZjvijB8?WZ&ew~9w%Zaw`|ZB#@Dthxr|OJhBO?0b$?;d zm0%e1Hl{HyAwi_tVBZb6<3~MBLl}eI0Wi%1SC(tt(p8+swK#YQW^9^_KToZknPP?k zp}Q?<8}Fqrf<&;R1>Uq6jAjUb_HIl!6@C+(GHc&t?6Q@eYj&45vkvJ(+6ufJ;|hQ5 zPT%DP!t>b_Az7Q{E*#g8!PK&2Z0M6Bc!YEdn73ZTvP~~$xY$IH|Y-Fa|n5&LZh zOX&THxHayBJpj3Uj#7{roqr$=a}MDnFnF}rR?w+`m*)jN;p2cbKpR)Q@O zrm9(4z^m0PfOe6J>5JJe7HZc+2TI7)Rc}Ui*}nPyj?d_fdYFWm-=)_FtS_C-SkLBn z0Dbp{@5as2&gOlXHJ`uct`Pow(e~RF+65_JuN!OZG+WtbWAamy=HMySey0u6p z`0NQoCZt*b`)@tbB)XW0Q?1lh8p-+gy%gB*aNJX=Zx}3eYkWggDk=7Atc=s(*KY?7 zC}v~A}xx8`BQ8G8WWXmMK#B%G`?P#%)>9F zy0)|Jc@x(=Ss5QB-pp|t?7-xR5{=v!Zx@jKgmJO%gAfOi^@L(Uer{zydHCq}wY@Mc zuCXS`!LbnBU^u@GnG=JjcI+;HP1;|=^+ILlz=97^nqi>IXtP+rUvH%=1RhEX%h?*? zcdW2|(|IclgJqU@S`p(zr>f#?nls`F%qx1~5)&(gJgiHU>F4>>wR0j9;*R+3s8f|6 zdX;@nRkATQcL;*IYWSc)571%RC=C_G6WDJITsk1grCpV?6VZnla zzR?|{(0qI?7mAbTxvia>QhipILCl6N0ku3LXO5d}pzYGsu*{1^Rz+Cr0suoZ9&|qz z?sKa6%DL$wnzbEOzAS*Hq1z2|L5@n;@0F8-*{>2m`_F!(pBd{`&rTu2*$>X<8i-92 z3zvYV2B$~e)5EV<4~nZ3p~9f9r#snBImfDcxvNRKmp{H;yEs*^cQtwa8yMsbQultf z>sB`|QY&RluwLM6s+=ZAfd1;boR!j>Fn5{9Kn}8D$olmc>AjfO88PxOs61KARY|}l zxLcn-clr^O2a@MurnX{1Aoh`XqgHdgQNJCyaIO*frf<9mbx$NYwxF8|Qn9bL#41U= zk#f57gnCzp2YI*2dlHiJK?wz;<=eUc2_OXF_w)x_k8YxY!`t8-g-n!$9m?fTA*j+M zJRsdnnjmH)c4zOVbCu74C&YH)EVXL?n`s`fL#X+otfMJ$Dpwm{<(fo!^x7ONA02$Y zGBsD>-8!}n5+7BehW%zT+u-B{q6{kSu9UjpMn#20o#7@ZP0?yGocpzD{K(q>xkuv% zSjvBdHQ1>Yfx`anN#3wZ6FEYge7?VhhLT;$u4r77Q_L0O22+o2lze7**V_`tHphUo z5eCa?<2%9rkKFH%yAM!W6_GQ`Mu%<#KWPi%?0gQSO;P~060bpj!(d)?OIDWPAw+(;fy5m znao_s&y-{Rk{FCjQVU`G@^=8*pDkhy3seS@+Ba5kuLy;<^s?Ig*!vqr;WHONd*arQ z*13j!2zcKhKmF9C?L5C%hz)+g|BCCKETXJ-28?0;?28x)Y3Z}@Xt%o_|D>p3{lSN5 z%+xlHpS}9e75Dq|$k*`o{#RN!UZjG>1F%|d0dT@B`SMXotK*fk<$}vR_|zGrV}u_?Ay(9x-N%h8Kp10xrPB z6mkoUPiI_^yZWz{JD=H;%=TrQcOe=xQ5S#$DH|_*vVAtg@8w_5z9K@HFG6SG6b75M zSrj=BM-O?F44j9t+TsR2mHpmY3HVE&9(?dN4v8xOUkC~t7=r$^FhO==j&t$NDZk$j zw0IaIdrqe5TCTGGRlU=~^7io2Hx~lfxLz6M?~RnP(5;^6tqSVhEN3ebCTUXirtuyL zIu;cR2obkOXaZK1t%&?;#%;L8BKFH;H5gjFT~4LEUBz+fw6T++a9YXSpf&WpDtW2b zI!@;8JCkvt^x~wKy;!sdJQ?HxeM5h{;IZ=A=H0(`ORU-n?@jmP4)0=um%RSzw6L=4 zamGclb1Ba>o44p|2|khmErJ|MICQm@E>?B|AK&LW&BsQCyg+rztx_ ze&oZgZJNuoZh0U~fZef{<{=1e^0;^9JlM;qxUBmES<(4?Isn@r(#Jvk+e_QeI#WEW zuyMozT*(>hHYBbhGUoWNEA)9aD=mVlhg{P642_xh0{RhJ8Rs8yYVkcZYbRfs!`^#8 zX980EaIl?_Bt1B~XJ7zb3fPFT_0^Eza#-|WFjE!H|B3M`e|*jN47)zZ-e1c-v6rJq zT?UK#bo3(j%r-bzWY3R6LJ@=AOHiR0=`pdq5bzkzWGpjebJr|;xBc+f*_%YPJF!U^ zEEpKEF~SHVlw1h;4jH8?&q-{RX(Fdszz)tXuhHgA2CMn=j$M}Ban3>#Uqt8DO7D6! zhUf5VM&Y$)gV>oO*K0F95B2(xT{W{0$qK{wwS+$HDVgmWZgU`f0k9%w82WL`v)_Z8 z&VdU^6@@#t1qxV2pAH%sPlUnUq6*iMvaHKh?ginS%llTdZRnv*!PInBwE`(>7#3G` zhZ`x{o8SciLXi1BD4xv(5jA3_a=4Ob!yM(Af`WJM(W$9BU6T;wRty zZBgy@L(Jret7!wXZOpgI6{afG=+eYAnQD1a+IwMo2tKd5&vp$<*K{R~?1HBmk4AY; zeDVroy4I$YDg)MG1UqV!e95@`xSJK_+&J|f2^pzkZ?FLR+7>g-IjL;FGP9!8T3K1`)TDPvScI%V~`+B{fc zo6kH{nxBOrE1i>Dxi)d5*enPv6-)5))$OcY8gCK?ypfA81F)!0dZ zRyGjspc#4yMjUT^v@|o2d4ET8wEII%B#>iKw|DhoeWp~?cZsi))n4yEmopD-_2+}D z4CUN!CX=G<-?6kn*&oAqV7qSA83{bNUD4#B&%Oe;7d@1l(gtTH0XSGm6M(G%f#tld z!9z3KW9=u_t}UY%gZwTFWGPCf`#}MvidZ>?GW~@WM{jremSa^u5$Aqv5Q_q}ty!lQ zfhNCgV4o=a-Utj<{8h43nF7D4tVVxl*m>I>fm5X*Hm`dGHM?o=!sB4m;l+sww7OI~ zs9^eq2fWIzrF!T_aSSMMru8@GgF!gJ>lm!)n`Qa#lbuWa*=bQ(DMt5|ARnPA#{Vfl z4_Ww{f#C(Bw<0;Z$b&_br2qhKW@16c{8ftyLw(nMy6?#al8mmE^LoW_w}u41!?+#s z0~sc7c`MS05r;nHCYf0rdsLH3QK-XUom+WCmC7atnK>>e{1ufu4jtoj!PL0++=`Id zPeia!=(f=Xo9^Ix*fQVJ0~VX`bSJQv;M|kHNT+2B`^;w&%>jlT5CA+ zKCvx2bsXLv9jdlH@QG77ZNhO?gHS{7#n$fZmKW=dV<^Sv@4^uS8KD&8eaC7;ZBZ;8 zpwC#5?jnXoMF(*5Ma&eCd(oxbddm7mxIvee?XjLGl=s_pC=)OL%m(LN)KN??l1_%o6pXH&qCf*-SZXtuEAraaAwrWkXvqg z=}yqewoqqnYo zJ@xOY2w)q?=PcQQpIIx{c3inJh$Qv18b_D%|J`@#cSJ89JS{2PO4WhPp%H@iXG!1( z=Rxfo)ezA2FSLVWOw~%O==wnM;oMCHYK;$9vH{&M83nV>0+|&(!AhgzGY4OqOSM6Z z`hXo=KX}I?_g?EN^Ddq?Akdv1=cZNpuT`7 z4#xTzwTQ3nvWGlV#TOAh59`bx*gr!*=9%FZQRK2#pjfIEhhBA&VOJJ5o`n;t#-sXo zs6vp<)kq&7yee@fBhK|6DCeglC%!{8S2M$XYB+6bJbe3hgm_5rJT#pNY9GE)@Km5p4dREhswTdF0_@?51H^e=+#(Pbi5tWMIJsYt6N`M_ zrK@hJKbP|@7O~PTkw}`?t};`b6M{isM!s9quq@+^{>QTFDxAax*`c=z$x3D|&fh|^rvQpSEK2R5YChnaGyRukqKJZTrUYdG&(7XAD*gUZJ}z> z)wKL1{Vi(Mk7K>(Qi$Do?at@*P%P)}SJNO>xOm!9vp3Ysm1Tjzo_9;2t^oqeF|uj> z!#lqK3fx(>J+hH=saVuyIZZLpnZ=@^Z9|v-<%@!re0SjEl;^@_%&1h>YH4igg(gA& z+MM7+K^u5|n(kew*`08jf-G^VsG&^~FdO8aDG5zX1E%-`(h(MYfTXTuhQT&>({jD#e5Rif zyEW|1D6O9x5{pu4Tl$F2%W)UKM9%&0D3PK>$`6gnux`mRbK^O09zK)Bm&p9I0uSX? zt|&*2yM*Stlxj}lLv^!7>zZg@urFz^$lyRTl5aloo^Sp8-sFYPu>RGwb| zkX8!r03+X~0!*$xZn0ShhJ8A(9z&))`JOd9wFef4eZAS0{Ipf?xC+jRFWj z6aa0eqoZ%SgS*J`AKtqO!MO(cgc4|oIJ_)?<@!;hz5k;f#e?14hvoe!lyg`(PzMVh zZF#Q4a1eU`__IfCJRLb{jmMYqQ zeB{xqg>eG}&c^QhRv$nSsM3~vgZ*$OO78B!iSbS2=cM;(PF;d9PR>Svf2Y5F(ba`K z%2YrUXm_7N_?Chqw=2JPQVqL4GZpjluZqi$jZet~QB(!vGV-r5Sb1Bk*llLS{cBYj z(; zu)J$#ao6PdZueX^uClR#UXnLdTv*iNCtwffhG{32gF8p65_xkx?oATZ@WcR)JDsdt zD1du4MiiBFgva3CFGF_s%DqsE4JNz{HoKpzH1ZfqPuHR%y{epuh_3Ri*$I7UP3UU;pW_RXM5uY!$g-^*g9XGnduY9r^glFFL=K! z^@o}x%>t)`Qb5Wl@6x;IKq9E(M$d@h?yuFA@AUIduLWEaSRM|mR#W$ZXVzV1cf1*1ad*wX;_vWb5>CFl%eij2${m#Tk;7ooQwd`rp}21$wFoTdPVu6 zHvi^UcgRfk)^+5drn~4;BrJT)6cXr~y(srRhs0k@>`BkdryYHIi_--q%Si!Ca zEa$LH)<>A>8AiNP8Ff?Y(z;2j)y_SBqe;RrG}>kJWX4B$nYsJ%M&3WYHMb3-%<^@!CJ#x8yB*OU~--k$rfY&&-lb>`b1maWGu(3eDJwkbzPt zaVFdbM>faF1rRRX|+Gt?hyb*RKZO(>rhB6kmiB9lAVD5p9it3t+W^JPdefKU46s1Wfs-$^l8q9(9zo zNGVuOA@vvI_ZgY4@=MgKUkxb!^unP36(#)P5Hw5*K9wp37sKVhzVsH%%Oy=MohRS} z-<^H^w;?bI*%mnDfigZFxvZsKjE@9$Kt1~oagTOLk*o-EYAo`}ZNm(Sz`v1< z26)4exZw{0h@SvARA)ayl^?&n_t#UI&+L~xoAor)ln>4p0+s3loMsC$SEkUP~)ps|_1ok3Rp_!f&J)b&A%oC9Rd0HKzY^1mi1M#;e-?wRm2o{T{j$sK!Z3zIg?>EW=CwQ95+6akA%b=ls3oTw3j%;?I&e7$2$O z#|(OZq^5`S5V|CNs7DcW#wbq3x02S+V~N^4_ad;9%LtULr=nc7qRv;u6V6!v58>u*30K6*Nek{D^`eKyx zH>-QW7J{jbZl9$qdT>P7?t3jj-JToLjEe^|1y1!lHdfO@-EBLWR^GZ^!bDJ>JeDfl z=|A-iK$SMA0LzCE%KkOsPKJ&V? z+JB{-b`o*7e$3XQwm9$5sd+8i$nl=ZguW}HM49tjh1ewquO{U{xrkTui3Xud!v-o7 zO;t-&JHwMY5!U+kX?Wq^4KKXoZ^8hjig4-2_7(0VvXWHYQ?P``T%C6!o0!;;^GHOT+cWI0*1J^||fIN0-Qo%o7nDD={ z9d7^$OZ@G#pJXS{ogQ8D!7)vkdE;mo)qu{X^Q&1B#vUvjnB$w;!M80I>)76%626H*L&!I+U9M2y6-*#cqQ*876crC7af`Xv6aNLL;NoeK zwhoH6rI{5%t>k8n8$Ibh3q#MDSQ6gEG;$Mg7cfpa*zmzPTMcY!6gfHS`jHX|*705| zxh|tUw>b)U#h6coi<;m^$EUn?Ri?kD#UL0q<6hO5-D}f=V|+`Q9iN!C$)@{=Ck(P= zZJl3l;T5S;i7~+ShAXM=4#HlSK>SxXt=Ikz*yR82;PA{dE#ANndjlYH5VnF^>(7V)YEp%1v% zzC#3Njz z4^&ex2~DcD_uZNMF&-cUqnx!k)*T`=RPF#w;!jli_A*rZ)$GwQ39I2Iu$dns;(hSw zn=1>UlV*L{EA+)F{wBAse7tGqzUgq?;+L)Z3vJIrN-qR8+*Sg9O)Ha(G*NIi5Clex zGjNdl4Pq!vnQySo&k#1az)qne!@=^;RU>TRV+40XJMxW>J!GF~-{1-0nV|~`}ZqPtarD4Cel*?$Fs>)0A z(3^nu^sH_{_eJU99+OfykcQpU4aF*On{EV+etAhNupIE1%}(CwWalcH`F54+P<1R^ zY70eIp*PeUw;MPb=bbla7x+gfiCC^6$Is7$ z;9kUZ20}0|0;zn4waf^^zJr{y&5<{L)tdhU9Rs2cKk#OC8{ee1FlB&mDjCUbJ-3F% zEPU>aQ2FVKc%)a5m@z(vm)eBEZni7B2G7_@gFH8umfshV%hPGxhqXr4HIj=DKj z=+M74rA2;=ZsIp=5Bd*6I*rZ*q-O&J% z%y^8xDWcB}mDAmz<7JxOgw!|Vn}{Gh3Rulz=27pC90+icg)5YR?{83RBhe7x@>Tk9 zm|fU9IEza=(L-bG3i#6aBMt=|LvFxGNL~Rb#-sE=wdk+P;r;U`^}ls0xG;pjg`ovW ze-<-1U_q{xUZ{;$k~GOJiR<~rdkFN`B1Hboj;;&Z@<>5M%5IQ<68}5LuF!x~e{ZaKeN=548dY z2H${eG0^6&7ccQ)?@BkG(8TbL(KRL$+jSyBZ!0Cp(d?O6Di2XyQxzQgdQ@8QfR9)M z*=WqhRRsUHoE8)_*DK;uL?o=m8YvI{KX=vc5pVup#vAe-`uM@8De4??J!N2 zla?#+fYFUGdZ>bqrK{#Yl*c#r!27nHyMA9fFfoNW+Pw~RD`g~k*0;S)0V9VGHFoZt zz&%2j0w4kz^|h-}heal?wfF-NHN*-@86!}~fOPk{vBfc$+Ug*Oo$6bm0JF@A0fkIH zVMr^pSiqhI(n!D#`AU+@tC#bOt5~=+n8i9sV0^WiTo0^87Qx*X4hy-c#$-O_KcT2L z*Dp$p{3rN**S1<#&5lJHS#C?;Q&uCUjW~k}AO-3a2babQx!p=gX?_{1MMwO_9$*Q^ zRlV7bO-FVJVs88cR%{kyPPpy<8IF2zjFG=)mJ77;#V3^FqL?3$h~6=)_2t8Zs=CEv zPzttRbG*Udf@bY*XzJ$?3lLd2o~xpX3NSxoLON>^-7xKi$jGNRuMp*(Gr#1E7}<|_ z;_mb6Dvy_W4?*Q}I`I2vnE$xdYZNfBqjJc&#FLs4>(T45tvYW45qTi52Wp19OQSpf z^t>)##AUVTxqwWADN)asm7>64#?dq~-CMFQyGc%f=>*5%KC`kA`BMl~|9(|!Uy<4a zh|qQu3Dkr`L0O0{I{e7W#d4&QH}i0OosTu?$=2YI$Q8Vu2ggVN1iIlYxR<~FQk1$}87iVZ2C|-J#HtSYP^}{Y2bLWALyF*d1x%J&V9+;OCrVx#Qp4k4c#8c0FJ|~5W-wl&lz2V#f6Q(0 zCVt>jajy%vBrg@ruzBCruE_z~-xV+eA7MpDZO|qx{SK$>|0T>bU>8QMFl4q&L-KD$ z&rcUWMkl;%NnZX_w)0cCgM{p*aH)4X?LPo%jJrct+Oo2>V&Ok+x8F}<8EkTcII5mK zsAY-3n#`OUH_#yN`_W5d-v`6M+ZEUqpUwjKn&}BLhw=%ad|bSu5y%1|7_0#fQz`bT zq;*1FI6T=5{8FT(4`gWfD;`MNHS<7R*S>WZnUx1}w#LBtMo)!8u#5GTl&Zxq`WLnxJARrPZg+{}phkz;yGCL0ubV?N`2-tABd2v>;MYPkYOdSwo z?h1p@oLD{qt+Rbut_5g4%H0t-Bbb1Pl5CPB1SRG@6Sbt+J8w_dT#XN9J{09xcX(Bj zXPf3j=9^EYj31Ja?(rV68@rk<_|3agOV6fX>;&i9|K135UjEq#2cAb>q6$BQ@DFT4 zY}!2r+o)Bh^b^*t2cV&qb2p=PyFRlC>~0=_>U!F+n<9U;Q36R6zta2dE4rtCt5RQj zPpfA~69LT7MX><#>|Th(DREmC`1jpoAs0H|`7>YyJv*sJUzGkCq${M|uZ|=xjJmwW zRoD^EaBzX8SjtTCR#m7AmwwX+_ob_yl4V*_Gu-0>MO!wsts)v376c*W*UNXqzp$q~vAi_~+VnA7-QXGAdg{#e}$vAK|f*K-Q=)3)Lbch1#Gj2SbBJKvtK$x}o zaq$g2d1f6`P_*q$9%viT54lT9e&-D8L)sj{hwk7EyyInnoeuAZHpm*vI2%(3L;*R} z0aHyaaH_=h;v37l5LAO~Bb7w|)lDX7NCy&8&)pkB@o+ErkN{*4s1gWM#4yHHS! zzfzi|tFQ-Z7y?DdbKRad-?5%bCGaKR78L9{ilPb#U101#QPFiK?;H^nwb=j)Z3l}1 z5H5NTchCDk*>}~{012{4`yjA?srpxK!~B~X>p{qMq3z;nzoct%hpz1k9CISr9YS%` zO(N4?-XP;JYWxyUrx6!bO;5L91sU`07U9 z*(esU^4d$c5j|+ehoKVgCu!6=La*>z_n1M=4(;O|xI4|JskzdupHp))kNB;7L5G?= zlB3v^GT$8LT;BaX+&uVGtOsn9nU?g+B5`%8=+XnY!#o}Jswx9dAI|Zo5kPab~%?cs#M< zssVnF_HknXzG-lXX*2FQ8k3JcwMXhPTYp2>shzXYUNbF%rfRJD15PJy;*H9VmVf5g zM+a7?Xm3`gv^gx8NCtLamUE9+o2ohJ#oD6p`f9^zro!sps>gY49L4-%0p=(8pzxPA z_i4!IP@A`pU2uRHLt0IkxT<+kv4pRx0|w55DiXmj-)H1?(+nGP4(Nk0s==lqtZgG$ zlr$D2k5M?ezGC}sJx};cueRnH@$cJ7p$5925Jq*la##9rcJX*?9Z+I`xojY)f&KcV z&^+h&Wf?7Qw1+d@&>zn`5o#_w312s>Yxs>r}&`kj8fnA_AAqxdBZ_ zJ3xp&$37r@uS>BtM(OLdI5L13j}OCgm9fR^*ozF&JnDnbNE3_>)(L^APRLpxk~$>!Zyw$ z+M=9g*HVOnrsgu!kuD?Skh=tZ?FqTwQiyzYkCr|)n+z3zmNxtf`vl<~YWK8jo<0H< zj0khx9EXrH9Q*XvTVoB&n)gsh2dbZQTQ}4HOu+y9bj!E)|N#C~EmKZ=vcy=wX!2Czs|I9Iu-Ds{Q{acKH7SVZu>;?V~E`a1^Yu z#4Zj|A(dS7v+OkE(`7G*@;Be~<5^?5uK;sbe*OE~L>Ponu=+S1E~BcF?8y$h&6cyc zDlyqTp()rZKm2@0daqX`>v#Q7-42)!KI`g4yx%*fB?3%BpW7COp{44day#g>v!A!?PEf+@6N8*6AER)C!iJxoaTXj5&1z{dO(9FdvE`hqim(_`VtM=GXI(}y3 zBN5J4F41Sqyzpj_l)iM65?9d=?2!c+lV^|RCb0lF9KtS+nU)##rMR9NRf*O_pMfC= zD5BDN59Nk0dOSZ=B;Jg@v*x9Fv$*uQ}26?iyjRv~`F->b84ybhB zroDc3M}fY~i^~ZV`B3IHYrNN6Dc!DlHjyt^R3)+k09tg1l zcB~a?4owOZ=O*6l{m%0bKi={`!37E84B3{?1hj2D{@F-;hwKh_A|*vVk?*L#)H=R_Ine$}y6Es_W@)k@hQnkq|GZGL_AbS~7#^EA=wmYy<& zy&)-Z&3rod=GuZ?U*9;%XMsUi-uXk<+pxIqF1fy=%sy z1^)fYyFord4QJ(2hKy4_Kf@WoZ@J#=O+LtQ0!1bdu*M--CX+Z=A__Dj_2OEt&}4$8 z;jAS0A*%DCdBAznT#FH@E(jK3_1pnifbXIoGj|clLd!j93uGVS_`a(08N`UG8H<7- zc8&d;&e^&^0G>CPSi4M*L%rj2oX7;)NB7QDP%+rSHefW^6U#c6r9gpr;7_TlrSWkc zm6-arp@#hS#fisw$7j!lV>@%^;gt=`UvigR%~DzX$QLd=KRLJ;#Arb_LHNkgR^X)4 z$3PKK;!RK)$*I2uWn%f*)Ewkry$Vu={nP*z!4U8j2D8r^-1a_T1gnBtkv>9ftfU8Y zFoBnS=IUd=m0Y1V=dv0)ifT)Rnx9yQGIDA#+}$*eY!B)pB5WEHk<#}b2IHFnnZWl4 zf^CY(J>@({ya5A1USTQc@)!7DLbY2*&p+mnz?5%!;+$ZyzjKn8S(@d6K-*FB}|1-JFE*jDKB z@`~?A#>jzM65%9Yt(9Qkr!Do>{5paL67r$Kr3oOO){4T$af&;Spx7QbK!HUf?+dFS zWhuWn&`v3RblT(z(-RRR&cqGRCRN_CSVi2DHyM!r5lXP4JO5|lD$ib+k_=e+3}Jxh z_QK>+Li2uT>&&Py1QpopO4AKfSm)8_xY(o zn|*gZc<4ic4TwHA3xtDCPSNe_xHQlSd^jsVi5H?eVrE1bKiWrrVltiJ;+(%eGO!eU zTfN5@!N=f8Rf0Qr7wwI0WFpB0bx2on;HmfO8JN%<1FEelMvXH7`~wdr?off*{yxk| zx41G0ec1cLqkw}e?}k%nUU_{1_L-M(M`$6naRHdfUIWdt+*6d(?Uet=-j~Kh*|z_; zC{(glgiy3ADH&y%L?|JZJruX4h!*=Yb4LqVTNN>itVNQ2nG~ihO_F_?B4i!=V7C8p zjqV!H-E%+pi~q}?7rp3n&2^pEb)M&O9?SRpJ?y+?RB?;jWf5m3EP3f-0Xb{UtI_=j z506?HwBwL|V6EhU2X-4YuOyorKN=rZrK$ck>52bTPz_vk51DcAJJY@uAG;B>xwsgD zm$#gL<#Ju`>fR?eW*jq$?-xU)I@9~O{l!#w$H><*EaAbRMR1383M?wv=! zdG<4^6}-GR>1Ul2US!U4&BI36yw?Y24-Jrp-=0E6ZnzzRXne6lpjC6lqPBwGx^!;R*|}wHWY@>0Qvv4&R!N%x3q^dx zt_}YcUA1C*2;3jc)ul^WX(@qT;@~D(h9jz|Ch=Dh=z)B{5XI)~ zx|dFs*nziKP-_ZC5!Nbeefe_~&x0-%{|?D595c!6otdIop=^Da=MSmwRukWpH?e_z z9H%GPD+pMb>5Gq>KLd+)OCezDK<^!Sb?;6;ao@?O)+hZ{3f=Q(*v1gw$nNmjlv}<0 znF7tUpGpfSs_yXTpmtac&U?pD_8jzYD}kpqW+)OR z+W|G4N1bvaVq?RdUn6E`&Mj5bN3r4i7!FijS^2j*cj*xFK~)<$+d`Ic;&8@SxmUKk zS}>TLOe)QZoXYIB6GO&7_oXL{*uONz|2Nw-q<qu%yKOG>ZIWaO|Uu2mp_)d8nxH}9FDr>x;U@`N@pgC_0xBq)GoWGllW=;_KO6!@%Q<(F2RZn2uTZr}$0j^rx5dJ3QWic5e-MKKFADL?DekPsWF zSoiDWy5|1VNz2kwxFV?roCik9Xm3Raw5-p9M0)BM!123wtwipF>@W`Qf_Xcscra2{ zUTFq$8(*K9Wv6oSgH#5>jXUj{q%h6AKWA5eED@J^IN%KGZ?LGESPlO}Ogd=7K5rHA zK{7Qs$x@IB{>J_$D~jjUEBt@Mp*{VX)EjG2_!8UZ*NO!i@uZcAPa&gD2{QY^de5MjFAFZo%Jh+yNF*;pc z!LY~qHQ3AhLs$8Nvuw*z-G%*Z%Iy3N88-q(Y41MtYQq6OG4C(KgJe;Z!W1N`O|NnR zA1DvWS39@-+G3?2TmKcEHX?3wM=zF^!F)(3L~egs%=Gb_qL7wiKIj6gf=i$X3X;xE zzizAM!EWDw%YOx3haSH$QPfW4`(*)?#ty`^FTG`36q-r@R2h>jy)~=Ka#0Xd+46$D zjK%oB6MlZJ?*G>b&jNL`_UydRZ8G|MMi{aa=4|=AlR)Qh8Xs_~p$b`7Ba=CQ?ach< zO#Xp%pS$?zPwWv^X7+CYFCSttkvVNG;w8YmRC#>ISD^rCXb_yd}D1-FwD_yfoz8Pht|aZJdgcjeR0gZ-mneI zFUVNmyL7*<3MV3L$bTBi-{~vh7>G(ga6c=)AuxrfjomMhtE=v-{ONORRY|v-u+{5kyv*|;WLMrYOazD)|aIkvT!&*RA!kh)2 zFF(OfGX5zS0St`Njts^S*movnFN%cx_=lH?V)yRwku-OqC`0tY#dENVMI2D`1Fk(n za}U|ViF;@c$5dCA{=6^R!SgSV+(8kO{)p7CVU+kq zi(dFO?Yk8IhdVw-RUTgZ92D?XW(b2{r1s1+R~_?M4z&|d6fouCPq?545g=4- zkqo=$BNZk0KW^Be8N^+s%+gRrWCTC9$L?HGH*I z9zUBKQ#{|>W6L(52GQz$$owFWo5Po~dpzQl-?2GZ*RtHfc>`OFDO_HYD)IOVOZ|m! zp+B&bKzeaL@2TJU4bQ)!XZ-#dWH&s(TJ9lYIH1V`>LZ}H(w2YXFS9qt^=hkr|H~%( z)Mr>a939W4FJA+c;nfPeWz)y$%ed zz0er${JLf*a`oRok0a)kgTf>L=qsHe-ghCXvO-Ii>HTprn=n-He+ok(G+x#ykTvnK zWpe2!HmxDb%ij}Zf8D$xUF+j%mqkA-Q@+2|WfO{wb>8lYOL^y$%N*24#e3o4`QF$B z@*eIWVAYGequBU}lUWW-$(MlJRf*nr*=|&2tQXB}&gXQUQF@0ze7%A;GoF=}UXUsg zQ$i$s!UxQq0~eb9SCA}r|G((qycET%l%-{qn2ALL@g<#TgW#1$VNg{!yTesy9WrSE zE^!?WHF)yk_LMG-u`ZoF4u!TFQWqeAk>NvbH#5T$a7?k@SpNG#SmTpu{98Y9M9Tz0 zlrBff0cO6}G8_an69*IS=$+H>C3*PJ`KyC2D|~n?bq4FvrIg%?;E9_Ng#6`Z+sJI1 zg)T7&%NsHUul#0j~Yn+m_F~U$XwhHOFtiBEbKao z;0k;TpCqGi_m%>e%G?vGt3)3P1DH|{6ESc_fd;X^;K{jl0DgCCY?Qz~o|qkN25f@Y z2C-wRALNc`&y0d1hb=+u@=;uG2r#2*qMJ0Ya&?kmI6us~I{N}5ZO4GHz)Ojf=1G#J zQF|T7_^$A?!rZoLLFo&_p$bS>2zTJB^wI!*1G-43@-CcVh}$>-@?bcI6GBthk`5@X z5c5&j12{n5vw9df`S({qS1>KJh&WM_+S_%~2v=!VnE`nG$>sNuK|O>ziCM&t#D&dM zcFW*1U!LUCu5>k7BDV~%;I{Q3X_N(8njphbw>5!23iPx6S``-}zCf{7baYbUteU@N z0-TEmhbqIZ0GW$Sz>jkvl&|z(ky!mX*4-3?8i%j@!1LT5)J0i<3=O6i4p;hQ=3D|H z$cOaF3~UV`oY39s&hTlvn}K;dMzm-jN9u6jmb_TK-RKWQ)z=*mO7=))&GK^~+5Z7r zu>ld-o$8Yl%@FDUH1ush0JF0=X1Y+YfbNh63{R)Gh^Qu_Ti6V=xjL6(x$?tpAtg|@ z8}|xA5F)!!ybC%iE0jdsrBoy{}E9bN(fgDv8GG1M)0k}_(kFD+{2V+E0f#ne8y<;5uwP5lE1au+d-^2{Kc&u0sv z4pUBZtHT71J0c(~M+Ag5<7LojqjaARx}YC|RW7bPlrbV~r21jt0kf#xYXXXo6H*_- z^;&14s$h?B$}lD6`&*Wor$HrFQ+@TEtp)>gsN3nopKx`O^c_lBv?|Y zqOB89{OZQ@XOa;Z8?7zWPwdcyGj=nNU5r6>$ofX}^E$rzUzHI zqs4r=zaD&chR;OZa)a?x=QgxS&(oZ#$Pw{r5vS^~mRk6TsY|S1= zw!zo(Ud5?iC|r$^yQiICj}&H8bKw6k7W0$nqs=#miU8i0)oAIn1Iu(HN>qDA_;VmU zEq6e4_F$97w|{7zRt>TRQ2r9`rL%>*?qcsGTt=z#qS`K~GZ=4*fur&g={17rN^@}k zu(x^FxY&Ki;%|)>4mo4MneFVcTgI=Uwxj(dlAY(1PTuU?pD5bocJc;^rvwJ#gh)dY z!@uUno0z*dhA9g-d;-zd zTW?kQ@yyhtMRrNnBd3#F(J?)n!@K06VB10wetR1Vohzo4wMpu7sRveV9cbGknbVRH zqd58bM4`KQ0y$1EL==^t*4qIk&pY^Vqk-Tjw%bu}bo#sul%FYa2Dq=!zOws)TjIE6 zN%(-}o_+O?N4s)&s2J^heSZcD{5YY=LXa23RwWXRXo)9@eF#(nZ?LsVp!Zx7scnCO zoA`=Jr7e%#Ti2c;IAb^siMVYBw2bAdD|(c-aB@2r^d-{BTzVBY2u46|=+IR~^L3G> zw4E!uNz$X_x9$X~FfyP6wrT%h=Vo^NH|H$+4rni`1R-(hO8ZJwdlkwk-uOJCX1IGh zX;s)Qt|t!Shl*CMN?!A%>$2g_4+Py&VO>e@bCE9Jv@$vYXJw+l4I}*|vK1g*H<{s< z9`$cL+g|OYJUe5UacrBb@*EM5)q;LXae;G^1;6a$0-U zIre;_9>opm9V%){f2I4ij7gX=+riaGp3+wK0YwZnvCSJ>ly8UB&m8-^)y&)(s?=jIrR~GL?zMi@ux$ z5A#O^e(ylr?%4766$0`W_9%cHc}isP;~#d@1@X@TCwEb%i}HMR_hs1_&iA4GO8tq= zT-JYtkJ)4n^@(leO_S(VpP{8tAHl*EuJkyzDxr$HS5xFBX<(XiXts!e8Se2omVZnf z*E@|m=;TP-beEU{HP*ylwSC$np!++)z3}O=Z;-NX+pWE;iFEBTEn1o`Drbpm5F%^{ zJ3L9!lDnw^P}BBl55764oK0YnSMaCOVpC-^>rk|S=|VFuu2dB%LAe#q z+afAL$px0S7vEBV7v$j8rE;^s`!O~ib!yw9iqPqTMV70q(yrb6yjWQ^ss4#}{x0zo z_sU*g;w_MuzpzTZ-}?rEr?=pVp_4~`Z!0(hEg<2$s3#qS<)CzDgz7Xi|HpsKQF$*W7`wx;XC-byMR zsRYOTcPAR7cQ;sxZ&STqr$^K;)=I<0f7fkson~$-Z@Z*VeefyXuvUJV<%RBst(yh zDW2v+u6;dTA5#N`RpM?q#u#jIHe3mekp_O+M#*iDTqr5)(#XEs2F_F3nzFSk7`J&`>q%?z2a%FLNg^mh4=c{ zx>eMI58L&<_?ApN`*Ge=zjd*#vd%=~LA-MLftFtNeY~IuF}6>byj2B_!J5Icrm_wP zjrHin>A->HeumDOK)tWUSC(=YjFKhiiotA}O%j`apW)npOnj4q^D5M2rOK7Mh~ghbM;X*Ro5Q6jw^c;47K5&15)9I9k#epv&Gh=vSucM{Fuw& z-dnY^=`%*x3Z$TM)slisF1>nqQ8%fZcZr$j9ysN}zD3Nn_$NczDf4#n$76tGPfs*( z?SzxxYUPmIwr49rmgw&I=`AF+?t@;dx^7UFl237Ei1taoS@?YF?dcBzQ1W~uarRZb zyxSoeD7*>}lHXilL`#Pb3X-3jt1X&K=2`io`Vcb=7f$r|A&_*KTj2X%M?KL=u&XoyA(gl5FXaZ*Bl5cH&{M>P^Y+j`8-L zJ@=P~)z|Lq|M2*de(fdxjGfvBD?gM`k5t*@O>EIr*m(WDGwO-joeh>D!x1@8hbj3q zmE(Y%=|)aoP{T>t(Xc6Fzd+S3KItvIJ0uACMJ{z1UG*27a&89;4_*Db5_RO^wfyh;vBc(6OBTLt3v(#UVZT<^Ex5Os8??M0({{Rck)%mjrXR!QnPQ^c?PIg3 zle1#=bj#%eKXR}C$-I`k;XNPEzJy!kc2D(rvt!TKjGEPCiNC$wxLWuVPw&`w&iaoB zBCd<*ef0Oi0>c?;EvMi~E<|-YRwxkaP{+ z-Lxqf|mRe44Mr7`I7Qf_EeZbtQbP8HvZk9-`<+2^z6 z&4R^SB_+5)E-f>kTh7Y6@Cl~w@I`+K-lia=V1ZdapV*S7(vn8Sscsv- zI$!xww$Gg?v@Klt1Y-q3PFy=V?!CuHIAKmblUmm9Mhqea75v%B+8uE;mpI8O3sCYu zh7r0x=5jj^b93vn{V|K5A6)h`604n;_}Y$HH61nkH*n6<10tqzhNanIdACSs-_afr z6jgd5z8^Hs^MbgF+O8qXxiSiv;w=IFHFSVfPHjJ0;dN}dbZtCm84p8v_4+r<<@T$2 z4^B2(W$*~R+O{TVnLxs1x$=;krHJlV?Ue!?DO!$VZ%;~Y6S7KOGJEOFzQo4BI5nkC zUk890Ys<;@RE1qmSLSft5JrIwS!h%p+P7x^WO^9!n73Z_8Gusdm20n@gv$$i`G)5=CZW>ZZ=JmCvnUhz~oDHN6t7V0(++U;3-^ZBRpl2s=c+Fr8V zp5wpaaGZAPqd#`6i`@JGHCA(H^9DT)O*_p${KWgV-wc_qxCBsK#Zg)Z#bOZi@%&;h zE9e`{Q?9;pU&2t%4$+_()FcwJ+VTpVEGAlVa91AG&{-!PxXB4a%Lkv|M_k&Z8uM{T zZVSJTNEvl|*z$6l^S+#U5LtMykyh+ajyKy`cb7BvW`;eAs%9GT1ys?V6Wt>?_f+|F z1kao@srI-n>({3^c44Zs)}p5pWEPIy44?>UjW2JgYz9Hg@`Gyq^AAqHa&5h4{e6B#DqN!qhz=y1(6|av#L&JW6ds zHyzCg;5a)KV5fuDusIU(WoUL3ef|bOEJOj(z)Qc1zYwJ(jpyY49{CGUGN&d1wOU_%%%07S0Xf7+X;`Ca!G8AWd_*(8%qaQ*5WEKI;0nxfsD+%-5%rhjc5}D{OTd17a zuAA!v$nfV55t7e&+6Fl%giRXZRILhHjLL$SsWb9rG zvY$l`Y+b(4cPa~KktwOB_slRx{IdKWpW5os$=cSvV&i^WT!vR1kC4O}Dci|ywT$hc z*q%s`wL^bD6d`%P%Yi~$DyO|`_wJXci>JC*2z>i`+XyFDoJVx5srB_#XDz(?wz19;@6uCwb==XWm{<Vv{98X^_jp=03i6r(`2M`Y~sX&jX8%^eKfMV+*E5W$y3dClxB*t z#Hc+!Ur1{?phpgF!rP#Cgx%Mp9=mAKueMC!TkG&uK|PZTURSYEOSso$NlbwJI-U@m zL6qd=?xY^yzo`Oiu99m<&MfEP?%ex6+(PcQH#7uE$rmAK8=dH&=tM~JnkJ+SLH47w zf)u9M8CXe3b=R#gA4I-hCF$}g9WO+P^OQ(vZG+CS=FVB2z2%o+DUauW9P+qrqWQ$| z*iJi5?MMiXzY!YBITohfCcfm;_)er?kVTigvr79{9}oO(%;wEe<%l4{NdUlydLkUt zrp6!x_ZhQyUW-wQPeS*)1&4n3WNzGyX%b(z?!3IjlZUrTSH75;+q`>aA#+1<>C((41xf2%4c~dkQ^}(tBK3|fvL{EF6BSX=Tvd!;+K)Iy1)$=zpbeK5n*^{?&iL>MXuL2>Kbc z>8tt22}>iLK0yIocL`Dpxyuy3&oqg}cvc}-z7b6=JMCHK!mEhYprfKBnxv%8KxE&genof@8_7v_F`5SJz4!^X6R>$2?J4f$RnOMRq%FGa= znUkqca6C?HtC@KtRPu2`wJM!dgL(15=GfJDW34-V&^YMjp`x<1e5wXdE~Bp|wL+r1 z+Mj9;1*%-!^57Z0+p<0pB{!ZnN|THXK`_NTvfZ8$^W0brbRx!wyCAPW79)Y=g)6l; z{i?SFV(tmne7ko|IF*CDf6dl9yE=<<_=@vQ|$ubp&$!12Y4rVq2SP6W+RGc7`1niuzO2ymKTH2rV+FPl!G32x)4l zJuRcK4mro0c?B*$bC_(InpN#mjk>ncIyx!N_?8u|Q^f6rz?$&}li3C3Lkxx3ZdsSjrqi=K;7+Qt zPg{xC%6&Hn`6UjT2oM@gHm%>W=fo+!$MrHA7ei#OqrB**ErL+>8ToVrrZPc;v@6ms2AJ~?$TD>y&H!N1ILE!9Up zGtvedp8Y}s=)K-`2+O)EhrAPYQ7njJuX@cJJa32 z&#HmcXv=d(hKT_+a{jPDY5`D)21q*hyYhq{S1Mx4MpZtD?l(>UBfoFz^5a&rG*X>7 z@8FOuo)?0pjF*U1o%p8qkW0yvR~<^I2iCIXb2vY{xIHnQkdprh`h*yc6`w*lW?ERn zrAVdHh?oEFJA0|`n;tDi*8AW%$Zu(}>wIR=?KVf*Vm5;)cn~1r&uaRoq-^~Qr<-;c zSmN3I8x+6%x!6e%xxp5xhdKrEE3lW6w1gvk!#YEFmJ2Iw%B=>l%M~ z!8wIfd3J(9YJFgwGnV7q&vqHK?yWX9yNJ7G^&bz+(jVxiL_XbRF zP!RWDOM->9yUR8PJdU2a89HlR!k>#c?c{{Ox{wtxN1S9o+Mqo}Wsu!i<-rwTv%9*w z+p)?P-H(i-E?gE{sLauv0;wcdfRL)al0^Onbg>F0X#!N5n@585=IlG=L& zj_T>bU*(VxjmkfGbat1p=qU5Hx7I>&``xChBn$!lB%>(~W$il?Gu z9PZD=fa|^q1W6LsawjGxB45a8qkXKG-H<-xn|}W{-3pKi$Qz{)eS7vib(YVrbL*tP zG=n!l8Y0Sz*CnCpeO{6DEbJ6fByw_06=6hH3|WHaWpKgsNK5aOi{|j}Sz9tFIXr_# z7Z@HC(jok*o(%fVL92_8hAEU*&@wT{KC4x>tfYF4mJ8|RcHx;6W{GTW)eY5&$DasP zko7Vi<2-{FPO#yd!{8j#WE07~LaEY|kDdXxn3R+hBz#`@QRh0#z~WT%-?&oX5eP8w zkfFGO9dfjynhk+u0%j;eePs&q!N+HExJLj0C?Jzuu%kj)1MD-oPRv&F=7Vd24tI8> zHXQQ`LP4Y))|FW?&;e{2zNy6sCIMg6)u3C@$ zTOZWbedfkGqs_58hAz;QE`!9Rc2G)YGd;59BaAm_ACunOOWms-arynmNT^58EoU`< zHTJcKK~sNkn&#@!COv&a%waMkJ^tyUHFXEVY-r16i;h_>0|3|~lk4kq45}}^Fbm+Q z%7h4X?g9RWhV0t_L#Ye0TMgR8lDv`{5vT3!G!f$;ar%~;KeCG5OP2_J4x$(~pI07v zy*L~6J&LF9W%xdwg3@h?JAfGK5rXrl0ZZuRG1&^0sAw|<4%ve5Pi7~Pb|0|{qn-OI z&TmGzq9veqeS86uiyDdxSec5fjL9Bf8Nrcg5-kzgB{^#T;1|8*;1s)Xpk3wbRl$C& zqdS)WO#uiht{H(Ey@K0@7x$*ZCG9o@QkhKzRRuD+6i(KT5o@M477c0?BH>g~(sae5 zjCz}u$i}=*IxM&^U9`0qla5ts=j#b!=#c(@_e^lNROKA zYQ%dHg5`wV8qf#Rc}wj<;Z2(z*BmiD%7Q;Q$~RU8emsOCj!t)lyNG{pC01d<3BE^v37YK!fPEK$2%41S&*Al!2?`op&)azb>|&GYtWU^;4_bFNTi^99 z(33|&b@+P=B6LC>xq)t*_6eE#5Cg_kVP~+NO|#8xzcIcg?*m{VKHcff2fi&d#a8e; z3Xm`;;C=qfIo2szulpWA7C-=rOZ$`5!D^rcKt|JgeCrZd?9 zH0WAB6|5I)Pao>?mWw{p?Dh#WQp$^YVNdua-+`L{{m>$^hIDIKJO?A}Hq4Pt zmQq!PqyyF24~zl<;ny&`^J1Z ze2=!rYE}~7eR;X{%ZYe}sGef)*eXcoPCl@WPqe`dtL7XPVP@DB*6cq6%8QWAhMAh+@S!D%+CZs4)x zd!|HL*WpHJuXZz1>-6L16@tZzOJQvx&Vri%>Wu%M2dsU-{fSOyAp!&Za4Q64t}AQv zIhGQV2YtVJXYFl0abkZWr>x_n?h}59io^KMVAJKFY{6^L6^(e_u#0>jvQMr$@;-%U zlY3xV_v1Zh5F&9N4Pvd<%>f+tk1lF<71Zt`_e`2PMM(PZ&h%3%CIJWXmDK&uTg=mK z0C-V~SPIPt3BsvCU4~iRmSBTf2ks$uM+h=<23dyNAsk+TILBQ4(3%etaxy!$M^M;t zR4A4?L}Hw;G8j19@TWuBq3JIW#+{Ey+@PO3c}>>$abF;*GmyG%AX4_a;>t4mX6vio z_~K2_@aUWq&cTepHREgg=QcHeYfq^>kVzJaB>1g>^&|2%li2;O>OdJjII?%o9@P(6Y1~#vHa(7eV@msKfAnl%K*Kh0a9>PA zo=^t;0w|<8Jos&8-d*Lbfo^4W^n}+3pB2VF!qErqsS^V)LEKWdDXjK@>exG}=&+m* z0UXBAM9RO43`b2xx126r5?V43WjxP=b4Ua;7(ANG>-SyV0{)`2s(H)?{aq4nS>Iyg_g=-T&>;oyGp1plAGt}cP zv9@3DcZ2+O3I3#-Kj3=KmyQ#oXGb3dN0#rFe$V_ASt2icbX6ArBak)EMw$ZawRxOc z6F+6V8+k9u=?YXy?So>ZKk%swE6(LAgD3ODd6;B3EkDyj8DN65!;mQDqq6n|P-1Uj zvd;X`T)<;tuL#x+MuyrAUv+4En({8*Yb{o%E|K8in^8kc?1TMr5_e98ca=t*jn#62 zSIcu=IWjayHtv0IyiNN8ByD$^M#Qb{D_(PA*4R`;>YxU{-B!z98wsijK#d?x&cT2B zNTU^;3q_3zc1JG`!ahe1P^v5YcA=JLTzc}b=p~;zgm&_sh#goY5AjUXrX@>`pTIvm zvo67{(Pn9YGnoqKJ`OeHIqT89Vrg+F9M~!AyuUx@xj$BN-`|9&dOnFu=-G83bg$B< zxPdIK?AgULH_)^*u&eVd;XDM-q~|5@VWJb)Zmo=>!73{2Iubq#-po!OW+K#p zKGW1*QQblsqXZm;m7fQ)!SATBL3&FXLmJ(Z>}n;aLO-q$A*Fa*f1EVvjp!ECRWW8W zm<7Ywu{*d^4U(lPNwFA-0=b zVvT3edeNjycqFSJ!hl2N9CT-}0QGh9RD9U;4euWIwRJ-5oZ z=rq5&o!Wd^Q3=hw%O2nFDpmNfDDKiKhD*lxB{2%ncgc0s}cWaD#i&#G#C z9MazKGY3c{XOjjsvZ~1-52%~#V3)X-`$_EvaPa=@heKo*XF&`BDd8aK)Kw z%LtJ`Lpzx*3R_U1BuC`rzS+7rDotYgHD?d~xf2fs68KL_PdOzk#0zihI~4H+(2-8w zSfogyLqQthaW3-jtX^A#q3v)cHdUlFcR1q%>G{nzp-(s8-=@vyJA4_py_keJ?oT~H z#Q$@ye)H~)`@l;^^|U)XB~4($n2AFT@Yat&S?y`K8^kH(V7eqf;Ta8s2v}_N!;(Nw zaD13thhw}VZut4$n>9|eC6!^);jJH9ffUS%#3V^Iz7v}ej!~TNgwHvLdpqd-Qm@7} ztuH2!L1oqv@lTJ4Vrw6%fM$-lo}dJ|%9WlM^AvENUk)C%?{LXDEPr%-ftK7e{w#&E zK(dizb!4bAQS<>X{Gg}`k#(;`z-A>D5nq%@GkRJ?FK_PxMvL!6yhKdn$Ba)0hOY~+ zX4bf1vLn{4|Ao7D0nExo|^fRZ(SKdf#Y zQWa>{dDtAj)1+zWOopyj$yO-*b0TIc%P&h}mAz#U)hSy{M;2hTdwNtdz~H{N=l_d4 zz1_Tlt&<(SUq~N1^T9d#Rikbb2yDu4LYB;nR~n0VYvyY$RuXC8Kakv6KGFTW!IspR zd-iCtxKxu1G+6f@FOWI#=Wr15x}sj$ROrZodb)e|I0*VRlA-|@hHc$cEM@n{yTu|p z>rR1Bff&hod88K@%oETm5CW}�b4TKN%W+)gW=zD10{K@XFJB1*^)x>EO#g?al!c zh1|lQW4qD+3=Ut1Tli_qg!6$vw{CWu1&q>;yKTIexSt?x;-2}{wIcxV!o88)R zmWB(~q++rljT9tF_i%TgW6H(pZ%xOG^JIg7U1`q37pXyOxvVw)zd+}W9FQ#gaZEkj zEpYRvVkz%UiGkzBlaOJ4uQS+^t-~tvo`&HgTjrbFPEF8+5@OD&zFNO14@Q zdJE&@$78m5VQK9wK1j*AlRI|&Ez8E?MwMdgm?ImBvy)Cf4n0c!7poO8f0j()5p&z& zWSYb`b{_#^JV>(r&7=EuJ#SSMTkGqmG(Ek)Xc~BKmh;DcDck7hSJI9iJ&Js5*0q20 zQ|N=nDzz(QZ&4vjVq;_TgI>h?BOTLKag!XGlH$86DW+>~y!$pds`;SJl(#qV3AiEGlM(}pJlP05v?M0gJM;Y8<!FT2PrmSMZh=9PK^s^FF`?Z}&j}5Pb z3rDhl>A#2T-y@ndksRefC>?;6cqs}1&>gFH@-Z#L<{FE$7MPm>yBSd%y>b2eHflNS z{cDi)UE^e^anGb0~*|wOmlH;NS2=!-n<6Qg7Jm{$fetk0aG-DArpp6D%XKcWv)K!+y)( z-kt-#D(jNEyi3D?H#uYJ}DD8+9JuW|`gS6BbA zfq%0U67pz0`Lx*@5DeYqKS644Hl1hP{`l48J>YwWd2aekE7&!b*3c@C-CSmi@chB< z>eyqUYWC6!k~*ebpN`Hoz5g}Re^+v0UC&xMW^_q=w!2Gkpy8}B+o~O5hZGt#0{^OY zuvWSF{eJ+Xu#Mpc`!2RRjK3pTV;v}YZ8;<=H*EqZgmvlP3^ygqYEolQk;bqw4+2H{ z2mAY63=3;e=dfcl)AOcu0VYkb<_Qp2^`NbkII?B$+_}R( z3HRt+jsMNh-op0z&mL%A&${w&M>A*5 z-+U(4g)9eaewB0<#NyKiBbR{g0cc(}9$3oFn0ZL19~kK|$H=e_-qTi_FrtAZuFhQ6 zr-{AKR$s#&qdk87xDq1=i*7xf8bHwXIUT^kw5{<`^VfHFH75>+C;S_Mj5qYhy1qfysh>Zwg!?Y!lI(0fq==`GxzwWT;W#_kw?!v zRM?Xli2D_z2Hj{fS6b6NN30r(45_{Lv+F_76UfZ<+KUgKKzmu{nY@3O-o?+ zIq9AM;h&YlmS7Efu5k5?eVp@RbS_>b?fCxv;mwq}>-{-W2etD4RS|#g2mjtb1Lx1n z^vR1x9zNv%v2)?^^E{LBE{&{Ik_@c-4cg3@n3&aU*Rj3rTRa2lKGEXHEi!}5&q9Z;cRWA@TV|Qx8ja;Lw|^s9DNK5qHg%t zl*Rqqg8^!k8xN7T_{~a0dNE{ z1rHuQa=ip{lJEx-0F{`l1Mbpn9VRI)F78iEdpzLshg=&pkRL=v2}m#a)A058=@Z!} zK3JZh_IrdqqZ3`|Tno$u2sah&$}-=ME;X5@)Lc(WI%j3M$ADTVCGngtfo|bC&0j{{ z(xE?EB7l^z?(f;D!SdT2)VP8*-YFx0!9a9Jpm$z@suFm<|`eM<-`@??m&C6wWAeL5T`~L_r0Clhs4kp;Nb8f}$U)|h! zpWvbOQY8jTo?byfDhIz}{>A6^io9bBa!JJBgy=}D12aGO2ry9p3fKbCCK5h^3&jdM zpJO8Su%{CICH4rMe7*_-B|ZQ{Y|ub}Mf0EX&w&Esnt?BcJb<+c*>?n6ncylHFrTxa z#0xxMFBZ}Tq(xw4aqIg%7qdRud`tJ6EeE5L*I4KB*Q3}Euipjm|8(FtJhvg?6&8rV_J9@e_rPg5GR8q+JZ&kr zrlzLIdjAKvPD8ikxfxmT>nCF`H?hfb8sj~mG*@Q)CCm9^8~JlAexK6IC~zk(jy~ss zevvsv;grbKSD|EJ$qqGztG}cUxI8bO7)#5pN-sGaae9e(Yvjt=i$iIoeV(;@wcwRd*O4vj`LV z;Y|s*pb;)eN=D8z7<8IORt$8D=KC-*azRQ176M!aOCY&yAxWtqXY!u0qpWkgkOli`Pko*Z8f$3~-_?>UC4Q^a|q?c27+d;+pG1iPZK& z%I6$iz53zS5fefN=l5?R5P;)aO{t)J#jO60@m^Lh`boYVZ13 zl}$>g(^E<0PnlUE4hDwn{ioUhp}VIETr zokQc9b=QUbe3)Oq)yue*IN-CF&>1Q=ZRL9-WE3a{vO4>dz8%k9<4w4mS3^|Mi-Qln1G8) zV8jk~*$nldI8}iLyGQFBwkTu#Fi{#v5AX# z4{nBp?v#G~=g#~QV`EfK_l|+#v!A4kpH6i)7@vz|^l0jc%8Yge4m~oiF3CJQu08ZP z6q`(Rx{W3KQHRz&&AqkF&cHNfXr`$Lz+j5Brn*9CX*nLc_V6WZyX&14Mja9FS{|to zXnMSJ+Ld-z2)ez4=Eb+xoDZ#9PZpxzK}vnidfXMsbDi}MXS?#K@B3PE`YguLdpw3y z(3ZONd+Y5&0$Z|sC6L zj))V%Vn_HVO|OaYM4OXOU5N4QkadZ6I@KG?sldHN=1jx^byu%2)aIC(stQN`GY{)N z6#h}_7Pf!%kyq%%%Z(?DPDGq0NZ22dMSuU;HJ~H*?Ti%JUd_KO*k$LV+9$2u9JA}S zNBUbYt6gbs_klXY%$tbULJi7>c$s=X{o>~-vM_0J1rooF=bb*64K4;kKB7*9SVZ6| z1@b2i6*;_H19;yrA8jy}O5<;;9656yLZcV}q^kIQE=K<~bn9j~Wc*il3-pPFs) z2v5}y#}01oZA@|?_b6a4ReFW?q9!Y*5*vfJPStt*Y0`N*CGjD%HZ!UI!%X>ViyeqT6J!qk!jz{Z2e*|o)anASv!lK4KY4f0f}H!?TT<}D3xp{5lB%B*=aSrano!ECZfu#H$!<+QUuGYF^nOeUuK2=}shMD$ zQ{i*u#9EreibZ{Y8;b@4&Q&5lpS2|8fP}Mcpscs%xe?SRw-k@{J1#$XvCxB@g5s(Y zAwW=GYf_b@iJfik6_U?Eq2+SEFglr96|w179X0L+U++(nF%83(7osy)l|2-4Rp|CS zg|45zV{T@N5*cjl@Fe(erC4FdpBG4EsP92(?rO}a`@?%W+8Lk5SodW5(Qw}Q74I#Q zhRse~qXp&rC(DP#q~6DK`%d!Yq8LUBZx7{W)G_ye+dOH|G83|L^7^Mj(hc#pJTFTd zX3iufmxh@vG;c(ui`KLyH>KNBMAd>&q$tY^qL~sT>X-PZA6yz4B^Qewk}ELl8j0H% zZHO602Z%`rHYT4N*>XQR&<|Z>#;C!4C0)qTy2>TuQ0vaR5GcURz_hch5u@-}=W%9;8^C*9OjIe%oV!bc^;lSCMm z!aElUiT17{mtdpY?TdO(&}S=2^-TBI>k0CVHC4y%dZ9Yp8~wZfI9Z)8aOEkjfIsn} zkL=Dz_qvUZJ3i*oKKMvDdx?cMp0`>iaBA}1$*z1XLrA|N*6Vy?t%*zH0#zG_fg%I? zWLHxM_L;@lmp_Kk^k;4nUzq!SZO+r1%(FZH@KWk%Hdp%AvID3Ev5$O{zQ$lF+s{KE zi6E3{BbuCUd?cFL)oOR7q_s#WXBtINEqOhYcA}@l-q^|Wx%*U1#^=c3caG!1N{-Cg zr0~Yvw@-O>6&CS?QrZezzv8XrGr#1#)oGm}hWiw$Mr)Mt#IMDEcO%wkP*W}w&dHv~ zS&YoKjej=Zq0Wt$z&e(81yS>ueSM$&Heio3#~u*+Gt_Fs2{SnT7zx)Vu%FT5RBJpE zS$wCmM@LZFLj2K*#db*FL}r*oEo7$v$!QEr^<0t}mV7-?FXWy6gRd zDSMR%(mDg{?cfpt{K%)O(5g<7+!Ga#@s!t9{WC&V!=9qo>V_{DG<|nDB(FHG>57U^ zIB}w|{^*igZKpK~d5oS0lKPn6W2bMP@+Rhn9LmS<=~|I$23Cc>Yi_pKQH;vL8}6Si ze&$?2AI?u4uJ#Fi1}l&1Q%Lu$>$&wQ@m#7q5v5r~UJkYR#4DcUUMZT=!}syeIz1ye z^^V7vn3hv|A1nd-)0#5@)__c~x|HzjCeL^|pcCnlsh*F5UZ|(}?b*3~*nF$%q`Jf3Lkq8k(y(}YhdT-GVED2O?04b=PE7hx^? zsNu^sCvX=AbaabxZ4=g2ja#Ayk*!?qY?!jI9WZE`wY`NGQP}Hiqjy=kh z%+X1^X}juX%_NsZ!jaODm)`FEF)iz)TB9Y5rx-RWDLsTF&@vbm||?`)Msh!u7@HTAi$RaFy%rTb_#V!WE&Lg@IzG24a#~;Y>|M;Dr1!<)}Bd9oWLtzLsxQ?`tRy&h`$}jcM5wDSj*x zmR6LCJ};T>(<2ysN6y^mT2sd4EI)PwS-!8?qZjN(I#j2F z*ZWTdm_f>;tn4Z)_B#pHm(W)ZNA5l6$BA62{bT=Buh8A4+)vI3*Ni#XX~h?KDtRq< z+*G|CIySxPPN{4-8lHG5)#1Q86O*X*4J(LAZ4B>nw?ZtIs6N@tN8A|IUS2hBcR_~p zm|Gzsxx4e_qOHPwt$Xi7pD{BZIl!IDnL1&F-UJPDKRk0(z$_%{IXsLa-yU*r|M>0qUEyjAB*UT>=`ylErrAn_NftI_@oe zZ4*rpX;cC4TB&0tvLm$v{r2%bS%tIdYAR+hmM~_06slu%LiFSrK)JG4U|8l9sbO&Z zo+$#-+T><1o?ow;bZq*6l)VR3liB(`tQZAUq}dS&MNtIlMFc_=Aqoi6k*Y|MuJkTN zM5F|f-mDj;C-RD81va9?6l+@aT_A-!Drwe#e_>JS=eCi8x_y;Lk2be-lU`bmOeLO;}0@Q1*aF1@f*G+zOO)AITn z)Vb1gWdo@vIX9$8b>Ra&zCZIpCE*5tVOO# z_-L+;y9Q8bvJTW+kq^Ca%hNQlFGS~+5*E(k!z94%U{JV!hBcZGFBR1+P>_<(d+I#Mp7R=5WkYC=8sq+_p@)QY;vbRgxo z1m$CI7v1wV7td1M`|^m(Mz|5=w<4QI=yI+};`0mpPB3yJIA-2H)HTrus$58AzRHD# zZ(~B2tdcL$Fz}2y-Yn4m;xzg0VOb0mUW!TNMcGSVyN2fa8rPO5)!1h~k`l!K1+eoG zISme?&t>z5%B-7MZtIo4vp~LLCJ4OOSsUJ>2`fa07=Vk;y+c)G*srQR)H{D5w_de`;-)hzM806y5+dRdnh_Ze5kf$xI<^!&}Ks_JD%HslwY@8&^vDW zVy*KS=B0Fsq)K>%sm^(6Rx)~_VfY)!IG>RK?oj9XqH-3&FD-2#znvX{O5%{MfS*kI zJ;t&h8)VLC?=u~$d%{zNV%e6$L0?bz1G>!VC-x!JKU0d5l}DKs&dPqzLP)DhQ_v^c zWSEQBWLmd#reZ7u%0}F23+48!thxaLZM`tV z0VplQmq&X|Y~mt+HZ(Zj96*ssHJKXLcT`*3k{F3U(X)F{ zH-66bK>LDMnQB!VkN>bP6;nmF%XafA8d4+%B2q*Iox;nm-l$UqzF4pxF-x z+IPOt)516r&(-#>x1p8gXzToiQ!nFeo578?ab-W2Y51fI?!~ROQ;}(_$2eLWljObJ zza6!aE0vUkYjsO&>3dK6*3l)Ge}e=E7;c^F2fr~yhUJ`zl;|?06HJ`-*VwaAaN&9K zxQDOExri+-b@9_O@T@upog03Svl)+}eltV7J)@hajF&*ry?vt_;sUfYcUKJ z0Pk48kI$ZFMrx(2#6|DUB(ypd*1}UfQv>cVDPn$$(=CVTmPeni%Wx*?CvJq2F)9(!JJtCb|4DhW9NXL^ z=y#fPtqbOf?mX8hnltA*mDL7VWYMGYgBG+g6f%ct2Nsa{*Y$ zlH7-J4sGxwk6@>rO_bWq?SOVh-)2?qI=Dh%9IJfmvTe2XXrsUg;QZ#>o7zCkg9k}& zKT#Z#t>C1l426BGc;H}tadF&nphk=LFvI=to+qBA=y$IwVK3fudTeTwNekF3;tNfN z!domH;qinA`b+n~^#?g>5WQQ{(?jdlW7x=`MmnCAwgUqDy}I2I$XEAMp1<|d#Nwad z4Qs0_v$vU=1#dvPHD6pix}bkKY7#*+nZKFK3Jg-OyjRneHTgO*njA@i)%#jG*PFJG z+ynB2`~zf+7U->c9o|@ptejqZcm`RHVV8Lk1$#Dlr?h2a%{^qEif$D2lVf7@uw{CacBs;ye%=X>a0^d&^$Lha!`Tk%hC06y&kCH3n;hgb#v#+$0ZS(dcri4ous_;3^GTXxrul)bv2nF^5`h40^g2d+9iMUAor z$UC{PqYtdq4JHnkw{I?-nKp?QX$B^t&7tGAfQEO*?LH8Pd_!}KqKpsDEaSfviVfWE zu`@i3C474p(i?2uYBORF+C3DzlDRtrbKLs1$IFWYTprFYdBm+PZ@w<}EV50ul-6?} zF5Pc~P9Zplkpq(}13c~Fe3mMp_o!xCT`%bM$?SSRh;tu72F%yMOn>*iv8V1VKh%3X zj&o`wg1vIYQtqWhT(z%6cvM=W!cv27uhf9@#Lv~*(T9EK%Vs?q{D9h0=>u~>eQJ*% zS8fSmXZ3!hpjK(M`Zyh)ARZRjBe{6r)4{uEz(m1cm@LiG5E4e~yrSJEa6ww^o;&)4 zX>r*@SATe$@pHRwcVg?DNi6eQLm&+EkZHv>)Du0q;sui^`cnP6OR8(lUASmEnG!c+ zJte(1)B7G=HQ_O(7a^7Xy-E2k_6iL{-~5kh8r!;=q#k0JP5)8WUQxC6GpwFom+I$1 z@c6oY^HW^v&3*g)KvHz}kk=W9j)LvO6aPPzZvc|x`&4x6ZnfF%yw?Lf2s(~pwd)*3 z9qo8PrzW%=yqzcKR6vjZW(1<98e*^x!;p|rV1QGZHRE@y)F7Q>LD6;fQ%6w~oFHI8 zy`^6V<)7OR9{7y>X7-R@p3$5+e8+h9E)57p5v0_=njjF@bi{>@hOxcXs+_Rox; z?WfJ_P{Cs!RwOmdrsHJ(QCH-v-mVL)1;W?eBnR?mBjeuGq|Gm#J;)yO?FMoXU@b|O zuOgeOkWViyrhy*(9x<#g?}_lIdsB3ItW`P{TRwA#ZQZr19!9La4xm+YpDc2kW2LE^vE!n7TbP}_H@+_&`mc@TCrg_ca-VHZ}7N8A-H zS(I>O#1bb8Duef4T3J+FxAyRG*rFO(D4|CS_)5lEehUt()f7IuglQd8|EU!3+1+;F zn+&O2$I?PR$xhRA3fEo?lz@<7s9Q8E)3z+>%-%guR>qk^@Bp9ad{nySp}*jACU4f* zV$sEe@Nw3pS4MM;r3eFgOq;uKP*b3flbmSTf)ecDv)} zSXgRtipPvI!Mb+o^5%wuC3gMiLvX9|!ks#Nmbx(`rjrbqtems&Q{IXRDqsdTjC~k= zxp{%^s6y(Qha0gg#+(Z9K_ zT%P-Q=(ttb^GhYDVJQ5Jw`vXXtnXfWo*++&)rAf1lCdD{rQ%tj)u(|{YUANCNfyhH z0!L<2xx(6#7%)vrIt6tK)9!?Bp|DSe3pZXaR-2_x|McP0Uv#jZ1t160S712JvXT#J z)Hrek&%?Yo9cEdx-LqF)ql!+<$b+hJ&|aT)v-;KU9=0xU*x#of{nH~p- zAv<&+xNj1K+852HC%Rq)mmIrwX74YI0w;4&vcKeWstN%<35{U zYZimTSFbCB9{wLYS@mD2FX zH%BCNZDn6XWayzh=9Y@3$hO|V+XMlLN{w>Sa`$SdGwo1#Q|Ww@rI2+|H@#Rz>-YCG zUdz2t>VCX87$Y+!UYYG)oPV#H!sSQaIvdMcFD#ntz30}om6Y>~7FkhaB*%ltJwmVV zla!;XbLd@>yK{GH(c`F1_nm%$i&wW?Pja+;H~D54MvpT|P83+boHCDdV5-?1<#?s` zR{FFqL2$nbhqW$!NUph;s3k;B&303YDQ^ASnc&!cL0(o}jJGO3Os?_{$O$VNtGfjM z2z@N`@F>YssWX=L$i~lyg+hGA9|xAhJlR5OTlSqKXEOT@igMH>Yx7lPtTN1{MVV+= z)H3AlFIQH^XuSEM=xI#UeeZ>)ZCh=+7?<3PQm&w37gu#kbiuq2nl0i3;#r3viE5=% zYBfCP1R7<8V5{GsvN9)$70B~kyR8>@Hd%?Cn}P%6$<64q#~0sUPe+^9m=BmscM zC3JQmdF8&>Xx`!tO8G=V+{vOdfTRg7gsS5kkE=J%*~ohlAy#Aj z(dD73kN%TM${}w)PxJiMXs%{nGl%}ShvFx{eXOv&SE?y#RrhGGfO}Pgb5pbEQI4T9 z*NQx=PpHW;wz3$FSN-+)m};o$ne&IBl3PP9J(ZVN7xuRpCJGicXM3y_w)HCYT3hJ? zv>+<+JW$E`Mr@8-b$!epm3Q7?3(FUG=vK|N7FzNuy?{`4(u*7hdYd&6SH!iPZw2jb zm;wzMC`;pNqW#`iLrY`{`iaKhODa3mqwcVo8X~sPGJ2b&w0u_JlSoQy=s7#-#0^!3 z=IWSo=xJ5hoZ8zkYky(4--N z>XfXINZfF9lDz*_)f$J%niRLSEIF$>hCLzt^`s+Q%ZrXdRWf?86lK1aJKuteH)Hak zQL__HtbwNv0-=b2hdFpZ&$B?YZ;LC5@O)iy4}E&zY)|%rKBqyWi_(&e%q{e-hh?sV zAG*FsvxFI!gxZ>XafgNOg?DG3X}rNxz<_HOAB%ocec+iFQ0M8Ag#vdR+Fs#B5L%(1 zUmzu}eJc)q&rspiEmTNaF5rq95vU!0etQ{2y1}2qWNKi9g_Ka6VR9HfTX5o5d&R?= zf|bdwjHWUE`i<`#q8-wnE#{k!A){xarU_dhDzF5M4=xKFY#m^FaNjMyT_^#d?gK4~ zNU|n@DQi6rCbtEML64z(Ri1?BrH)sq1xptWE?x^GxEiYiW%CQ7_@%-wJ~EO<-m(O1oC7rr?|x@gicT*c_ffL0EYn+zXR@~3rjwC5ZXmGv2N}OM zY++ZGXHP%FbO{#JZwk#&Xq8^+&DAn2t5c_e%j9Sez^OBH3InX+b8-rCfaWA0u-VC>Py}36{G(W{Ht3G z>dVFyS8tz#Fib0c9_j z)}Q*G!@C2lkJCe1#Z4XB4m+ZK@Je_xDYmx$fe*zivAw=7Fq*5N!NurtdT+SQWS!W5 zx~L5=!I}{&?-$8XmahZJeRXCRh5NtpIH~vm0E%_T&+Vddm-GA|;uB;x@g6dt*iC!) zdPXh-i3*+`gclirRO7?-fjeq1_1BRUZ2Li(X*U8v^?hjh(->P~eHcbeAvWU|5 zQ`@upuWem_^V0tMHua2eGP~E@YxP%?Vv{ryOPcF1`>Qnw%)fdDJ-mO5s{Zd=MhT6h zsi3`39iW4BaO9jfCP@lx`RzY4HJSF&?r(_hLqY3}D0RKl9BJvZt!DPu7a`VFbm#W+UN-qLs zt;f5~BF^mJwyVtFpRjnQfHbQ5tx4i+5e`C_D^)KxX$3{7cGn z{?~AB@~TlY9R9s`zQz!USD1j>mkOG+&7a@(wDCWm{v`@2K$P(!0dCuIPL;o3_s$rw zLdYp6PL=hAkiVPim!cb$0re;i2qdxjLiAbA^(2cv`BynYy7MAeFM}ML5I6Iwff(qpLz(G*!jC{aL&g+ zS{8Rr4SYw*NTv@&@E%3Pjit+3F+DI<-jf7>I{~)xJ zhxGTLzV0?zpwZ+YgZgg(%parK?F#({<&m$pyRynai~Y<@CKP_+SiEyxQznSILC4@B z0NX0ee#8!FkE80kM7Or;qjZ_PD;JaEDYxXS;BHAA$|Tfk6`z;hc)0GZWank0WEYiT zfe>lux2y$MT&0pL)11b`NEN6pdBdbSPc!CxWoy5Wv{Ds6wJvVC3<Aj-^_7J8wA_(lR^3 zXE9zbnzN+MNj}S`dJiqFKY!VMQtkU#>+9x>_%K%KW#lp&r&19m!=J=0`-d$_N ztg!yRHKJFYp3ppu;z-+4-^O4~p~3(@)zOA9lsc~OR6|UktgzrVPjrYotq zxR*%kb;nPnr@Q0gVaX3Kc}p|nPI}f&y1ID~<*`W>5^n2~(xa1kQmE94G)>(*8QL|f zSwZKy1Fs*wEqfc80TqKoC^$#F{2&M_$kqDI7G5?s`m0Df3O2Fvcx;g6T;Zw#F={4p zrhJJIyuch#*y)TZ>>9XnWqhLrD;Y82mZgt7z#>x|la`!-sTT4FQyp0s$h*c{&8>N9qEQ+prt=#y+L zK9kG4`5nzwDmGbgLFAK2m9+(M2PP}bYXkg8*l}+g8=ERGJk&>>H5Y}&VwI7DOs3Y# zVpsR3WIOabpl$Acg7-SkedWobEu9@2x+mhj<>3o~P*X9`aY7Mvwb1IkW?OUYKv_l3 zBg5E~BbA%cY*NLMtK{5`U4YQmU9Bz~?SV5A%})wsT78@%dFn#Kp;+-K~C z6*$Ui7ws=dehV4$SU}C)|IewZROh5RDujSagMVPOM~*OXt{v$9B!fDK+*6e-%DH}+ zq2B4h7$Kv-$ZGtO^FZskrs**TFex%fkR-x=sp65!>!ba0L`u^wuckR&ibH}wd35*E zan9!}ed^{MK6N9~PaE`L*Wkh9+spG9MEO-o*}E5rm5&rFWafL2Ax2tA5n4yZP^_Ks z(oAuS4^gj?%)+yJijyDHjCHSCC>#jH2((~J?EI#ffTjz14Atk){U|zvP`enRrs3oo z;O4BA@8)pB_f9d#^<#;Rs&%IYJA5$_9jsUd6ab|R+J>bp}&Fz@r!kDG4#HLvcMEyji@F|?J;JeQJq3N&!a!{q=gvDe} z*T>aS4+c>Dh^sy7X!V_Gsui1(F_X$7d~Vz%{&BcEPp#%X`Prob|m^G3MaUTssAm(KUt2y#jcJ`$dKS=rJzNre6 zE5SEN{dE_Ejb9&TP&X)+-9C^M#=cS-%I_+R-0#CF(jfD;1vAwYX)5!$oMMXo*F&;9 z+V<1LqL9^=@e%E9Yez+#74mt{HFCSg6hGo{qS-C|!3J zVRtX1>)Ca0xNm9H;a<+7%+@Gs3!ReWrA6Za*osdwun{p|6E{D6B@ON$cJrKxd|>eT zkl^c!42DoR1-0TxIZ=yusl4GhW#=%vPGk<(IG(qoF6%XgtLB`v;W2tS22Q)=wWymA zd98|jig!|#H*4lm`)ylJesh0mHUXM=A`g#LE=n*6hIbItXi0tI=Z>APy@D_**Afy& zlB#*$-nq6aL_3Y2Tb4YFX2;b@q1iPAn!Le%K__(G7dM45vt{_Y+R9Nv8Rdhk$2i3+ ztY2Sjx4R!PEHZ|dnX5a_|3e(hz!@`r@(erTG2K;=k38o8W7o?2!jMp(N&ABW5C+Z< zIXPlS8{rf}!t;Z5S2Re2udq-bqofGl!wJY)`XTrr~R26z|{tCv$ zOS7Y_Tr0-BvAwcu(H>ff+wqTk*dG7kl#W(bLVY^;9@QBlU!hQ)RPRT-P%;eoKFRJ_SfCa3BV!Plu}qksTFu z$```%@)W0bew~ObKC8~@blveeJ7!|F(C04eWmWyE8%rq8={>&0%V~N>NxJb#5-B)W z9w0X!skj%pm!t$9{niqY&rLG@j{j#mwXO55Tm|pEs*z!gK`c`te2$C)x>QkSY3BAjJS82{G zv|pK4*POXWabP=E0Pq<4?%AW;Vas18lcNE55ivLy-73QmP7^)iaaAUwbzp$S-V^Qf z8c#~4c~*O$v{6oJHNF8jO%|BxCAF@Z+wYaE;dilb>gV2(j{weCoSRG5G(MRk) zOYKx)=fo_fv|wo6dtb^3zU^2Ccnx|6_LGx0*?0S&VcJ5hF0!hDRS_w36_Ua!+xqPr zeFQM>gJN97-W+GjW1MtjwI;n3`!qMLF?%=d;rhl^_%EFY$hO&qmO(p%Lj1`Auf;_c zuniHP_Kh9iU%`2IUk2vzsXi%pTEF;#uZ<*v7)o_*46+!GH*?dswvI3jF1skLN99vf8jnuLJ6C_WXb^A9x76&{#Me-^gqAWE? z-S1w3dug0Wt&Ua`#Br9>;*sbk4n5@3qHvh;K>A_r%I|MCS=vQYr>z-}Y+9FIJgKqx zq@u!ZiD`ou1YMvbn~pQkpKkBP*YkgS;^8{h8(x4~DCYeN#4&NFnc0y+5Y?+NO+QEk zw*Q{uvVw;1%;I;^@{b(XDEF==d=Ly3F)W{3IGt}@&0&e3vNUP*vnIR;SNP^jYj!z3 z0ns3s^1GnV^yUIHr*>joiXVllj!gPto=^n=3aU3;(R1I&8{c zTU&MK*Gn9F*zeR|^KLz};mX?+xCH0(Makb_3ydYa5o5 z7($`LHE7J&ss6jP3}@Wz11=U1&i9zeixM*P1=?^v3&dRS ztc!i&C2gzSrcwmUt<_(FMDU5<0|{?VViugj+shkHv7oM{HBAS1c6M%}q)xF_R0S5} z;Y*SGcG!I8+B`oEvwdFHX^PN+3kpRUd!L#q?}YmEl+>IjjRGJ81F=JEJ>J?0gCd~) zHigr3ZY{P+z!UR;z|?*yM>3_*74LpqgpQlo9Uqa*a4GN!)F<<(Sg*uoUkpbK^$6OT zl%5kgE)oZY&si!5KS0VPr6mQ@=H8LXg;SIi8C_$3OU-bGI3l88$JR1!`IG|z#n|EW zv0~X6SAxJ>!O!LuPkpAeS6EiQZcN^}D3 zEFGM}(8Dd)MfTYKVCwnwf++3-B5>CoXH8cMg^ym>LK>|LVyMgZMaHh9LHlv<-7XXr zpU03V>uOs{Yo%H2$9UlfFFL;$c(H2id)>)jl}F?K99$!1t(#(_@b&vsA%xK_Q({?N zoPEQ<=ksA3Qo!x18w39LBzK~Ab{pz4- zsh$Rxjf(mG)I8M;C8^gAk%rPkTVI|=VSkRi##?PNEf*MW@||-9dlpDZL30@n?%uKA z2BV?yS6)D@HbaY>VR>~GXe96>a>XwwGk=hLo9&1dOg|!QSe}9!jkZWu7nzux=GxAm z;1DZoXpgK(yH+#=R_br5dk5iMGqyheP*SBQ4rYk0>K;B z{(IxT>qmSWEejqVyKknmRr`aA;qZl@T+UO^#$W8S^oy&faiZv6KTKP>`7w+4!Z?ui z#s$A14s2YuCyk^Z%<~LSzZ@@o4o*QpH+LaC2UBaO5h9e~EAE1EP_V1<3s(K1k{KY6 z$=(Au4wA@sh`L$f{RrU;VRz*-bwAsk;aIqb`nYz{A{D@o(00$WXx>UxKM(U?!2=PT zoegou=yy;0wkA0uf-x6+0Wmn>WoXC>2splwd}|-qkTOnL71y7tt>B7+?SSDUxREb5 z4V7C3gVCqX#n7jcJVC-C?FXUE5bU5$%A-6o;x*#f<-krYLVbwtsPvin1IYtZ0iJSD8FhQMW?S83XM3fRQYDS;^ZSdv z!AOFJFy#XoR#NoYP@nU}*r&|Byn14oRONG|Q9}LwGOSbFca8OS!yg8Qs6DyTLT~TD z1AQS3EOxdE*$=(Lwm`$K7wxk1>HuqR&xICk`c5ovEwckv2`34R+WguwRllcV^3P#n zVq!*>?ns$*T5Zsvh~q*S-Tlm_g?u#}V2?D~8rT=g=6gz4RbAJtD-hHR$?3Ka08#uY znv6-JmTNzz)VpN+Dk}xg99-kCuDH4J+5hMY2(R2A2cyoWoF<<wvx1Lb&TS_xR2G;A7ZHgQbLr?z7T8F?2Wsu@qMD?o}p&SwA28zW>PfE z9b8-jZ0tDak220dsLu=+P7IN2B&UKa$>weR5iPy)Gr9NN@;+*YV8pnZInX%m{qj&sHI{C}RC=cV)c8budk@0(Ll5+YiFPP8T~%d-yON=SepG zBAbk~4KX{OjpF|5^g*qmF?jHLrZnb4B_Ztyy~lVNmSvqJamoX;V_p8SRSdZq zAVH@%>5@-zB9kd8DFHwY!~@791<2CTMHM;SsCA9U9$)=AVmL--R6WVHqH4#h%j z{yIpj+dDeQ?tdH00*{l!0bp7O4{2Wgxogxgh7BJGwPLbbAR7`2_w+0W&;0%F+n)iT zBl^!N3&I*AtENtr4D%sWbagHLsXpv_+wI?iP*)xL!)I|4Joi)gZ8DsuI!6Wusp(>l zQTO!rP9EJcOnY{Q2#`DqyVL$m|3hpG-$4a-ut@SNQZYRK4n6bxr2b1F2;|XrUJ+=S zlV@dTHMH+4YwnJw<o~GA*lag5eWgRmA-+u8Q3vTpJ!1&g! zTUF%f*q!L<>G?0ORQ&mmvHgoN-GNBSoBP*tKMT)>2vTBq2jOAfnH%6`WI#sEDGL?s zWj%TFukmdki(jAYdfbPgT+qJpWEY6MmA9+_J}KY_84~h?EG`WWLgBu2KXct7J12st z$1prilk@%Qua_{bb z-UfrLgJOLA>h==1S^4;SQo^E7STh$8(@Kyji?A4xcPE0~=iNz^o$1Dw|Kh>qTl==mi9sI z%ON+U9Y0nyWRS*Y4TeRwKC<2J7qAT}HEYl;=3!;4x&y?S`Y?&;{+6@2@`?coY)$w`YlBVp#A60fM z!``7tc-vFljo1%iti)wU&y5MtR_O%mpdmVxU3VW?f@u@S4iESEC-PnSf8pz(s2W?at%(H;C&4zPBIN1_c&-6VOfWFEHP5K}5CQeO_U8 zqLtfr0PI6DN?85lkAoFf1Z#!*tSRbj`W&F1nwq*Njo=5cK_PEt`|Z@q8N20*`I3wN z^9GNSBwXj-fGUZW^QFF5Vab-Hpq;Fbd_ZK4kgvo|O1`?|b&TEp%xQsVcdO2imi#zv zSYh0UoAcgG8YX;Q)W6NjiAY{QREIZBpZQ_>m*w8JsI^D_A9nY(HZ4O_PZG;ZTwCEK z=HoF17cD1rN?S%d61x5@O8`T$xlVtEb3VlrzfoU|eP^f?Izc?6gnR|Saz*K#g2;AS zd{~?Mw?lDHfKNA#~NUAAsy1(n!JJ*^xu-dRERJO5y5U6Mq*VsC*&E zcy%mH9;LtbEv>q`CqDms@U+_V@63LXl8#slLWTOum#4&bL(OyP0B=bzZN_XZod_^= zo{PG_^0bE9qO+8;8h+ec~lV zso}!r@ry~H*m4#m3RpFsFpX!#)wUxKQ2P=TzaA=@z#D25)Ge%VD>zSBetnKA`Lyp^ z&I1;Vt83is6=Torx+31go=Bsk$#wX`5TX7XAP?U6?>^H|H@bm0-jrHG+r|n@Ef-COvUI0ZfdGJK#a82!^4zjpm|*qH zEKC2{*ZWer52(6fC*4X;7)I2+DR=fH#p74CdhH7>NK0zhj&oA23WYy&UW!eT-mnk5 zF&lU2fd#f4*4cZpeu*E`U{AZ;9UzF{@4>tipX3-WcPZ=gJ;vwm4{x$(kg@YFf7@v0 z?wQO^{d~<$lmVzp?;zR$;$UO*4bSG>U0Q%`sSwNeQzvXxLxArwx_K4C%*-sn${DjU zcYI}|Q+TEItN6;N@lzHWs}D6?f4c6%)zHfkNB|(WuKe`UN;{u^J{% zmZa;ZpVltNWZzU*Sbg^))-qyQAa)S;P_)q!35^jgXcR(AKMg$0Ai0!lkE{}W=4zE? z53*^loJq_3s;l$8%1n$&on6A`QhH}Fq9nf)%dWAnqP$rFQX(%?1=^g?jhqdH3UU>L zxays+kBe-lijU%_xH=^b&0b3H(E$?*?DGAM1+A(2HXXU%PGY3RL6A&6pxsh5Bv<1? zj%~y$Z$vNH>fB}xf>tA7jIMHSs_qSnL~K!4a{KtZApflL*SG+}OcS2{#W>jZw-`q| zp+0?P8v5wB7MN83Wub6xkl)9uvx}E59^?3OFMx4`crqOd@6KyRVMeMHyw#sfkDbCN zY_|JJ$P8cfFrryfKg0E(bwm9RupNlj7}*hnO1RXqjDfAaw8`r1$R&FxlSyON_pBnJ zQu$6fz=?L`gd1r7#jf2K(5@c>KERld1$Ov7#fn zx275`k0v=~#YlTyQc!M%eQcF}Xt-p8S|{|COYlG=HU`ou>z(!wfb{d@=$&+sCQm@+->13)!}c++WfU3ChJS;>FYFLBw%Q!fAPW7kTC!}BLN>1wc>*NpFV z8!UPiVce;O5&Uf!SyI-UMac*x#*DG$6_^gbxZ)1>IxjOX9MZMcBP`VMY8MN zM&5xg{~u`H28-48`;oVY;tt2JR!a|;QXc&mCEn@QPLr!~t^avF0MFOh1pMyz+X`iLNn z0`{Uc#E?Pz@_DNhY?r4}?nL4!HS5#9iI1`&Jf$sF)Q|q8ino{qxc4 z7^GP7W_$&?o)%|kz1SBtq~4iMo-JLj`;uPCOU}KIDi;etxw?%H$MUV<$o3}uf|984 zNUb~0_{h4W75@$E847Z^2$E{}ryFzDVPirKfCn&KjF$JV4piAsof!!Q9`4oGBi`x2 z2MTuonm+!4Kc{a_%n#zT2JDw&vQGG`)Ks%i5NeM+-2K8M``$&hceljWjn|rFB+6e5 zPEO_N&$hv@FpXy&JIL_dlENk;Ya5oHZ|^U_pJc=dKI0=9M8%|YO?j{N%|GsaR*+rg zqt0j-*ADZlwWpZN;?wilJH0U8#W^|bbH0M#y50KL(OAYdpRWlYn}K7uWbbyF6hb+cQ5U;-inAU>4|f62V_9f{3Zjh?qB~}mNi`uY&&YXRd-Yxw##lJ{ z2Eea^&$kNz;J3NtzOKeWwMTr9y!{XEB;63|+P!~-f2TJ9hS`n-c46h_b>D#j178TX z)onK5$iB=b?vIHPt&h)Cf)v41X@Q{WSutVtTsq0H7qJ6Y-<}{S2XL*VHn9%m58`o0 zv?%y5(v5VPq*+tyN8n9PBov(zca^?4cw@6}z*&PyJL%<=R%cZeqBr5ZAeX(#RTQY5 zczu+?8S|M;d1eLXdly4K@7=n8x{$fOP1pr73WyH5%&nja6SlO8(QRMjX z3&+T2Af^{qKjO)cd2fzkNX99l!sb`XJ1v@3N3ZLK4ElJODTR5+`*vIGC1>>HBO6Td z#{%EkC@Cq~OYHZ9sCriQczJun;1psOy86A0R($7+5_Mm^$iXOiIX^G;nnulTBZ&D2UwTO9isxGrgL;PFL62O3D-YMhKt;ZimkEw1yQ&368Ln)5^YbNrPB z+epQ)#JDd-1GbZ|SB8Pa|D@R)En?CA34ULH>RTpRZ8+Z9aMCg{4%M)_$Cr`=?EW#K za11oYy&D@=T1X+zm^9}{&IG3L0@E znM&H(3WJ$fOuw9B#HohJY?X0%yFA*+jxAexhc<8Y`G{1UV$J;8UYC3)X~O-zo9=z` z<)8hw8Dxq~qIe?R?c~t~>q9G$4;wQ%XUYlo59TDgMixL_BD)#XB>+HiUr?`zv|vT5 z?9G8q#>rgj8*;7m-iXA!z#E?;PtTA#@6bra``SFlUTkOGVsz6oA+8gH8W~*A1=k(| zzp-!c(=pg+VMv_)D!-a*wP_>%(X-8-f*UCABh?OJc#yfT$m(gum{CW`YcoP2J-dsA zT7K6az+EM8B)JqW={~bVhhuta(D?%0PUv|D)B1BO?@N7LZ9rb8@u*t0*7L(Az+Bs} z9U2aC2LkZ^J%S<6tnF9aevXM*UF7FZ7wTs4 zcSkrdgDoMm7RWZj79$g?v<&sR{1d07sxzoZ)M`ntd!kUf_&DM?*J#?_BHpuqSsy`O z1;vgC9Kc_kl|Hg4bk%v!H_ah!gzVBUC~Oihx?92bKe%>ZN_2J~h!ej`&|4(_aDm^XM45qS)q6m0!RV}_#??q9JIZ+Bl zak;LE&N(Yhoe*)mHO1Ex{-#KA9%b#LxDjt%Y&msh!NSbo4x;z4Bl6Xn!#!EA6jh0V z(tG{fu{>mVnvDCdVCqk5f{yb6hZn@Kl4*Tz{G zXMnp9@)$hoRPVOfm0o%`8DlnbkU{cFKD4?Vc0?S({{q7~Tb*2jI(WWkY%R`&z@*=C zAVq0mz{xm0&&0nkgSfPq&`P?Re5KUGsTE@)oczq6qt9<|%Da1VfaaHko3(oJHE!#1 z-4aiqxS`f}r1ur;%WN9Zgq{~TG@ACD!7q2lPWQW!_ePUJr7vb*r)Y%{Dq3160NEnq zqQ01he(y2IA;sqscd+kT3`)wIiU+W(=f!EqV{paEiw6IOK1>1{kVb~#md{A`*B$%3&^~``z z*VA){LzZs(*ft>X8`2(p@{f)NL5+cZVq)UoQ0518p?^@ZI4eO3EFQpva3!UXBlL*tzAY_4Ht6^F1m%y+ zT&|0|f03gD$HF;3O3R6WvQRU`-1P;_#ee$lm_{*xosZ+n26Vu46z z5Q9>ivNG+CdEcQ`k}-64#2(E*j=A}~0uriHSp=wN7mrc9xx4=_C5Y!RE-o%3@}!h+ zR#ZsuywVq!cp@Ih8h*0x+BRNKUU|mTe=Oj?1v`Jv2&g@M`5z02ceb%4h|HSL%eif5; z|DOM!2VQa$;7NVp`mbUr*f!U$?Msx|c~5dy{nuLf9R8H|`^pcG0{Z}!R?{TYkxENJ zw+?yTzZfA0Q@`tW!1~?w`$Y=%`$>KK3)$xaCEDnKG9h`?+eW+!@kgnjqZ-tts+KQ5 zIY~jy(B9R>#J*j8gU{@z_FC(8TEWgu6-nxxzH5&9=y<*&QndWf%a=zP2Tj*gCOZU<{Q4bxy;J^R)@qvMnk-VKwg8MKG`fVb0 z;y#F`jGd08=0wcHQoubo|1lAChyNYV{IdpVoS)1UL2_==9aei*BN950RN)n=qMkLU zli%UA*)HNP=K-s!sj=AFAdn|6_y)2nJvu6KIvqk-0mZdna}TGWGNrS9ck$V8H7Hm+ znK;7b%}-_+#=M||%gf7?sX-u}1bh*RspV*9mWobGvGx(?BJl&X+g=kiMZCd;PDA1A zX`FwT7l9?9VE$tKN4c*7ca(E}jBNka)ZSi$sD{5PD6j`9!F>f^Bcz?rsWUNoXRjYi zw$=D9-7gRJ7`*)e^#ImOoswEGX!p?PsonE;my=nzIFG)g-?dhQkUzG_q?Zta zE)c6lE@%N8;^uZv4{5YmrrW-x3nIpg!|jKX%|2*!*J+GCQ6MjiVhpr;>dR*d#C+%2 z@b1m`k9wjX=)Lw?2k>mBK^mg9xAzL0A7o(J%c5dxmX&<=q5ofRR~`>#*Z!-KrEDoZ z_L)i>6)pBGBiV{163P}OYnH)ato6`>sc2CcBr=#}->IzG8T%F?Gq&u;GQV@rv_H@L ze%`-+f8NG@pL3maE#GT9XC#o}PNl9ZcAziOxb*?!uUqhEB~<2;i?j2l1v!vf?w%r( zpJPF3xazcavw0S%v9~{YDdpN!ZRTy3w&5MO52-hHbXecoTzF7Hp^uqsDPL7MW-GLc zpvXKp8ci??V)2=){8&+9YIG@4(oVj9K!_&OQ0(Vv#~+K^G}usA$JPNX0hR=719xGp z?6<_?mPsfg@MxS0LFHh+%O^&`eb&XEhlRn#4j)wZ91u5>IB|m3bpuLg^2*CNe7n!Ks&)>+Ul6o3U}J2P;`-D~gMYn+Gx!ceuYb zVq(!fLsI4vo@O%U2U6L9C=(T}arGGRJv*isR$`bKZLC9Rvya^k`5ur`0mKaagP14a z;}#H>VPyF{T2_V(U@);Ray!Mu@~tI?vjrK@8fPiEd#SzOHK`}rV<;CbAL#YXBtVTx ze*YD1Zxf!@c0Wg8=Q^Z$63WvdLB(O)UcqK$fQ;ywd8c1@IN*;y9{4#(b{D}ly+@c& zs5dq?ihrVbXQfWas=q11y?~hcDLYqT$yyRS*LdAI4r%o_o*y^S3g|XRII%M9{-&A1 zeMNsLLB+mxfPn{(Tg@{8zZj3dR}Jn?Y4lnwhul#ta7T|r%&~o+I`;gF9pHkIz7^j% zC^y1g;>!l}|3SK$#UClhe^%7rLk8r&)10sBDiRsiOSM@}zA(=wA5`p*M1htkiR%WB z*|$|mXvYRFkb9F;UTcw|1_&|;csa=VB;Y~K7cwB2gR3wn6-#p<>6_^H;Ll0ZC{Uwr{0Sn_F0Pqy%jV?w}dDo$Lt^@%F2?L`~n#iSBTWNn_0Nn zQ>+l2KP=GMLw}$P^%;Oha#!}A;G|U=b0NeL0)*%!#L&mi9+IX_#J^x@e~kaX9G zDsk4DU*Nd^u}FPy@Z-ljA;Vh%%+#D55mb=JOctf#x2-x%J_Dp543g?d-sZhjeUfqG zHoByMDC~!=+x`%h2cO-yaCyu^9P|2h)2>ZGfpvEB&Vs}4p(^2kCPtbO7DRAD<~)MV zIH?@h#yHE|i&yORdmok|5I+Tx=YNKlA8umJY!^0W9XxDMK5UgVKEq(_hrlAr#C+uq zft1>tly3O#yT2ole_&5tix@Cnz~1SC!ptgQ6R0yqzPi3t4&TH{%GX7Gl<`iO-wzf? zEd0-)bcyYUJ>IP@9{UG&i7x}q$x3T|z)K+L34fWGpjY0}X7Xb+0JwjjJPt$)h=nr)NFO88+5N-oawM}u3H=D5hnO_Whuukr@*ZOqra_wN8+ zd>s2p7&q;YoRgvZkO3Wmh>iBNuIUX*bEmKfO*0(*$s#=-+!C<>jOcUvH#pb8>s&lZ zv?sqyY5@rx4TUWz2xZ`L=hWKBtpQZddlG_C42WWx^2N#zngD;^z@%o z!TNK#45+v!kY5dler_jtjbzB3ZO2WjuWYi$x%AGpuU{1i0Qc0D#FCAFBk zc`Vh6Lnyj+RITQI@@CLJV>A2dLUwWb9Qyrc(CaDa~<&Brt7MF!qY*#xh0OBp>KNSexJG}R;flZayykv03=c& z&}|BU7~h8)y!=$UgmTfTF?B|^xB{*H6vptQ>Sao_yJ(d>AdY{*Vt^fp-fJAvj+q{c zGB0ok0-!+^pwWh)+{r^A9jSilZ(wdPuLS%j!lMg{} z0aAN?-?JNAx2JqOxMgV`2-uDOceet~i~d;NXW*I+9mnRL0H`RNh6g~R)Gk3V;cgk= z+55f(8F2xWW3i`}=^mK$&_)>dr@bq|wzmVngdSY8acA^J&{w+`TJ5v5L~?#jbOfk9 z&QFe3r{LGE0oL*YexyEXv4@>pv|Sjd^+$S0cP=0T_wkB;xg)MMSuETr*XVVOf8u zg47Am6)I?Vt{=?;2@Jk9Su@5_Er8m2pQo>BFs2-0o& z#`6@fGm|pstppws1^12M?xxg=6GRoJy7*$h<^80Oz<0p7ud4O?>9&mI*6iQ;_-hbN z-y<$VI;E@yBn~Iz(`rTLJfrl4#6>6b95?c4|6|Cu=1~6wu}MZ=iJ1HbH;40sySi=9 zaBrHutUsIJw2b3P;xS%;yF}>rJS>INRKDL$)Cq8l^Em+A+t=|L=S)lb*3X3-c!6ek zV1wE~}bE+B;^ zTKhe{uE4nAc7wk%Y(Qc*F>9@FA;39o7Nk1tN3vZpTGwu@J?(@4F6w8&U3j2(z72K& z;62Y5gux@s{5lztxOX(m6J$fSz<}x^jSu6q@1mVUyuJ*q=^2#Ek2O3#ku96-s?Hv!08V!Ng$03qb;Kq! zv>oQ`$pY;xY`1K~ZzBVp>|6NzeR2IfNgnoN?W+kiwqd>iY1#e2&uf#C*t^yadPdP6 zsk_j=q%ktb$F<)$y8#6M?W94FTs>l=W0k@q4xhr7t2eLBuMd&PPLud!K(Y2v+mTms zgY`ia;zajqI(-N=+7P;I4F(7^0O1K3<3)wT0FczoHPF=X1~Xw$n}B?CnOvL@8si{Y zqgu0*>A?oTn+;u2H9Se28ocHG^#Xbgh2?NI=#zdrZqU-JiI9j{SI+OR&rFJ+*CMS( z*e2)rA_k{`Yx4^ifjUbT$Zi%DX%@|twR^sKw}UpVTWLQ)&G&i4!2=l1Z-Q|TRi+9h z)aM+~*L&UC#8rHc_Wv})PDeREL@o${3@@cC{S6;1Ado@BBy_3};Ic(d&?iBEO78%w zgwqS!C)(#W1pCluMtf2^1X1)s2pH|{^q;@ah4#dG50c1qCcv;X{IkLD%m2gB=|no7 z6Ra}_aYbluKLG^|9yTJf>GQ$G%dma}aX-bEMjqdXi*(HBdLjrc2aWz8s*;8Sk%1jH zG@AWFN5sDY#h-SPwuIK4#&lfT*d*}xzu-QAHQ6li^mUbud=IcG4UGQ2O*o`o77c(Z zsk!icTg;yrg@$KO1gA=dm=?E@MJ5~3rxK0x=f0AqKzYqoVtt^!^V;28e5a(mD7#m} zY7g{{UTSeKIwMg&CE=Pk{dD58i&3)Es zIvLrCcq?8t-XvVzo9ShL7t)kapSiV5#SKj1r+1(#yP9KGu&7#1?2D}tq38Y=#bfd4 zn5%X3Es4Yh>iXeRYU?xM6PJ4gsc{Wu9fK2{@Tlb!g+9Z&9dep2%-Sj{04#I~Tk_FWkS-Ak1pU{vtTdRmPoU z8KJ6tJ`1Wy@16(UlIFMoN!}zgT!8-;nqz=CO9QUzxxHOdC|wJukRV4;E^OMLJU;Z@ zn7>$;S#zN?3jmSe{PUcdluExl7qGbbF1D+vzgsqdI9rz`{gX6j#BUlhEz(yRe*|JR zlR0wtfEaC+Z@3BW?Z}qx{0)w3b9BH3j)gZ}bQXps=pFbAal}$~F%=q-u(+3r6^hB4SS$`Q-C^_`u^iWo)p2-Zw z$8uFl!8f<=LZY0qtWHx;PfGF9;MUaU=H@EFBpy%BCtE|4C?RCxolddW7aR-I>L)s4 z9Zc-LcCTk8Z_zLEye%uUsINc0YN}uTZgcW_MqLGFIX)-jLYCz#e55`c|IV=CbzJ*M zQa)Qu62I1{00I7GLjOtFPM!&Fs(o~m$#CfPl6qD$%*l8dP zqBO~;O~c1*d$K&#^7wdoGSS!44xOmStfb2)C$^(+w^UO^DH4P1Q5<7Rr@g%kBcWc^ zLiFrzXWXEhS3!*zi3Jl?5ZR(z#O|=8?%4!!zm1~Fm#p41=pemS>LQHL_xIuFtD6xoJ*=7O)X4Ur}K}#U{YgTq3D&boGHvc2-|DQF?SrY2jXQkD9r-u zr_H|P8Hq05-b#ZEf0Bvp0EIpkU!lOA{{z~|C4l*kb1{jez_vU;c35y}3`)dzKAcJejk9ipjBGNI`1ObpOjo1i2;N8`&7g_UT?v8 zF@JA`nd+2*sZ8-JnK#a6Bu5Opp59?SWdh=my}WN;`=!azDxswgJXkzuSz(I7!VQ%pR~%k@fOooLyu=;HP7 z9xzQ`(JkoHOG9$8h!iC4KoS23&8qD}7T@?#H4udxv{=!aZ<^Fxn`)Qj=7(+7UL8rj zJQN9UIExYxc=Pyp&kHN+5CXru*2P|Mp?{CzX7lKb$r2us3TK?f%Rv4%Zl+M*7`O51 z$od8f!E}tsj$EtDC>*)n8jdZ38=?m6Q9&r2GULf{4htO)=PD6K(LCR$HUdvJ@-HG0 zu^F+*lF7V=oUbMIfW+-d0MwQ8vT&(O1OOe6KaAdMGo(}Eworf87-4or`+-5p9LtMM z%v-m!v(Im4{1GOB>848wUv40B7f_z*|SM#Q|GUfFV&VMkRjTveKQT)6hi z<7SdWzD7tVew!dxYtXM@Ubz*u3qFloAVpjK_N8xjx2PD)m!$Tv9JBO~Z(} z?qTOpZRp8}j!vEHtY@WBJqhCjso9boVc|vs8kNNdWzLsmr>I~fwkPIbUPUgH^UHoE z*Y(Z@sUI&bR2@5#CLfh&95N)*Jb zwyV7>EyYoMU+w21d?n?7TDz2RIc{|YSde|=@aB(dTV2&I`v|eYii(osQ}iMZ`=~wP z-%&l_FE>)EI`g?8&}Pq?qR*?vQ{xlkbJC_6*CP7;@5aew2$~jn4m%rkmivEtd#_Di zB*AVsAf>S>QyGi!$oKL@^}C%PjKvkU*)YDt#NGMT9hRlFI0o*G;T&T zj3Iyow`9B(E^fYN+D#Au@OhlS`bFv7JzipwqQa^*GeyMwkUbGk<{Gp`g_Tc(svA#o zYEI_DR6qQDOl94@!})uBd`3gDMU$l=4)Wp%ufIIK-4Czq)I`5idc)3l!mjhPM_tpi z28v)()%yHesELcB#^OqZ@5iqI^@M!9p6S@HkY!oTm3rpM5hxxSd>^RMfPvTc_U)LS ziOs`Ew4$Q!t0E8p{j^N|7L=rOA{|ev$RFJ9s+pHj8g>QMrWTi2pdKnKgsRm^yDuA!)?>%v@@K$xxL ziKvVS`#DLST@N1yU!3M~ z>yxqLPr~YRei9yJ68YO&E*vj6h(34HAtj)Zl|8whB%=S;toZ7)_pl4Tw&4Qf4o+;F zIQoiHja(MH7mm0JRC$nCy4S;C^751(uw$(d;=Q~0q~qkZF_rUbP7jVY?!JsCNYor; zl+}4KZ(5?8(;c)p7*3wKeztuy?QvI$m$TT2%#HWf?ViP{TEvtq_Jzd+e^#2$VnKkc z%cK9Ebe-(4k!Wj#g1b)MAofTCCrZV~$cfJ#@}f}mPq#cFz1FJkl5;Wk?3e_}vY!h` zv$cMAB#O6h*)6F)UEbu32@#u6Fabejd(}Cm+pIgZF)LVwl9F6vUsJ7PCfhM@fMP31 z%*%xNT!R1Ix$TFuZ5vi{-QrmFn2&LqPkcU;*e!d&Ovt73km!Mjn7^zxl#;dqP%fL@ ziHg-AWWQl&xWu%hhe_nfwU_9gNAp4{6Dxd4Z?dni<*e8+J=&_VV%J{nRkzgOW$&d$ zG2V7mSIA>vW4C+K%a^yPP>haq7o?4&LD`ULzh3sV9LNOMflUAE4N%T;AB)WWRmAB~ zjINf!DaEufl55XRkX)C&$ZLi*^OntIaY>u`StvXXy6C1&1F4%XY7?Al};y8a>vu4|wjH8)*l@?a9iaE!Sr*FDEZQ+rNM z=X{Yx9%Pc^D$^LGv%{bP+jXF|M~){0;XuXaIB}yI`LnTlO&AJN|97)YRMi@g$?g)Hi*Kw2eDqs7UOQ`c=~X|&S8Py200R`qBx1RFvqy7x=M7fz%QbQ@(}-<6 z)P)svW)`my?>LsKnOBD6;n9(b6yxzaUNdk@v4mAwT|+HT&G@w%90V98@Ct2&rt_}K zsPKrc8cB-aNo+RRCaB*QZ8$w8QPuB6R%&MtDuWa@PYERVQ|hOSe$RNy!4;E3u00rke(^y&m^K+bKh#Sr^Ibmx6%(~7~F2YOF0fvLNAy47K^W+ zRRzN+eRlmG@B%@lH5c4Bu>LJ*21R^S_vreZ*F18B5_gv1hK(_|*cJlgE?McFno~Nh zth@;hW~+1y^7p@orvAfMCcPxqr=Bzu4WvBL;@j_A3nVSAFP1otmr0{%EUzkW0<+nT z|0Na(wD$L~13gm-MW~MR9c4NIP(N6fV)ZQdzLD6oN?g>@u>1aZNkmaJ5BLb@L&z@B zlBkeYWdDvQ|KCGcw1DFmYjzN$qvdRW4{ruC{Q!o1f literal 0 HcmV?d00001 diff --git a/content/codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests.md b/content/codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests.md index 7db94c139b..086c60f292 100644 --- a/content/codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests.md +++ b/content/codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests.md @@ -62,6 +62,8 @@ Using a codespace to work on a pull request gives you all the benefits of {% dat ![Screenshot of a comment being added, reading "Yes, I agree, this is clearer." The "Start Review" button is shown below the comment.](/assets/images/help/codespaces/start-review.png) +{% data reusables.codespaces.reviewing-a-pr %} + 1. When you are finished adding review comments, you can add a summary comment for your pull request review in the "{% data variables.product.prodname_dotcom %} Pull Request" side bar. You can then click **Comment and Submit**, or click the dropdown arrow and select **Approve and Submit** or **Request Changes and Submit**. ![Screenshot of the side bar showing the dropdown options "Comment and Submit," "Approve and Submit," and "Request Changes and Submit."](/assets/images/help/codespaces/submit-review.png) diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md index 5ff91023f2..6a1c1fb1d6 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md @@ -65,6 +65,8 @@ You can use [{% data variables.product.prodname_github_codespaces %}](/codespace ![Screenshot of a comment being added, reading "Yes, I agree, this is clearer." The "Start Review" button is shown below the comment.](/assets/images/help/codespaces/start-review.png) +{% data reusables.codespaces.reviewing-a-pr %} + 1. When you are finished adding review comments, from the Side Bar you can choose to either submit the comments, approve the changes, or request changes. ![Screenshot of the side bar showing the dropdown options "Comment and Submit," "Approve and Submit," and "Request Changes and Submit."](/assets/images/help/codespaces/submit-review.png) diff --git a/data/reusables/codespaces/reviewing-a-pr.md b/data/reusables/codespaces/reviewing-a-pr.md new file mode 100644 index 0000000000..af8077fe7f --- /dev/null +++ b/data/reusables/codespaces/reviewing-a-pr.md @@ -0,0 +1,7 @@ +1. Optionally, you can suggest a change that the author of the pull request can click to commit if they agree with your suggestion. To do this, click and hold the **+** sign next to the first line you want to suggest changing, then drag the **+** sign to the last line you want to suggest changing. Then click **Make a Suggestion** in the comment box that's displayed. + + The lines you selected are copied into the comment box, where you can edit them to suggest a change. You can add a comment above the line containing ```suggestion to explain your suggested change. + + Click **Add Comment** to add your suggestion to the pull request. + + ![Screenshot of a suggested change. The "Make a Suggestion" and "Add Comment" buttons are shown below the suggested change.](/assets/images/help/codespaces/review-suggestion.png) From efb518627671788673e14c562fd3105f47edbd05 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 25 Jan 2024 13:28:19 +0100 Subject: [PATCH 23/23] [Improvement]: Add Deploy Keys to Note mentioning things which requiring certificate authorities does not impact (#48824) --- data/reusables/organizations/require-ssh-cert.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/reusables/organizations/require-ssh-cert.md b/data/reusables/organizations/require-ssh-cert.md index ac90a5b86f..dcd2a4e3c9 100644 --- a/data/reusables/organizations/require-ssh-cert.md +++ b/data/reusables/organizations/require-ssh-cert.md @@ -1,7 +1,7 @@ -1. Optionally, to require members to use SSH certificates, select **Require SSH Certificates**, then click **Save**. +1. Optionally, to require members to use SSH certificates, select **Require SSH Certificates**, then click **Save**.

{% note %} - **Note:** When you require SSH certificates, the requirement does not apply to authorized {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %} {% ifversion ssh-cert-policy-allow-u2s-tokens %}(including user-to-server tokens){% endif %} or to {% data variables.product.prodname_dotcom %} features such as {% data variables.product.prodname_actions %}{% ifversion fpt or ghec %} and {% data variables.product.prodname_codespaces %}{% endif %}, which are trusted environments within the {% data variables.product.prodname_dotcom %} ecosystem. + **Note:** When you require SSH certificates, the requirement does not apply to authorized {% data variables.product.prodname_oauth_apps %} and {% data variables.product.prodname_github_apps %} {% ifversion ssh-cert-policy-allow-u2s-tokens %}(including user-to-server tokens){% endif %}, deploy keys, or to {% data variables.product.prodname_dotcom %} features such as {% data variables.product.prodname_actions %}{% ifversion fpt or ghec %} and {% data variables.product.prodname_codespaces %}{% endif %}, which are trusted environments within the {% data variables.product.prodname_dotcom %} ecosystem. {% endnote %}