diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md new file mode 100644 index 000000000000..0f8dc7babc65 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank-issue.md @@ -0,0 +1,10 @@ +--- +name: Blank issue +about: Blank issue for copying docs-content issues into for CCA +title: 'Copied from docs-content: ' +labels: '' +assignees: '' + +--- + + diff --git a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog.md b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog.md index df5d264bf35c..1c4315f1349b 100644 --- a/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog.md +++ b/content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog.md @@ -35,12 +35,7 @@ For an example {% data variables.product.prodname_actions %} workflow using the For example, you can set `iss` to `https://token.actions.githubusercontent.com`, and the `repository` to something like "octo-org/octo-repo"`. This will ensure only Actions workflows from the specified repository will have access to your JFrog platform. The following is an example Claims JSON when configuring identity mappings. - ```json copy - { - "iss": "https://token.actions.githubusercontent.com", - "repository": "octo-org/octo-repo" - } - ``` + {% data reusables.actions.jfrog-json-configuring-identity-mappings %} ## Adding the identity provider to JFrog diff --git a/content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md b/content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md index d50105b5a162..dc79ee71d462 100644 --- a/content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md +++ b/content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md @@ -17,8 +17,6 @@ shortTitle: Configure VNET ## Configuring VNET for {% data variables.product.prodname_dependabot_updates %} -{% data reusables.dependabot.vnet-support-private-preview-note %} - This article provides step-by-step instructions for running {% data variables.product.prodname_dependabot %} on {% data variables.product.company_short %}-hosted runners configured with VNET. The article explains: * How to create runner groups for your enterprise or organization with a VNET configuration. diff --git a/content/copilot/building-copilot-extensions/using-oidc-with-github-copilot-extensions.md b/content/copilot/building-copilot-extensions/using-oidc-with-github-copilot-extensions.md index a9f49478f8ae..0143155dea01 100644 --- a/content/copilot/building-copilot-extensions/using-oidc-with-github-copilot-extensions.md +++ b/content/copilot/building-copilot-extensions/using-oidc-with-github-copilot-extensions.md @@ -7,7 +7,7 @@ versions: feature: copilot-extensions topics: - Copilot -shortTitle: Using OIDC +shortTitle: Use OIDC type: how_to redirect_from: - /copilot/building-copilot-extensions/using-oidc-with-copilot-extensions diff --git a/content/copilot/copilot-chat-cookbook/refactoring-code/fixing-database-deadlocks-or-data-integrity-issues.md b/content/copilot/copilot-chat-cookbook/refactoring-code/fixing-database-deadlocks-or-data-integrity-issues.md index 795965710d60..d9b4afa8b5f1 100644 --- a/content/copilot/copilot-chat-cookbook/refactoring-code/fixing-database-deadlocks-or-data-integrity-issues.md +++ b/content/copilot/copilot-chat-cookbook/refactoring-code/fixing-database-deadlocks-or-data-integrity-issues.md @@ -1,6 +1,6 @@ --- title: 'Fixing database deadlocks or data integrity issues' -shortTitle: Fixing database deadlocks +shortTitle: Fix database deadlocks intro: '{% data variables.product.prodname_copilot_chat_short %} can help you avoid code that causes slow or blocked database operations, or tables with missing or incorrect data.' redirect_from: - /copilot/example-prompts-for-github-copilot-chat/refactoring-code/fixing-database-deadlocks-or-data-integrity-issues diff --git a/content/copilot/copilot-chat-cookbook/refactoring-code/translating-code-to-a-different-programming-language.md b/content/copilot/copilot-chat-cookbook/refactoring-code/translating-code-to-a-different-programming-language.md index 0fa2c24ba9f1..73e8c59a1d17 100644 --- a/content/copilot/copilot-chat-cookbook/refactoring-code/translating-code-to-a-different-programming-language.md +++ b/content/copilot/copilot-chat-cookbook/refactoring-code/translating-code-to-a-different-programming-language.md @@ -1,6 +1,6 @@ --- title: Translating code to a different programming language -shortTitle: Translating code +shortTitle: Translate code intro: '{% data variables.product.prodname_copilot_chat_short %} can help you rewrite code to perform the same operations but in a different programming language.' versions: feature: copilot diff --git a/content/copilot/copilot-chat-cookbook/security-analysis/finding-existing-vulnerabilities-in-code.md b/content/copilot/copilot-chat-cookbook/security-analysis/finding-existing-vulnerabilities-in-code.md index 267c534713d9..b840a15e52ec 100644 --- a/content/copilot/copilot-chat-cookbook/security-analysis/finding-existing-vulnerabilities-in-code.md +++ b/content/copilot/copilot-chat-cookbook/security-analysis/finding-existing-vulnerabilities-in-code.md @@ -1,6 +1,6 @@ --- title: 'Finding existing vulnerabilities in code' -shortTitle: Finding vulnerabilities +shortTitle: Find vulnerabilities intro: 'Copilot Chat can help find common vulnerabilities in your code and suggest fixes.' redirect_from: - /copilot/example-prompts-for-github-copilot-chat/security-analysis/finding-existing-vulnerabilities-in-code diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md index 3a621ca791ad..51be3c69716a 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md @@ -1,6 +1,6 @@ --- title: Granting access to Copilot for members of your organization -shortTitle: Granting access +shortTitle: Grant access intro: 'Grant access to {% data variables.product.prodname_copilot %} for some or all of the members of your organization.' permissions: 'Organization owners for organizations with a {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %} plan.' versions: diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md index a49b570034af..8a414a7cb20e 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md @@ -1,6 +1,6 @@ --- title: Revoking access to Copilot for members of your organization -shortTitle: Revoking access +shortTitle: Revoke access intro: 'Remove access to {% data variables.product.prodname_copilot %} for some or all of the members of your organization.' permissions: 'Organization owners for organizations with a {% ifversion ghec %}{% data variables.product.prodname_copilot_enterprise_short %} or{% endif %} {% data variables.product.prodname_copilot_business_short %} plan.' versions: diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization.md b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization.md index 17a7dd2ab886..ed7b684e147a 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization.md +++ b/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization.md @@ -19,7 +19,7 @@ redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization topics: - Copilot -shortTitle: Managing policies +shortTitle: Manage policies --- ## About policies for {% data variables.product.prodname_copilot %} diff --git a/content/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests.md b/content/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests.md index 153c8b0f06d7..6cc9b1b40c70 100644 --- a/content/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests.md +++ b/content/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests.md @@ -71,6 +71,8 @@ Each model has a premium request multiplier, based on its complexity and resourc > > * Users on {% data variables.product.prodname_copilot_free_short %}. To access more premium requests, upgrade to a paid plan. > * Users who subscribe, or have subscribed, to {% data variables.product.prodname_copilot_pro_short %} or {% data variables.product.prodname_copilot_pro_plus_short %} through {% data variables.product.prodname_mobile %} on iOS or Android. +> +> Budget setting for premium requests will be available starting **June 4, 2025**. If you use all of your premium requests, you can still use {% data variables.product.prodname_copilot_short %} with the base model for the rest of the month. If you need more premium requests, you can upgrade to a higher plan or set a spending limit for premium requests over your plan's allowance. Premium requests over the allowance are rejected unless you have set a budget. See [AUTOTITLE](/billing/managing-your-billing/preventing-overspending). diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat.md index 8e10188eafc9..1377f81ee9e4 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat.md +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat.md @@ -52,7 +52,7 @@ If you can't find {% data variables.product.prodname_copilot_chat_short %} in yo ### Troubleshooting authentication issues in {% data variables.product.prodname_vs %} -If you are experiencing authentication issues after installing the {% data variables.product.prodname_copilot_chat %} extension in {% data variables.product.prodname_vs %}, you can try the following steps to resolve the issue. +If you experience authentication issues when you try to use {% data variables.product.prodname_copilot_chat %}, you can try the following steps to resolve the issue. 1. Check that the {% data variables.product.prodname_dotcom %} ID you are signed into {% data variables.product.prodname_vs %} with is the same as the one you have been granted access to {% data variables.product.prodname_copilot_chat %} with. 1. Check whether your {% data variables.product.prodname_dotcom %} ID/credentials need refreshing in {% data variables.product.prodname_vs %}. For more information, see [Work with {% data variables.product.prodname_dotcom %} accounts in {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/ide/work-with-github-accounts?view=vs-2022) in the {% data variables.product.prodname_vs %} documentation. diff --git a/content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat.md b/content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat.md index 6487a2e8caa2..1eb3e200e9e9 100644 --- a/content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat.md +++ b/content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat.md @@ -70,8 +70,6 @@ These instructions are for {% data variables.product.prodname_copilot_short %} o {% vscode %} -Changing the model that's used by {% data variables.product.prodname_copilot_chat_short %} does not affect the model that's used for {% data variables.product.prodname_copilot_short %} code completion. See [AUTOTITLE](/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-code-completion). - > [!NOTE] > * Multiple model support in {% data variables.product.prodname_copilot_chat_short %} is in {% data variables.release-phases.public_preview %} and is subject to change. > * Support for GPT-4.5 is only available on {% data variables.product.prodname_copilot_pro_plus_short %}{% ifversion copilot-enterprise %} and {% data variables.product.prodname_copilot_enterprise_short %}{% endif %}. diff --git a/content/copilot/using-github-copilot/ai-models/using-claude-in-github-copilot.md b/content/copilot/using-github-copilot/ai-models/using-claude-in-github-copilot.md index 469169b58329..4797dbf9a98e 100644 --- a/content/copilot/using-github-copilot/ai-models/using-claude-in-github-copilot.md +++ b/content/copilot/using-github-copilot/ai-models/using-claude-in-github-copilot.md @@ -39,7 +39,7 @@ redirect_from: * {% data variables.product.prodname_copilot_chat_short %} in JetBrains * Immersive mode in {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.github %} -{% data variables.copilot.copilot_claude_opus %} is hosted by Anthropic PBC. {% data variables.copilot.copilot_claude_sonnet_40 %} is hosted by Anthropic 1P. {% data variables.copilot.copilot_claude_sonnet_37 %} is hosted by Amazon Web Services, Anthropic PBC, and Google Cloud Platform when used in {% data variables.product.prodname_copilot %}. {% data variables.copilot.copilot_claude_sonnet_35 %} is hosted exclusively by Amazon Web Services. {% data variables.product.github %} has provider agreements in place to ensure data is not used for training. Additional details for each provider are included below: +{% data variables.copilot.copilot_claude_opus %} and {% data variables.copilot.copilot_claude_sonnet_40 %} are hosted by Anthropic PBC and Google Cloud Platform. {% data variables.copilot.copilot_claude_sonnet_37 %} is hosted by Amazon Web Services, Anthropic PBC, and Google Cloud Platform. {% data variables.copilot.copilot_claude_sonnet_35 %} is hosted exclusively by Amazon Web Services. {% data variables.product.github %} has provider agreements in place to ensure data is not used for training. Additional details for each provider are included below: * Amazon Bedrock: Amazon makes the [following data commitments](https://docs.aws.amazon.com/bedrock/latest/userguide/data-protection.html): _Amazon Bedrock doesn't store or log your prompts and completions. Amazon Bedrock doesn't use your prompts and completions to train any AWS models and doesn't distribute them to third parties_. * Anthropic PBC: {% data variables.product.github %} maintains a [zero data retention agreement](https://privacy.anthropic.com/en/articles/8956058-i-have-a-zero-retention-agreement-with-anthropic-what-products-does-it-apply-to) with Anthropic. diff --git a/content/copilot/using-github-copilot/code-review/configuring-coding-guidelines.md b/content/copilot/using-github-copilot/code-review/configuring-coding-guidelines.md index 63e3b9fb0cf5..78d11315b548 100644 --- a/content/copilot/using-github-copilot/code-review/configuring-coding-guidelines.md +++ b/content/copilot/using-github-copilot/code-review/configuring-coding-guidelines.md @@ -1,6 +1,6 @@ --- title: Configuring coding guidelines for GitHub Copilot code review -shortTitle: Configuring coding guidelines +shortTitle: Configure coding guidelines intro: "Learn how to customize {% data variables.copilot.copilot_code-review_short %} with custom coding guidelines." allowTitleToDifferFromFilename: true versions: diff --git a/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md b/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md index 1760b5704b7d..668cb15cef9a 100644 --- a/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md +++ b/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md @@ -1,6 +1,6 @@ --- title: Using GitHub Copilot code review -shortTitle: Using code review +shortTitle: Use code review intro: "Learn how to request a code review from {% data variables.product.prodname_copilot %}." allowTitleToDifferFromFilename: true versions: diff --git a/content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md b/content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md index b326a243cec7..75074bc13c75 100644 --- a/content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md +++ b/content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md @@ -1,6 +1,6 @@ --- title: Asking Copilot to create a pull request -shortTitle: Creating a PR from chat +shortTitle: Create a PR from chat intro: 'You can use a {% data variables.product.prodname_copilot_chat_short %} prompt to ask {% data variables.product.prodname_copilot_short %} to create a pull request.' product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: diff --git a/content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md b/content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md index 6811ed235f01..bd1b5cd0a32c 100644 --- a/content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md +++ b/content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md @@ -1,6 +1,6 @@ --- title: Reviewing a pull request created by Copilot -shortTitle: Reviewing Copilot PRs +shortTitle: Review Copilot PRs intro: 'After {% data variables.product.prodname_copilot_short %} creates a pull request you should review it and comment on anything that needs changes.' product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: diff --git a/content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md b/content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md index 57f0a00b73e4..a4a0c8e3550e 100644 --- a/content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md +++ b/content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md @@ -1,6 +1,6 @@ --- title: Using the Copilot coding agent logs -shortTitle: Using the Copilot logs +shortTitle: Use the Copilot logs intro: "You can use the session logs to understand {% data variables.product.prodname_copilot_short %}'s approach" product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: diff --git a/content/copilot/using-github-copilot/copilot-chat/getting-started-with-prompts-for-copilot-chat.md b/content/copilot/using-github-copilot/copilot-chat/getting-started-with-prompts-for-copilot-chat.md index 07c88f8b7270..0cebd12a8774 100644 --- a/content/copilot/using-github-copilot/copilot-chat/getting-started-with-prompts-for-copilot-chat.md +++ b/content/copilot/using-github-copilot/copilot-chat/getting-started-with-prompts-for-copilot-chat.md @@ -9,7 +9,7 @@ versions: redirect_from: - /copilot/using-github-copilot/example-use-cases/example-prompts-for-copilot-chat - /copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat -shortTitle: Getting started with chat +shortTitle: Get started with chat --- You can ask {% data variables.product.prodname_copilot_chat_short %} specific questions about your project or general software questions. You can also ask {% data variables.product.prodname_copilot_chat_short %} to write code, fix errors, write tests, and document code. diff --git a/content/copilot/using-github-copilot/guides-on-using-github-copilot/upgrading-java-projects-with-github-copilot.md b/content/copilot/using-github-copilot/guides-on-using-github-copilot/upgrading-java-projects-with-github-copilot.md index 63c230fa07b9..5ea9d050f176 100644 --- a/content/copilot/using-github-copilot/guides-on-using-github-copilot/upgrading-java-projects-with-github-copilot.md +++ b/content/copilot/using-github-copilot/guides-on-using-github-copilot/upgrading-java-projects-with-github-copilot.md @@ -1,6 +1,6 @@ --- title: Upgrading Java projects with GitHub Copilot -shortTitle: Upgrading Java projects +shortTitle: Upgrade Java projects intro: 'You can use {% data variables.product.prodname_copilot %} to upgrade your Maven and Gradle Java applications.' versions: feature: copilot diff --git a/content/copilot/using-github-copilot/using-github-copilot-for-pull-requests/using-copilot-to-help-you-work-on-a-pull-request.md b/content/copilot/using-github-copilot/using-github-copilot-for-pull-requests/using-copilot-to-help-you-work-on-a-pull-request.md index 191596025b12..f1303ba57aa2 100644 --- a/content/copilot/using-github-copilot/using-github-copilot-for-pull-requests/using-copilot-to-help-you-work-on-a-pull-request.md +++ b/content/copilot/using-github-copilot/using-github-copilot-for-pull-requests/using-copilot-to-help-you-work-on-a-pull-request.md @@ -1,6 +1,6 @@ --- title: Using Copilot to help you work on a pull request -shortTitle: Working on a PR +shortTitle: Work on a PR intro: 'You can iterate, validate, and integrate suggested changes to code by using {% data variables.product.prodname_copilot_workspace %}.' product: '{% data reusables.gated-features.copilot-free-availability %}' versions: diff --git a/content/education/about-github-education/github-education-for-students/about-github-education-for-students.md b/content/education/about-github-education/github-education-for-students/about-github-education-for-students.md index 6345c5c56f5a..5d84db693205 100644 --- a/content/education/about-github-education/github-education-for-students/about-github-education-for-students.md +++ b/content/education/about-github-education/github-education-for-students/about-github-education-for-students.md @@ -38,7 +38,7 @@ Once you are a verified {% data variables.product.prodname_global_campus %} stud * Discover student-created repositories from {% data variables.product.prodname_community_exchange %}. For more information, see [AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-community-exchange). {% data variables.product.prodname_global_campus %} students also receive the following {% data variables.product.prodname_dotcom %} benefits. -* **{% data variables.product.prodname_copilot %}:** Verified students receive a free subscription for {% data variables.product.prodname_copilot %}. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer). +* **{% data variables.product.prodname_copilot %}:** Verified students receive a free subscription for {% data variables.product.prodname_copilot_pro %}. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer). * **{% data variables.product.prodname_github_codespaces %}:** {% data reusables.education.student-codespaces-benefit %} For more information on getting started with {% data variables.product.prodname_github_codespaces %}, see [AUTOTITLE](/codespaces/quickstart). > [!NOTE] diff --git a/content/education/about-github-education/github-education-for-teachers/about-github-education-for-teachers.md b/content/education/about-github-education/github-education-for-teachers/about-github-education-for-teachers.md index c1f617d4239b..e0af02f64cea 100644 --- a/content/education/about-github-education/github-education-for-teachers/about-github-education-for-teachers.md +++ b/content/education/about-github-education/github-education-for-teachers/about-github-education-for-teachers.md @@ -32,7 +32,7 @@ Before applying for an individual discount, check if your learning community is * Stay in the know on what the student community is interested in by rewatching recent [Campus TV](https://www.twitch.tv/githubeducation) episodes. Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. * Request a {% data variables.product.prodname_dotcom %} swag bag with educational materials and goodies for your students. -A free subscription for {% data variables.product.prodname_copilot %} is available to verified teachers with {% data variables.product.prodname_education %}. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer). +A free subscription for {% data variables.product.prodname_copilot_pro %} is available to verified teachers with {% data variables.product.prodname_education %}. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer). ## Further reading diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md index 7a12a921f5fc..cb71a2559493 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom.md @@ -32,6 +32,22 @@ To configure an LMS to connect to {% data variables.product.prodname_classroom % {% data reusables.classroom.supported-lmses %} +## Linking a Blackboard course with a classroom + +You can link your Blackboard course with a classroom in {% data variables.product.prodname_classroom %}. For more information about Blackboard, see the [Blackboard website](https://www.anthology.com/products/teaching-and-learning/learning-effectiveness/blackboard). + +An administrator needs to register your LMS instance with classroom before you can link an LMS course. For more information, see [AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom#configuring-blackboard-for-github-classroom). + +1. Sign into your **Blackboard** instance. +1. Select the Blackboard course or organization to integrate with {% data variables.product.prodname_classroom %}. +1. In the right sidebar on the course page, click **Books & Tools**, then click **GitHub Classroom**. Note that the name may be different if your LMS administrator named it something else when registering your LMS. +1. Click **{% data variables.product.prodname_classroom %}**. +1. In {% data variables.product.prodname_classroom %}, select a classroom to link with your LMS course. + + > [!NOTE] This step might give you an error message, "Unable to launch link. The Tool Provider has been disabled by the System Administrator: {% data variables.product.prodname_classroom %}". To resolve this error, ensure that the status of the “{% data variables.product.prodname_classroom %}” tool is set to `Approved`. In the "Admin Panel," click **LTI Tool Providers**. Hover on the name next to {% data variables.product.prodname_classroom %} and click **Approve**. + +Once your course is linked, you can import your roster from your LMS course to your classroom. For more information, see [Importing a roster from your LMS](#importing-a-roster-from-your-lms). + ## Linking a Canvas course with a classroom You can link your Canvas course with a classroom in {% data variables.product.prodname_classroom %}. For more information about Canvas, see the [Canvas website](https://www.instructure.com/canvas/). diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md index 6043154c9622..3776bbd78067 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/register-a-learning-management-system-with-github-classroom.md @@ -17,6 +17,78 @@ Before you can connect your LMS to a classroom, an administrator for your LMS in {% data reusables.classroom.supported-lmses %} +## Configuring Blackboard for {% data variables.product.prodname_classroom %} + +You can register your Blackboard installation with {% data variables.product.prodname_classroom %} to enable teachers to import roster data into their classrooms. For more information about Blackboard, see the [Blackboard website](https://www.anthology.com/products/teaching-and-learning/learning-effectiveness/blackboard). + +### Step 1. Register {% data variables.product.prodname_classroom %} Developer Keys in the Anthology Developer Portal + +1. Sign into the [Anthology Developer Portal](https://developer.anthology.com/). +1. Click on the **plus sign** in the [My Application](https://developer.anthology.com/portal/applications) page. +1. Click **Manual Registration** in the dropdown menu. +1. On the "Register a new application" configuration screen, set the fields to the following values. + + | Field in the new app configuration | Value or setting | + | :- | :- | + | **Application Name** | `GitHub Classroom`

You can use any name, it will be showed only to administrators. | + | **Description** | `Sync Blackboard course roster to GitHub Classroom` (or something similar) | + | **Domain(s)** | `classroom.github.com` | + | **Group** | Leave the default value or change it according to your institution needs. | + | **My Integration supports LTI 1.3** | Enable the flag.| + | **Login Initiation URL** | `https://classroom.github.com/lti1p3/openid-connect/auth` | + | **Tool Redirect URL(s)** | `https://classroom.github.com/lti1p3/openid-connect/redirect,https://classroom.github.com/context-link` | + | **Tool JWKS URL** | `https://classroom.github.com/.well-known/jwks.json` | + | **Signing Algorithm** dropdown | `RS256` | + | **Custom parameters** | Leave empty. | +1. Click **Register Application**. +1. The Developer Portal will show a screen that contains important information you'll need to input in the next steps of registering your instance in your Blackboard instance and in {% data variables.product.prodname_classroom %} below. Please note them in a safe place and click **Done**. +1. In the table on the "My Applications" page, in the row for the GitHub Classroom application, click on the three dots and then **Manage Placements** in the dropdown menu. +1. Click on the **plus sign**. +1. On the "Register a new placement" configuration screen, set the fields to the following values. + + | Field in the new placement configuration | Value or setting | + | :- | :- | + | **Placement Name** | `GitHub Classroom`

You can use any name, but if you set this to something else, be sure this is communicated to teachers. | + | **Description** | `Sync Blackboard course roster to GitHub Classroom` (or something similar) | + | **Type** dropdown | Course Tool | + | **Allow students access** | Don't enable the flag. | + | **Launch in new window** | Don't enable the flag, unless you want to offer that user experience. | + | **Target link URI** | `https://classroom.github.com/context-link` | + | **Icon URL** | Leave it empty or provide a static URL for the icon. If needed, later in Blackboard can be manually uploaded. | + | **Custom parameters** | Leave empty. | +1. Click **Register Placement**. + +### Step 2. Register {% data variables.product.prodname_classroom %} Developer Keys in Blackboard + +1. Sign into your **Blackboard** instance. +1. In the left sidebar on the home page, click **Admin**, then click **LTI Tool Providers**. +1. On the "LTI Tool Providers" page, click **Register LTI 1.3/Advantage Tool**. +1. Insert the **Client ID** / **Application ID** obtained from the Developer Portal and click **Submit**. +1. Blackboard will show all application data. In this page: + 1. Verify that **Tool Status** is `Approved`. + 1. Verify that **User Fields to be Sent** flags are enabled for "Role in Course", "Name", "Email Address". + 1. Verify that **Allow mark service access** radio button is set to "No". To enable this option, navigate to the LTI Tool Providers in the Admin Panel: + - Select Manage Global Properties + - Under Creation of Tool Provider Links, select radio button “Allow links to any tool provider, but require approval for each new provider” + 1. Verify that **Allow Membership Service Access** radio button is set to "Yes". +1. Click **Submit**. + +### Step 3. Register your developer keys with {% data variables.product.prodname_classroom %} + +1. Go to https://classroom.github.com/register-lms. +1. Fill in the following information: + + * Under "LMS Type", choose "Other" from the dropdown menu. + * "Issuer Identifier": `https://blackboard.com` + * "Domain": The base URL to your Blackboard instance + * "Client ID": The "Client ID" / "Application ID" obtained from the registration of the app in the Anthology Developer Portal. + * "OIDC Initiation URL": The "OIDC auth request endpoint" obtained from the registration of the app in the Anthology Developer Portal. + * "OAuth 2.0 Token Retrieval URL": The "Auth token endpoint" obtained from the registration of the app in the Anthology Developer Portal. + * "Key Set URL": The "Public keyset URL" obtained from the registration of the app in the Anthology Developer Portal. + +1. Click **Register**. +1. You should see the "Successfully registered LMS" banner at the top of the screen, which means that you've registered your LMS instance and teachers can now link their classrooms. + ## Configuring Canvas for {% data variables.product.prodname_classroom %} You can register your Canvas installation with {% data variables.product.prodname_classroom %} to enable teachers to import roster data into their classrooms. For more information about Canvas, see the [Canvas website](https://www.instructure.com/canvas/). diff --git a/content/github-models/use-github-models/integrating-ai-models-into-your-development-workflow.md b/content/github-models/use-github-models/integrating-ai-models-into-your-development-workflow.md index 05799d81fced..64579d1db2a1 100644 --- a/content/github-models/use-github-models/integrating-ai-models-into-your-development-workflow.md +++ b/content/github-models/use-github-models/integrating-ai-models-into-your-development-workflow.md @@ -4,6 +4,8 @@ intro: 'Call AI models in the tools you use every day.' versions: feature: github-models shortTitle: Integrate AI models +redirect_from: + - /github-models/integrating-ai-models-into-your-development-workflow --- With {% data variables.product.prodname_github_models %} extensions, you can call specific AI models from both {% data variables.product.prodname_copilot_chat_short %} and {% data variables.product.prodname_cli %}. These extensions integrate directly into your development workflow, allowing you to prompt models without context switching. diff --git a/content/site-policy/github-terms/github-marketplace-developer-agreement.md b/content/site-policy/github-terms/github-marketplace-developer-agreement.md index 3d4f6b3f43e7..6f7db1948bea 100644 --- a/content/site-policy/github-terms/github-marketplace-developer-agreement.md +++ b/content/site-policy/github-terms/github-marketplace-developer-agreement.md @@ -13,7 +13,7 @@ topics: **These terms and conditions (the "Agreement") govern your participation in GitHub’s Marketplace. By enrolling to participate in the Marketplace or by clicking “I Accept” below, you are confirming that you understand this agreement, and that you accept all of its terms and conditions. If you are entering into this Agreement on behalf of a company or other legal entity, you represent that you have the legal authority to bind the entity to this agreement, in which case “You” will mean the entity you represent.** -Effective Date: May 17, 2024 +Effective Date: May 27, 2025 ## 1. DEFINITIONS @@ -65,16 +65,16 @@ Notwithstanding any of the requirements set forth in Section 2 (Purpose and Lice **3.3** Developer will not engage in any activity with Marketplace, including attempting to distribute any Developer Product, that violates GitHub's Terms of Service including [Acceptable Use Policies](https://docs.github.com/en/site-policy/acceptable-use-policies/github-acceptable-use-policies). Additionally, Developer will not attempt to distribute any Developer Product that: -* 1\. Contains or installs any active malware or exploits, or uses our platform for exploit delivery (such as part of a command and control system); -* 2\. Enables the unauthorized download of streaming content or media; or -* 3\. Diverts End Users or provides links to any other site that mimics Marketplace or passes itself off as Marketplace +* (i) Contains or installs any active malware or exploits, or uses our platform for exploit delivery (such as part of a command and control system); +* (ii) Enables the unauthorized download of streaming content or media; or +* (iii) Diverts End Users or provides links to any other site that mimics Marketplace or passes itself off as Marketplace **3.4** With respect to Developer Products that interact with generative AI technology, including GitHub Copilot Extensions, Developer will: -* 1\. Test the Developer Product using various inputs to ensure that outputs do not violate this Agreement; -* 2\. Notify users when they are interacting with generative AI content; -* 3\. Have a mechanism for End Users to report feedback to GitHub and Developer related to errors, bugs, improper, or undesired outputs; and -* 4\. Inform End Users the appropriate use cases, best practices, and limitations of the Developer Product. +* (i) Test the Developer Product using various inputs to ensure that outputs do not violate this Agreement; +* (ii) Notify users when they are interacting with generative AI content; +* (iii) Have a mechanism for End Users to report feedback to GitHub and Developer related to errors, bugs, improper, or undesired outputs; and +* (iv) Inform End Users the appropriate use cases, best practices, and limitations of the Developer Product. **3.5** Developer shall not by any means repackage or resell Marketplace, a GitHub API, Personal Data, or Usage Data. Developer is not permitted to use a GitHub API or any Personal Data or Usage Data in any manner that does or could undermine the security of the Service, a GitHub API, Usage Data or any other data or information stored or transmitted using Marketplace. In addition, Developer shall not (a) interfere with, modify or disable any features, functionality or security controls of Marketplace or a GitHub API; (b) circumvent in any fashion any protection mechanisms for Marketplace or a GitHub API; or (c) reverse engineer, decompile, disassemble or derive the source code, underlying ideas, algorithms, structure or organizational form from Marketplace or a GitHub API. @@ -98,10 +98,10 @@ Notwithstanding any of the requirements set forth in Section 2 (Purpose and Lice If GitHub is notified by you or otherwise becomes aware and determines, in its sole discretion, that a Listing or any portion thereof or your Brand Features: -* (a) violates the terms of this Agreement or the ToS; -* (b) the display of the Listing is impacting the integrity of GitHub servers (i.e., users are unable to access such content or otherwise experience difficulty); -* (c) is deemed by GitHub to add undue risk to Marketplace End Users’ data or impair the user experience of Marketplace or GitHub; or -* (d) is subject to End User complaints in regards to your breach of your EULA, +* (i) violates the terms of this Agreement or the ToS; +* (ii) the display of the Listing is impacting the integrity of GitHub servers (i.e., users are unable to access such content or otherwise experience difficulty); +* (iii) is deemed by GitHub to add undue risk to Marketplace End Users’ data or impair the user experience of Marketplace or GitHub; or +* (iv) is subject to End User complaints in regards to your breach of your EULA, GitHub may: suspend the transfer of Personal Data to your Developer Product; prohibit the collection and processing of Personal Data via your Developer Product; remove the Listing from Marketplace; flag, filter, or modify related materials (including but not limited to descriptions, screenshots, or metadata); or reclassify the Listing at its sole discretion. If GitHub takes any of these actions on your Listing, you may appeal GitHub's action through the [GitHub Appeal and Reinstatement Process](https://docs.github.com/en/site-policy/acceptable-use-policies/github-appeal-and-reinstatement) @@ -130,10 +130,11 @@ Developer shall maintain and handle all Personal Data in accordance with privacy **6.1** GitHub will be the merchant of record for Developer Products purchased by End Users via Marketplace. -**6.2** Registration. Developer will be required to provide information about yourself (such as identification or contact details) as part of the registration process for Marketplace, or as part of your continued use of Marketplace including, but not limited to: (i) name, (ii) address, (iii) telephone number, (iv) e-mail address, and (v) payment account details. GitHub may publicize Developer’s information on Marketplace and retain Developer’s registration information as required by applicable law. -**6.3** Pricing. Prices for Listings of Developer Applications will be set in US Dollars (USD). Developer has complete control over setting pricing for each Listing. The prices you set for Developer Products will determine the amount of payment you will receive. GitHub will remit 95% of the sale price in USD without reduction for Taxes except for any withholding taxes that are required under applicable law. The remaining 5% of the sales price will be allotted to and retained by GitHub. At the end of each month and upon reaching a minimum value of $500 USD, GitHub will remit your share of payments. +**6.2** Registration. Developer will be required to provide information about yourself (such as identification or contact details) as part of the registration and onboarding process for Marketplace, or as part of your continued use of Marketplace including, but not limited to: (i) name, (ii) address, (iii) telephone number, (iv) e-mail address, and (v) payment account details. GitHub may publicize Developer’s information on Marketplace and retain Developer’s registration information as required by applicable law. -**6.3** Refunds. You will be responsible for specifying the terms and conditions regarding refunds to your End Users. In no event shall GitHub be responsible for providing any support for refunds, nor shall GitHub be liable for payment of any refund. +**6.3** Pricing. Prices for Listings of Developer Applications will be set in US Dollars (USD). Developer has complete control over setting pricing for each Listing. The prices you set for Developer Products will determine the amount of payment you will receive. GitHub will remit 95% of the sale price in USD without reduction for Taxes except for any withholding taxes that are required under applicable law. The remaining 5% of the sales price will be allotted to and retained by GitHub. GitHub will remit your share of first payment within 90 days of completed Registration. Following the first remittance, GitHub will remit your share of payments at the end of the month. + +**6.4** Refunds. You will be responsible for specifying the terms and conditions regarding refunds to your End Users. In no event shall GitHub be responsible for providing any support for refunds, nor shall GitHub be liable for payment of any refund. ## 7. OWNERSHIP @@ -179,7 +180,7 @@ The parties are independent contractors. This Agreement does not create a partne ## 15. NOTICE -Notices to GitHub may be submitted via email to legal@support.github.com. If Customer wishes to formally service notice on GitHub, it must be made through GitHub’s registered agent: GitHub, Inc. c/o Corporation Service Company 2710 Gateway Oaks Drive, Suite 150N Sacramento, CA 95833-3505. Notices must be in writing and will be treated as delivered on the date received at the address, date shown on the return receipt, email transmission date, or date on the courier confirmation of delivery. All notices to be provided by GitHub to Developer under this Agreement may be delivered in writing (i) by nationally recognized overnight delivery service (“Courier”) or U.S. mail to the contact mailing address provided by Developer to GitHub; or (ii) electronic mail to the electronic mail address provided by Developer. +Notices to GitHub may be submitted via email to legal-support@github.com. If Customer wishes to formally service notice on GitHub, it must be made through GitHub’s registered agent: GitHub, Inc. c/o Corporation Service Company 2710 Gateway Oaks Drive, Suite 150N Sacramento, CA 95833-3505. Notices must be in writing and will be treated as delivered on the date received at the address, date shown on the return receipt, email transmission date, or date on the courier confirmation of delivery. All notices to be provided by GitHub to Developer under this Agreement may be delivered in writing (i) by nationally recognized overnight delivery service (“Courier”) or U.S. mail to the contact mailing address provided by Developer to GitHub; or (ii) electronic mail to the electronic mail address provided by Developer. ## 16. GOVERNING LAW diff --git a/content/site-policy/privacy-policies/github-subprocessors.md b/content/site-policy/privacy-policies/github-subprocessors.md index 4d61e2e689d1..9d812fbd5019 100644 --- a/content/site-policy/privacy-policies/github-subprocessors.md +++ b/content/site-policy/privacy-policies/github-subprocessors.md @@ -31,7 +31,7 @@ If you have questions about this list, please contact us at | Anthropic PBC | AI Inference and AI Services | United States | United States | | Cloudflare | Content delivery service | United States | United States | | Fastly | Content delivery service | United States | United States | -| Google Cloud Platform (GCP) | Cloud Hosted Infrastructure, AI Inference and AI Services | United States, Belgium | United States | +| Google Cloud Platform (GCP) | Cloud Hosted Infrastructure, AI Inference and AI Services | United States, Belgium, Singapore | United States | | Microsoft (Azure) | Cloud Hosted Infrastructure, Data Hosting, AI Inference and AI Services | United States | United States | | Microsoft (Azure) | Cognitive Services and customer support ticketing analysis | United States | United States | | Microsoft | Technical Services | Australia, Brazil, Canada, France, Japan, Norway, Spain, Sweden, Switzerland, United Kingdom, United States | United States | diff --git a/data/reusables/actions/jfrog-json-configuring-identity-mappings.md b/data/reusables/actions/jfrog-json-configuring-identity-mappings.md new file mode 100644 index 000000000000..7706210c9c29 --- /dev/null +++ b/data/reusables/actions/jfrog-json-configuring-identity-mappings.md @@ -0,0 +1,6 @@ +```json copy +{ + "iss": "https://token.actions.githubusercontent.com", + "repository": "octo-org/octo-repo" +} +``` diff --git a/data/reusables/classroom/supported-lmses.md b/data/reusables/classroom/supported-lmses.md index b47bd761052e..1e9255eb0df2 100644 --- a/data/reusables/classroom/supported-lmses.md +++ b/data/reusables/classroom/supported-lmses.md @@ -7,6 +7,7 @@ Using LTI helps keep your information safe and secure. LTI is an industry-standa {% data variables.product.company_short %} has tested and verified registration, connection and the import of roster data from the following LMSes into {% data variables.product.prodname_classroom %}. +* Blackboard (This is a community supported option) * Canvas * Moodle * Sakai diff --git a/data/reusables/copilot/unlimited-premium-requests.md b/data/reusables/copilot/unlimited-premium-requests.md index f0a287349c47..7691bc8264c7 100644 --- a/data/reusables/copilot/unlimited-premium-requests.md +++ b/data/reusables/copilot/unlimited-premium-requests.md @@ -1,5 +1,7 @@ > [!IMPORTANT] -> Billing for premium requests will start on **June 4, 2025** for all plans. +> Billing and budget setting for premium requests will start on **June 4, 2025** for all plans. +> +> Budget setting for premium requests will be available starting **June 4, 2025**. > > Certain requests may experience rate limits. > * Rate limits restrict the number of requests that can be made within a specific time period. diff --git a/data/reusables/support/scope-of-support.md b/data/reusables/support/scope-of-support.md index d397d9607897..aaae479c3054 100644 --- a/data/reusables/support/scope-of-support.md +++ b/data/reusables/support/scope-of-support.md @@ -10,7 +10,7 @@ If your support request is outside of the scope of what our team can help you wi * Cloud provider configurations, such as virtual network setup, custom firewall, or proxy rules * Container orchestration, such as Kubernetes setup, or networking * Detailed assistance with workflows and data management -* Preview features. {% data variables.release-phases.public_preview_caps %} and {% data variables.release-phases.private_preview %} features are out of {% data variables.contact.github_support %}'s scope. {% ifversion ghec or ghes %}For support with {% data variables.release-phases.public_preview %} features, you can contact your account manager on {% data variables.contact.contact_enterprise_sales %}. For support with {% data variables.release-phases.private_preview %} features, contact the group provided during the {% data variables.release-phases.private_preview %}'s onboarding session, or your account manager on {% data variables.contact.contact_enterprise_sales %}.{% endif %} +* Preview features. {% data variables.release-phases.public_preview_caps %}, {% data variables.release-phases.private_preview %}, and technical preview features are out of {% data variables.contact.github_support %}'s scope. {% ifversion ghec or ghes %}For support with {% data variables.release-phases.public_preview %} features, you can contact your account manager on {% data variables.contact.contact_enterprise_sales %}. For support with {% data variables.release-phases.private_preview %} features, contact the group provided during the {% data variables.release-phases.private_preview %}'s onboarding session, or your account manager on {% data variables.contact.contact_enterprise_sales %}.{% endif %} For detailed assistance with workflows and data management, consult [GitHub Expert Services](https://github.com/services/), which offer specialized support to help you optimize your use of the platform. diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index a9127305f256..43c5d0e85020 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "722571cd076b83cc8145e93e29f7aa1ecc0fe658" + "sha": "6cde50ea96a7a5686a4670681356b3bb0eec899f" } \ 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 fdc7583993a6..233a8971535b 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -437455,7 +437455,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -437544,7 +437546,9 @@ "description": "

The registry type.

", "isRequired": true, "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ] }, { @@ -437645,7 +437649,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -437739,7 +437745,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -437965,7 +437973,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -438055,7 +438065,9 @@ "in": "body", "description": "

The registry type.

", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ] }, { @@ -493673,6 +493685,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -494009,6 +494022,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -494201,6 +494220,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -494495,6 +494515,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -494828,6 +494849,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -495020,6 +495047,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -495367,6 +495395,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -495700,6 +495729,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -495892,6 +495927,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -496114,6 +496150,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -496447,6 +496484,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -496639,6 +496682,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -496864,6 +496908,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -497197,6 +497242,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -497389,6 +497440,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -497677,6 +497729,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -498010,6 +498063,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -498202,6 +498261,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -498464,6 +498524,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -498534,6 +498595,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -498726,6 +498793,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -498854,6 +498922,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -498924,6 +498993,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -499116,6 +499191,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -499306,6 +499382,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -499379,6 +499456,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -499571,6 +499654,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -499677,6 +499761,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -499747,6 +499832,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -499939,6 +500030,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -563256,6 +563348,16 @@ "type": "boolean", "default": false } + }, + { + "name": "hide_secret", + "in": "query", + "description": "

A boolean value representing whether or not to hide literal secrets in the results.

", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } ], "bodyParameters": [], @@ -564923,6 +565025,16 @@ "type": "boolean", "default": false } + }, + { + "name": "hide_secret", + "in": "query", + "description": "

A boolean value representing whether or not to hide literal secrets in the results.

", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } ], "bodyParameters": [], @@ -566603,6 +566715,16 @@ "type": "boolean", "default": false } + }, + { + "name": "hide_secret", + "in": "query", + "description": "

A boolean value representing whether or not to hide literal secrets in the results.

", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } ], "bodyParameters": [], @@ -567486,6 +567608,16 @@ "description": "The security alert number.", "readOnly": true } + }, + { + "name": "hide_secret", + "in": "query", + "description": "

A boolean value representing whether or not to hide literal secrets in the results.

", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } ], "bodyParameters": [], diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index da383fee9ab4..2e206c72aab1 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -8862,13 +8862,13 @@ } ], "previews": [], + "descriptionHTML": "

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.

\n

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

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

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings.

\n

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

\n

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

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

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

\n

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

\n

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

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

Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.

\n

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.

\n

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

\n

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

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

Deletes a secret in an environment using the secret name.

\n

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

\n

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

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

Default response

" } - ], - "descriptionHTML": "

Deletes a secret in an environment using the secret name.

\n

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

\n

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

" + ] } ], "self-hosted-runner-groups": [ @@ -14002,13 +14002,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

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

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

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

\n

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

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

Response when creating a variable

" } - ], - "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

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

\n

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

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

Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.

\n

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

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "204", @@ -30867,8 +30868,7 @@ "httpStatusCode": "409", "description": "

Response when the visibility of the variable is not set to selected

" } - ], - "descriptionHTML": "

Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.

\n

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

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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

Deletes a specific workflow run.

\n

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Deletes a specific workflow run.

\n

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

\n

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

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

Note

\n

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

\n
\n

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

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

No Content

" } - ], - "descriptionHTML": "

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

\n

Note

\n

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

\n
\n

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

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

Sets the announcement banner to display for the organization.

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

OK

" } - ], - "descriptionHTML": "

Sets the announcement banner to display for the organization.

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

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

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

No Content

" } - ], - "descriptionHTML": "

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

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

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

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

Created

" } - ], - "descriptionHTML": "

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

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

Gets a development environment secret available to a user's codespaces without revealing its encrypted value.

\n

The authenticated user must have Codespaces access to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.

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

OK

" } - ], - "descriptionHTML": "

Gets a development environment secret available to a user's codespaces without revealing its encrypted value.

\n

The authenticated user must have Codespaces access to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -268744,13 +268744,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

\n

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

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

Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.

\n

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

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

The audit log stream configuration was created successfully.

" } - ], - "descriptionHTML": "

Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.

\n

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

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

Deletes a hosted compute network configuration from an enterprise.

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

No Content

" } - ], - "descriptionHTML": "

Deletes a hosted compute network configuration from an enterprise.

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

\n

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

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -350360,8 +350361,7 @@ "httpStatusCode": "410", "description": "

Gone

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

Get a random sentence from the Zen of GitHub

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

OK

" } - ], - "descriptionHTML": "

Get a random sentence from the Zen of GitHub

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

Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

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

Warning

\n

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

\n
\n

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

\n

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

Warning

\n

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

\n
\n

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

\n

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

\n

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

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

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

\n

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

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

\n

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

\n

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

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

Gets a specific package version for a public package owned by a specified user.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -474979,7 +474979,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -475068,7 +475070,9 @@ "description": "

The registry type.

", "isRequired": true, "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ] }, { @@ -475169,7 +475173,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -475263,7 +475269,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -475489,7 +475497,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -475579,7 +475589,9 @@ "in": "body", "description": "

The registry type.

", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ] }, { @@ -503068,13 +503080,13 @@ } ], "previews": [], + "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", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "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" + ] }, { "serverUrl": "https://api.github.com", @@ -531197,6 +531209,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -531533,6 +531546,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -531725,6 +531744,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -532019,6 +532039,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -532352,6 +532373,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -532544,6 +532571,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -532891,6 +532919,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -533224,6 +533253,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -533416,6 +533451,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -533638,6 +533674,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -533971,6 +534008,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -534163,6 +534206,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -534388,6 +534432,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -534721,6 +534766,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -534913,6 +534964,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -535201,6 +535253,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -535534,6 +535587,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -535726,6 +535785,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -535988,6 +536048,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -536058,6 +536119,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -536250,6 +536317,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -536378,6 +536446,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -536448,6 +536517,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -536640,6 +536715,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -536830,6 +536906,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -536903,6 +536980,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -537095,6 +537178,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -537201,6 +537285,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -537271,6 +537356,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -537463,6 +537554,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -554948,13 +555040,13 @@ } ], "previews": [], + "descriptionHTML": "

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

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

OK

" } - ], - "descriptionHTML": "

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

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

This returns a single autolink reference by ID that was configured for the given repository.

\n

Information about autolinks are only available to repository administrators.

", "statusCodes": [ { "httpStatusCode": "200", @@ -570572,8 +570665,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

This returns a single autolink reference by ID that was configured for the given repository.

\n

Information about autolinks are only available to repository administrators.

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

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -581745,8 +581838,7 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ], - "descriptionHTML": "

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

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

Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"

\n

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

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

OK

" } - ], - "descriptionHTML": "

Returns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use \"Get a repository webhook.\"

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -604426,6 +604518,16 @@ "type": "boolean", "default": false } + }, + { + "name": "hide_secret", + "in": "query", + "description": "

A boolean value representing whether or not to hide literal secrets in the results.

", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } ], "bodyParameters": [], @@ -606093,6 +606195,16 @@ "type": "boolean", "default": false } + }, + { + "name": "hide_secret", + "in": "query", + "description": "

A boolean value representing whether or not to hide literal secrets in the results.

", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } ], "bodyParameters": [], @@ -607773,6 +607885,16 @@ "type": "boolean", "default": false } + }, + { + "name": "hide_secret", + "in": "query", + "description": "

A boolean value representing whether or not to hide literal secrets in the results.

", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } ], "bodyParameters": [], @@ -608656,6 +608778,16 @@ "description": "The security alert number.", "readOnly": true } + }, + { + "name": "hide_secret", + "in": "query", + "description": "

A boolean value representing whether or not to hide literal secrets in the results.

", + "required": false, + "schema": { + "type": "boolean", + "default": false + } } ], "bodyParameters": [], @@ -657596,13 +657728,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

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

\n
\n

Creates a new discussion post on a team's page.

\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

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

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

Created

" } - ], - "descriptionHTML": "

Warning

\n

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

\n
\n

Creates a new discussion post on a team's page.

\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

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

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

Warning

\n

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

\n
\n

Get a specific discussion on a team's page.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Warning

\n

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

\n
\n

Get a specific discussion on a team's page.

\n

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

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

Warning

\n

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

\n
\n

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.

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

OK

" } - ], - "descriptionHTML": "

Warning

\n

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

\n
\n

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.

" + ] }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index c5a3e2c9ee58..faebd1e5786a 100644 --- a/src/rest/data/ghes-3.13-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json @@ -1000,13 +1000,13 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

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

OK

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

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

\n

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

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

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

\n

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

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

OK

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

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

\n

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

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

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

\n

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

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

No Content

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

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

\n

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

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

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

\n

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

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

No Content

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

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

\n

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

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

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

\n

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

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

Success response

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

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

\n

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

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

Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

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

OK

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

Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

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

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

\n

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

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

OK

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

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

\n

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

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

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

\n

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

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

No Content

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

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

\n

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

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

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

\n

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

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

No Content

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

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

\n

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

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

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

\n

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

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

OK

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

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

\n

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

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

Deletes a self-hosted runner group for an organization.

\n

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

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

No Content

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

Deletes a self-hosted runner group for an organization.

\n

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

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

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

\n

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

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

OK

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

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

\n

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

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

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

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

\n

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

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

Created

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

Returns a token that you can pass to the config script. The token expires after one hour.

\n

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

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

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

\n

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

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

Lists all organization variables shared with a repository.

\n

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

\n

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

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

OK

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

Lists all organization variables shared with a repository.

\n

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

\n

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

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

Gets a specific variable in a repository.

\n

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

\n

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

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

OK

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

Gets a specific variable in a repository.

\n

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

\n

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

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

Deletes an environment variable using the variable name.

\n

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

\n

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

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

No Content

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

Deletes an environment variable using the variable name.

\n

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

\n

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

" } ], "workflow-jobs": [ @@ -28180,13 +28180,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download.

\n

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

\n

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

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

Found

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

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download.

\n

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

\n

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

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

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

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

\n

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

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

OK

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

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

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

\n

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

" } ], "workflow-runs": [ @@ -35029,13 +35029,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a specific workflow run.

\n

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

\n

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

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

No Content

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

Deletes a specific workflow run.

\n

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

\n

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

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

Gets a specific workflow run attempt.

\n

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

\n

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

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

OK

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

Gets a specific workflow run attempt.

\n

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

\n

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

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

Cancels a workflow run using its id.

\n

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

", "statusCodes": [ { "httpStatusCode": "202", @@ -38343,7 +38342,8 @@ "httpStatusCode": "409", "description": "

Conflict

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

Cancels a workflow run using its id.

\n

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

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

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint

\n

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

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

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

OK

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

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint

\n

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

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

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

Lists the workflows in a repository.

\n

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

\n

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

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

OK

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

Lists the workflows in a repository.

\n

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

\n

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

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

Gets a specific workflow. You can replace workflow_id with the workflow\nfile name. For example, you could use main.yaml.

\n

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

\n

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

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

OK

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

Gets a specific workflow. You can replace workflow_id with the workflow\nfile name. For example, you could use main.yaml.

\n

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

\n

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

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

Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

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

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

No Content

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

Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

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

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

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

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

OK

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

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

\n
" } ], "notifications": [ @@ -81107,13 +81107,13 @@ } ], "previews": [], - "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.

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

No content

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

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -83506,7 +83506,6 @@ } ], "previews": [], - "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", "statusCodes": [ { "httpStatusCode": "200", @@ -83516,7 +83515,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

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

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

\n

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

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

No Content

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

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

\n

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

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -114821,7 +114821,6 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -114835,7 +114834,8 @@ "httpStatusCode": "404", "description": "

Resource not found

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

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

\n

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

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

OK

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

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

\n

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

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

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

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

No Content

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

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

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

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

\n

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

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

OK

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

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

\n

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

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

OK

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

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

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

No Content

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

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

" } ] }, @@ -201958,13 +201958,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

Gets the current message and expiration date of the global announcement banner in your enterprise.

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

OK

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

Gets the current message and expiration date of the global announcement banner in your enterprise.

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

Gets the audit log for an enterprise.

\n

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

\n

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

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

OK

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

Gets the audit log for an enterprise.

\n

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

\n

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

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

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

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

OK

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

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

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

List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.

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

OK

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

List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.

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

For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement

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

OK

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

For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement

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

Deletes any overridden enforcement on this repository for the specified hook.

\n

Responds with effective values inherited from owner and/or global level.

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

Responds with effective values inherited from owner and/or global level.

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

Deletes any overridden enforcement on this repository for the specified hook.

\n

Responds with effective values inherited from owner and/or global level.

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

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

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

Created

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

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

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

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"

\n

You can only send one of these scope keys at a time.

", "statusCodes": [ { "httpStatusCode": "200", @@ -335409,7 +335408,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

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

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"

\n

You can only send one of these scope keys at a time.

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

Warning

\n

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

\n
\n

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

\n

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

\n

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

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

Response - list of custom role names

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

Warning

\n

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

\n
\n

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

\n

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

\n

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

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

Check if a user is, publicly or privately, a member of the organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -342631,7 +342630,8 @@ "httpStatusCode": "404", "description": "

Not Found if requester is an organization member and user is not a member

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

Check if a user is, publicly or privately, a member of the organization.

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

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

\n

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

", "statusCodes": [ { "httpStatusCode": "204", @@ -344091,7 +344090,8 @@ "httpStatusCode": "403", "description": "

Forbidden

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

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

\n

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

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

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

\n

Only GitHub Apps can use this endpoint.

", "statusCodes": [ { "httpStatusCode": "202", @@ -348366,7 +348365,8 @@ "httpStatusCode": "500", "description": "

Internal Error

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

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

\n

Only GitHub Apps can use this endpoint.

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

Get all the repository rulesets for an organization.

", "statusCodes": [ { "httpStatusCode": "200", @@ -351071,7 +351070,8 @@ "httpStatusCode": "500", "description": "

Internal Error

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

Get all the repository rulesets for an organization.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -400978,7 +400978,6 @@ } ], "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 supports the following custom media types. For more information, see \"Media types.\"

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

Validation failed, or the endpoint has been spammed.

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

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

\n

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

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

OK

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

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

\n

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

\n" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -404431,13 +404431,13 @@ } ], "previews": [], - "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", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

\n

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

\n", "statusCodes": [ { "httpStatusCode": "201", @@ -406622,7 +406621,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "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" } ], "review-requests": [ @@ -421274,13 +421274,13 @@ } ], "previews": [], - "descriptionHTML": "

List the reactions to a team discussion comment.

\n

Note

\n

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

\n
\n

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

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

OK

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

List the reactions to a team discussion comment.

\n

Note

\n

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

\n
\n

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

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

List the reactions to a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

\n
\n

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

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

OK

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

List the reactions to a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

\n
\n

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

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

Note

\n

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

\n
\n

Delete a reaction to an issue comment.

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

No Content

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

Note

\n

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

\n
\n

Delete a reaction to an issue comment.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -429978,6 +429978,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -430314,6 +430315,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -430506,6 +430513,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -430789,6 +430797,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -431122,6 +431131,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -431314,6 +431329,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -431652,6 +431668,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -431985,6 +432002,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -432177,6 +432200,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -432394,6 +432418,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -432727,6 +432752,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -432919,6 +432950,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -433139,6 +433171,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -433472,6 +433505,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -433664,6 +433703,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -433941,6 +433981,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -434274,6 +434315,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -434466,6 +434513,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -434719,6 +434767,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -434789,6 +434838,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -434981,6 +435036,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -435109,6 +435165,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -435179,6 +435236,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -435371,6 +435434,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -435561,6 +435625,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -435634,6 +435699,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -435826,6 +435897,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -435932,6 +436004,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -436002,6 +436075,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -436194,6 +436273,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -453158,13 +453238,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

Disables Git LFS for a repository.

\n

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

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

No Content

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

Disables Git LFS for a repository.

\n

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

" } ], "rule-suites": [ @@ -488518,7 +488598,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports different qualifiers than the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -509575,13 +509655,13 @@ } ], "previews": [], - "descriptionHTML": "

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

\n

Note

\n

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

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

No Content

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

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

\n

Note

\n

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

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

List all comments on a team discussion.

\n

Note

\n

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

\n
\n

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

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

OK

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

List all comments on a team discussion.

\n

Note

\n

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

\n
\n

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

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

Warning

\n

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

\n
\n

Get a specific comment on a team discussion.

\n

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

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

OK

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

Warning

\n

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

\n
\n

Get a specific comment on a team discussion.

\n

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

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

Edits the title and body text of a discussion post. Only the parameters you provide are updated.

\n

Note

\n

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

\n
\n

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

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

OK

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

Edits the title and body text of a discussion post. Only the parameters you provide are updated.

\n

Note

\n

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

\n
\n

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

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

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\n

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

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

OK

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

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\n

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

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

Lists the GPG keys for a user. This information is accessible by anyone.

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

OK

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

Lists the GPG keys for a user. This information is accessible by anyone.

" } ], "keys": [ diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 8fa4ce3eeb1b..fcaffcaca0bf 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -433227,6 +433227,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -433563,6 +433564,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -433755,6 +433762,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -434038,6 +434046,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -434371,6 +434380,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -434563,6 +434578,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -434901,6 +434917,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -435234,6 +435251,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -435426,6 +435449,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -435643,6 +435667,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -435976,6 +436001,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -436168,6 +436199,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -436388,6 +436420,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -436721,6 +436754,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -436913,6 +436952,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -437190,6 +437230,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -437523,6 +437564,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -437715,6 +437762,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -437968,6 +438016,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -438038,6 +438087,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -438230,6 +438285,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -438358,6 +438414,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -438428,6 +438485,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -438620,6 +438683,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -438810,6 +438874,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -438883,6 +438948,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -439075,6 +439146,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -439181,6 +439253,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -439251,6 +439324,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -439443,6 +439522,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -492254,7 +492334,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports different qualifiers than the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 4e454faea5b5..169996524cda 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -437183,6 +437183,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -437519,6 +437520,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -437711,6 +437718,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -437994,6 +438002,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -438327,6 +438336,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -438519,6 +438534,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -438857,6 +438873,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -439190,6 +439207,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -439382,6 +439405,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -439599,6 +439623,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -439932,6 +439957,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -440124,6 +440155,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -440344,6 +440376,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -440677,6 +440710,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -440869,6 +440908,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -441146,6 +441186,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -441479,6 +441520,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -441671,6 +441718,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -441924,6 +441972,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -441994,6 +442043,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -442186,6 +442241,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -442314,6 +442370,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -442384,6 +442441,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -442576,6 +442639,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -442766,6 +442830,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -442839,6 +442904,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -443031,6 +443102,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -443137,6 +443209,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -443207,6 +443280,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -443399,6 +443478,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -496928,7 +497008,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports different qualifiers than the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index 622289385352..abedb89f8997 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -1228,13 +1228,13 @@ } ], "previews": [], + "descriptionHTML": "

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

Gets the customization template for an OpenID Connect (OIDC) subject claim.

\n

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

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

A JSON serialized template for OIDC subject claim customization

" } - ], - "descriptionHTML": "

Gets the customization template for an OpenID Connect (OIDC) subject claim.

\n

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

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

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

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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

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

\n

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

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

Created

" } - ], - "descriptionHTML": "

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

\n

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

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

Lists the organizations with access to a self-hosted runner group.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Lists the organizations with access to a self-hosted runner group.

\n

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

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

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

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

Created

" } - ], - "descriptionHTML": "

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

\n

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

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

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an organization.\"

\n

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

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

Lists all self-hosted runners configured in an organization.

\n

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

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

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

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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

Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.

\n

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

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -20569,8 +20570,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.

\n

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

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

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

\n

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

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

Response when creating a variable

" } - ], - "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

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

\n

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

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

Gets a specific variable in an organization.

\n

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

Gets a specific variable in an organization.

\n

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

\n

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

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

Deletes an environment variable using the variable name.

\n

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Deletes an environment variable using the variable name.

\n

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

\n

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

" + ] } ], "workflow-jobs": [ @@ -35486,13 +35486,13 @@ } ], "previews": [], + "descriptionHTML": "

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint

\n

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

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

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

OK

" } - ], - "descriptionHTML": "

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint

\n

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

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

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

These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

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

OK

" } - ], - "descriptionHTML": "

These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

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

Lists repositories a user is watching.

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

OK

" } - ], - "descriptionHTML": "

Lists repositories a user is watching.

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

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.

\n

You must use a JWT to access this endpoint.

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

OK

" } - ], - "descriptionHTML": "

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.

\n

You must use a JWT to access this endpoint.

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

Gets a deployment branch or tag policy for an environment.

\n

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

Gets a deployment branch or tag policy for an environment.

\n

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

\n

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

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

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

\n

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

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

List of deployment protection rules

" } - ], - "descriptionHTML": "

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

\n

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

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

Disables a custom deployment protection rule for an environment.

\n

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Disables a custom deployment protection rule for an environment.

\n

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

\n

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

" + ] } ], "statuses": [ @@ -210190,13 +210190,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

OK

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

OK

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.

\n

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

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

The audit log stream configuration was created successfully.

" } - ], - "descriptionHTML": "

Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.

\n

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

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

No Content

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

If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.

\n

The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.

\n

If the login name or email address is already associated with an account, the server will return a 422 response.

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

Created

" } - ], - "descriptionHTML": "

If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.

\n

The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.

\n

If the login name or email address is already associated with an account, the server will return a 422 response.

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

\n

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

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

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

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

\n

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

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

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"

\n

You can only send one of these scope keys at a time.

", "statusCodes": [ { "httpStatusCode": "200", @@ -344024,8 +344025,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November 13, 2020. For more information, including scheduled brownouts, see the blog post.

\n
\n

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"

\n

You can only send one of these scope keys at a time.

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

Gets a specific package in an organization.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Gets a specific package in an organization.

\n

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

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -387197,7 +387197,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -387286,7 +387288,9 @@ "description": "

The registry type.

", "isRequired": true, "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ] }, { @@ -387387,7 +387391,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -387481,7 +387487,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -387707,7 +387715,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -387797,7 +387807,9 @@ "in": "body", "description": "

The registry type.

", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ] }, { @@ -420535,13 +420547,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

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

OK

" } - ], - "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -443383,6 +443395,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -443719,6 +443732,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -443911,6 +443930,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -444194,6 +444214,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -444527,6 +444548,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -444719,6 +444746,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -445057,6 +445085,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -445390,6 +445419,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -445582,6 +445617,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -445799,6 +445835,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -446132,6 +446169,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -446324,6 +446367,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -446544,6 +446588,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -446877,6 +446922,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -447069,6 +447120,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -447346,6 +447398,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -447679,6 +447732,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -447871,6 +447930,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -448124,6 +448184,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -448194,6 +448255,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -448386,6 +448453,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -448514,6 +448582,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -448584,6 +448653,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -448776,6 +448851,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -448966,6 +449042,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -449039,6 +449116,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -449231,6 +449314,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -449337,6 +449421,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -449407,6 +449492,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -449599,6 +449690,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -493521,13 +493613,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.

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

OK

" } - ], - "descriptionHTML": "

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.

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

Returns a list of webhook deliveries for a webhook configured in a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -502553,8 +502646,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Returns a list of webhook deliveries for a webhook configured in a repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -503137,7 +503229,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports different qualifiers than the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -533142,13 +533234,13 @@ } ], "previews": [], + "descriptionHTML": "

List all comments on a team discussion.

\n

Note

\n

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

\n
\n

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

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

OK

" } - ], - "descriptionHTML": "

List all comments on a team discussion.

\n

Note

\n

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

\n
\n

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

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

Lists the people who the specified user follows.

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

OK

" } - ], - "descriptionHTML": "

Lists the people who the specified user follows.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index b1d30f735772..455580af42c3 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -389514,7 +389514,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -389603,7 +389605,9 @@ "description": "

The registry type.

", "isRequired": true, "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ] }, { @@ -389704,7 +389708,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -389798,7 +389804,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -390024,7 +390032,9 @@ "registry_type": { "description": "The registry type.", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ], "type": "string" }, @@ -390114,7 +390124,9 @@ "in": "body", "description": "

The registry type.

", "enum": [ - "maven_repository" + "maven_repository", + "nuget_feed", + "goproxy_server" ] }, { @@ -445708,6 +445720,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -446044,6 +446057,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -446236,6 +446255,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -446519,6 +446539,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -446852,6 +446873,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -447044,6 +447071,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -447382,6 +447410,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -447715,6 +447744,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -447907,6 +447942,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -448124,6 +448160,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -448457,6 +448494,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -448649,6 +448692,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -448869,6 +448913,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -449202,6 +449247,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -449394,6 +449445,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -449671,6 +449723,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -450004,6 +450057,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -450196,6 +450255,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -450449,6 +450509,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -450519,6 +450580,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -450711,6 +450778,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -450839,6 +450907,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -450909,6 +450978,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -451101,6 +451176,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -451291,6 +451367,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -451364,6 +451441,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -451556,6 +451639,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -451662,6 +451746,7 @@ "state": "uploaded", "content_type": "application/zip", "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", "download_count": 42, "created_at": "2013-02-27T19:35:32Z", "updated_at": "2013-02-27T19:35:32Z", @@ -451732,6 +451817,12 @@ "size": { "type": "integer" }, + "digest": { + "type": [ + "string", + "null" + ] + }, "download_count": { "type": "integer" }, @@ -451924,6 +452015,7 @@ "name", "content_type", "size", + "digest", "state", "url", "node_id", @@ -507456,7 +507548,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports different qualifiers than the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index cb6c0f29174e..544ce159cd5d 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "722571cd076b83cc8145e93e29f7aa1ecc0fe658" + "sha": "6cde50ea96a7a5686a4670681356b3bb0eec899f" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 16f3b69aa5d8..5fbed0adc522 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -205631,6 +205631,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -206196,6 +206202,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -206822,6 +206834,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -208125,6 +208143,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 21a135dd9089..0ad2c5227379 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -209292,6 +209292,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -209857,6 +209863,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -210483,6 +210495,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -211786,6 +211804,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", diff --git a/src/webhooks/data/ghes-3.13/schema.json b/src/webhooks/data/ghes-3.13/schema.json index d15cbc8df2e1..4db4cf26c551 100644 --- a/src/webhooks/data/ghes-3.13/schema.json +++ b/src/webhooks/data/ghes-3.13/schema.json @@ -191851,6 +191851,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -192416,6 +192422,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -193042,6 +193054,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -194345,6 +194363,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 1d6c1dc011ea..b86ea5b56b94 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -192919,6 +192919,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -193484,6 +193490,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -194110,6 +194122,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -195413,6 +195431,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index 940f45909cc4..0d4a963ffc32 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -193092,6 +193092,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -193657,6 +193663,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -194283,6 +194295,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -195586,6 +195604,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index 9497409e7a6c..4535afa52219 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -194276,6 +194276,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -194841,6 +194847,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -195467,6 +195479,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -196770,6 +196788,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index 762ff765cbb9..b0f07de602a2 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -195827,6 +195827,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -196392,6 +196398,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -197018,6 +197030,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", @@ -198321,6 +198339,12 @@ "description": "", "isRequired": true }, + { + "type": "string or null", + "name": "digest", + "description": "", + "isRequired": true + }, { "type": "string", "name": "state", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index c9ed6f0b91a8..9a3c05e24ccf 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "722571cd076b83cc8145e93e29f7aa1ecc0fe658" + "sha": "6cde50ea96a7a5686a4670681356b3bb0eec899f" } \ No newline at end of file