diff --git a/Dockerfile b/Dockerfile index d3a34d67428f..8db3546ebf73 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,7 +8,7 @@ # --------------------------------------------------------------- # To update the sha: # https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble -FROM ghcr.io/github/gh-base-image/gh-base-noble:20250711-151843-g9ff1d29c5 AS base +FROM ghcr.io/github/gh-base-image/gh-base-noble:20250711-165924-g6f92253c7 AS base # Install curl for Node install and determining the early access branch # Install git for cloning docs-early-access & translations repos diff --git a/content/actions/concepts/runners/about-runner-scale-sets.md b/content/actions/concepts/runners/about-runner-scale-sets.md new file mode 100644 index 000000000000..5af04b7443c7 --- /dev/null +++ b/content/actions/concepts/runners/about-runner-scale-sets.md @@ -0,0 +1,32 @@ +--- +title: About runner scale sets +shortTitle: Runner scale sets +intro: 'Learn about what a runner scale set is and how they can interact with the {% data variables.product.prodname_actions_runner_controller %}.' +layout: inline +versions: + fpt: '*' + ghec: '*' + ghes: '*' +type: overview +topics: + - Actions Runner Controller +--- + +[Legal notice](#legal-notice) + +## About runner scale sets + +A runner scale set is a group of homogeneous runners that can be assigned jobs from {% data variables.product.prodname_actions %}. The number of active runners owned by a runner scale set can be controlled by auto-scaling runner solutions such as {% data variables.product.prodname_actions_runner_controller %} (ARC). + +You can use runner groups to manage runner scale sets. Similar to self-hosted runners, you can add runner scale sets to existing runner groups. However, runner scale sets can belong to only one runner group at a time and can only have one label assigned to them. + +To assign jobs to a runner scale set, you must configure your workflow to reference the runner scale set’s name. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow). + +## Legal notice + +{% data reusables.actions.actions-runner-controller-legal-notice %} + +## Next steps + +* For more information about the {% data variables.product.prodname_actions_runner_controller %} as a concept, see [AUTOTITLE](/actions/concepts/runners/about-actions-runner-controller). +* To learn about runner groups, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups). diff --git a/content/actions/concepts/runners/index.md b/content/actions/concepts/runners/index.md index 69259122a96b..31e9c4dc8b2e 100644 --- a/content/actions/concepts/runners/index.md +++ b/content/actions/concepts/runners/index.md @@ -12,6 +12,7 @@ children: - /about-private-networking-with-github-hosted-runners - /about-self-hosted-runners - /communicating-with-self-hosted-runners + - /about-runner-scale-sets - /about-actions-runner-controller - /about-support-for-actions-runner-controller --- diff --git a/content/actions/how-tos/hosting-your-own-runners/index.md b/content/actions/how-tos/hosting-your-own-runners/index.md index 0c553d87173b..b95201b340bd 100644 --- a/content/actions/how-tos/hosting-your-own-runners/index.md +++ b/content/actions/how-tos/hosting-your-own-runners/index.md @@ -18,7 +18,6 @@ versions: ghec: '*' children: - /managing-self-hosted-runners - - /managing-self-hosted-runners-with-actions-runner-controller --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/writing-workflows/choosing-when-your-workflow-runs/using-conditions-to-control-job-execution.md b/content/actions/how-tos/writing-workflows/choosing-when-your-workflow-runs/using-conditions-to-control-job-execution.md index 5dc57bd0502a..c3012ca382b2 100644 --- a/content/actions/how-tos/writing-workflows/choosing-when-your-workflow-runs/using-conditions-to-control-job-execution.md +++ b/content/actions/how-tos/writing-workflows/choosing-when-your-workflow-runs/using-conditions-to-control-job-execution.md @@ -1,6 +1,6 @@ --- title: Using conditions to control job execution -shortTitle: Use conditions to control job execution +shortTitle: Control jobs with conditions intro: Prevent a job from running unless your conditions are met. versions: fpt: '*' @@ -11,15 +11,28 @@ redirect_from: - /actions/writing-workflows/choosing-when-your-workflow-runs/using-conditions-to-control-job-execution --- -{% data reusables.actions.enterprise-github-hosted-runners %} +You can use the `jobs..if` conditional to prevent a job from running unless a condition is met. {% data reusables.actions.if-supported-contexts %} -## Overview +### Example: Only run job for a specific repository -{% data reusables.actions.workflows.skipped-job-status-checks-passing %} +This example uses `if` to control when the `production-deploy` job can run. It will only run if the repository is named `octo-repo-prod` and is within the `octo-org` organization. Otherwise, the job will be marked as _skipped_. -{% data reusables.actions.jobs.section-using-conditions-to-control-job-execution %} +```yaml copy +name: example-workflow +on: [push] +jobs: + production-deploy: + if: github.repository == 'octo-org/octo-repo-prod' + runs-on: ubuntu-latest + steps: + - uses: {% data reusables.actions.action-checkout %} + - uses: {% data reusables.actions.action-setup-node %} + with: + node-version: '14' + - run: npm install -g bats +``` -On a skipped job, you should see "This check was skipped." +Skipped jobs display the message "This check was skipped." > [!NOTE] -> In some parts of the workflow you cannot use environment variables. Instead you can use contexts to access the value of an environment variable. For more information, see [AUTOTITLE](/actions/learn-github-actions/variables#using-the-env-context-to-access-environment-variable-values). +> A job that is skipped will report its status as "Success". It will not prevent a pull request from merging, even if it is a required check. diff --git a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api.md b/content/actions/tutorials/actions-runner-controller/authenticating-arc-to-the-github-api.md similarity index 95% rename from content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api.md rename to content/actions/tutorials/actions-runner-controller/authenticating-arc-to-the-github-api.md index 27a91d24f251..43eeb8dc3fcb 100644 --- a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api.md +++ b/content/actions/tutorials/actions-runner-controller/authenticating-arc-to-the-github-api.md @@ -1,7 +1,7 @@ --- -title: Authenticating to the GitHub API -shortTitle: Authenticating -intro: 'Learn how to authenticate to the {% data variables.product.company_short %} API to use {% data variables.product.prodname_actions_runner_controller %} with {% data variables.product.github %}.' +title: Authenticating ARC to the GitHub API +shortTitle: Authenticating to the API +intro: 'Learn how to authenticate {% data variables.product.prodname_actions_runner_controller %} to the {% data variables.product.company_short %} API.' versions: fpt: '*' ghec: '*' @@ -12,12 +12,11 @@ topics: defaultPlatform: linux redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api + - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api#deploying-using-personal-access-token-classic-authentication --- [Legal notice](#legal-notice) -## Overview - You can authenticate {% data variables.product.prodname_actions_runner_controller %} (ARC) to the {% data variables.product.prodname_dotcom %} API by using a {% data variables.product.prodname_github_app %} or by using a {% data variables.product.pat_v1 %}. > [!NOTE] diff --git a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md b/content/actions/tutorials/actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md similarity index 97% rename from content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md rename to content/actions/tutorials/actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md index 032391003d51..bab7c04c57cd 100644 --- a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md +++ b/content/actions/tutorials/actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md @@ -12,18 +12,11 @@ topics: defaultPlatform: linux redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller + - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller --- [Legal notice](#legal-notice) -## About runner scale sets - -Runner scale sets is a group of homogeneous runners that can be assigned jobs from {% data variables.product.prodname_actions %}. The number of active runners owned by a runner scale set can be controlled by auto-scaling runner solutions such as {% data variables.product.prodname_actions_runner_controller %} (ARC). - -You can use runner groups to manage runner scale sets. Similar to self-hosted runners, you can add runner scale sets to existing runner groups. However, runner scale sets can belong to only one runner group at a time and can only have one label assigned to them. For more information on runner groups, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups). - -To assign jobs to a runner scale set, you must configure your workflow to reference the runner scale set's name. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow). - ## Deploying a runner scale set To deploy a runner scale set, you must have ARC up and running. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller). diff --git a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/index.md b/content/actions/tutorials/actions-runner-controller/index.md similarity index 69% rename from content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/index.md rename to content/actions/tutorials/actions-runner-controller/index.md index 4e728969b4ac..d8530c3a3292 100644 --- a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/index.md +++ b/content/actions/tutorials/actions-runner-controller/index.md @@ -1,5 +1,5 @@ --- -title: Managing self-hosted runners with Actions Runner Controller +title: Actions Runner Controller shortTitle: Actions Runner Controller intro: You can host your own runners to run workflows in a highly customizable environment. versions: @@ -9,12 +9,13 @@ versions: topics: - Actions Runner Controller children: - - /authenticating-to-the-github-api + - /quickstart-for-actions-runner-controller + - /authenticating-arc-to-the-github-api - /deploying-runner-scale-sets-with-actions-runner-controller - /using-actions-runner-controller-runners-in-a-workflow - /troubleshooting-actions-runner-controller-errors redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller + - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller --- -{% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/quickstart-for-actions-runner-controller.md b/content/actions/tutorials/actions-runner-controller/quickstart-for-actions-runner-controller.md similarity index 99% rename from content/actions/tutorials/quickstart-for-actions-runner-controller.md rename to content/actions/tutorials/actions-runner-controller/quickstart-for-actions-runner-controller.md index b7a42996897a..d5f1b7b38d62 100644 --- a/content/actions/tutorials/quickstart-for-actions-runner-controller.md +++ b/content/actions/tutorials/actions-runner-controller/quickstart-for-actions-runner-controller.md @@ -1,6 +1,6 @@ --- title: Quickstart for Actions Runner Controller -shortTitle: Actions Runner Controller +shortTitle: Quickstart intro: 'In this tutorial, you''ll try out the basics of {% data variables.product.prodname_actions_runner_controller %}.' versions: fpt: '*' @@ -12,6 +12,7 @@ topics: defaultPlatform: linux redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller + - /actions/tutorials/quickstart-for-actions-runner-controller --- [Legal notice](#legal-notice) diff --git a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors.md b/content/actions/tutorials/actions-runner-controller/troubleshooting-actions-runner-controller-errors.md similarity index 98% rename from content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors.md rename to content/actions/tutorials/actions-runner-controller/troubleshooting-actions-runner-controller-errors.md index 3d7a08ce64da..870a8d9a953f 100644 --- a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors.md +++ b/content/actions/tutorials/actions-runner-controller/troubleshooting-actions-runner-controller-errors.md @@ -11,6 +11,7 @@ topics: - Actions Runner Controller redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors + - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors --- [Legal notice](#legal-notice) diff --git a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow.md b/content/actions/tutorials/actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow.md similarity index 92% rename from content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow.md rename to content/actions/tutorials/actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow.md index 7171004cfb14..c884099800b1 100644 --- a/content/actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow.md +++ b/content/actions/tutorials/actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow.md @@ -12,11 +12,12 @@ topics: defaultPlatform: linux redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow + - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow --- [Legal notice](#legal-notice) -## About using ARC runners in a workflow file +## Using ARC runners in a workflow file To assign jobs to run on a runner scale set, you can specify the name of the scale set as the value for the `runs-on` key in your {% data variables.product.prodname_actions %} workflow file. diff --git a/content/actions/tutorials/index.md b/content/actions/tutorials/index.md index 9fd47be92f36..115b94039bca 100644 --- a/content/actions/tutorials/index.md +++ b/content/actions/tutorials/index.md @@ -8,12 +8,12 @@ versions: ghec: '*' children: - /migrating-to-github-actions + - /actions-runner-controller - /creating-an-example-workflow - /creating-a-docker-container-action - /creating-a-javascript-action - /creating-a-composite-action - /store-and-share-data - - /quickstart-for-actions-runner-controller - /deploying-with-github-actions - /communicating-with-docker-service-containers redirect_from: diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md index 6731f0686214..b097e31997c6 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app.md @@ -42,6 +42,8 @@ If your app runs in the browser, you should use the web application flow to gene `client_id` | `string` | Required | The client ID for your {% data variables.product.prodname_github_app %}. The client ID is different from the app ID. You can find the client ID on the settings page for your app. For more information about navigating to the settings page for your {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app-registration#navigating-to-your-github-app-settings). `redirect_uri` | `string` | Strongly recommended | The URL in your application where users will be sent after authorization. This must be an exact match to one of the URLs you provided as a "Callback URL" in your app's settings and can't contain any additional parameters. `state` | `string` | Strongly recommended | When specified, the value should contain a random string to protect against forgery attacks, and it can also contain any other arbitrary data. +{% ifversion pkce_support %} `code_challenge` | `string` | Strongly recommended | Used to secure the authentication flow with PKCE (Proof Key for Code Exchange). Required if `code_challenge_method` is included. Must be a 43 character SHA-256 hash of a random string generated by the client. See the [PKCE RFC](https://datatracker.ietf.org/doc/html/rfc7636) for more details about this security extension. + `code_challenge_method` | `string` | Strongly recommended | Used to secure the authentication flow with PKCE (Proof Key for Code Exchange). Required if `code_challenge` is included. Must be `S256` - the `plain` code challenge method is not supported.{% endif %} `login` | `string` | Optional | When specified, the web application flow will prompt users with a specific account they can use for signing in and authorizing your app. `allow_signup` | `boolean` | Optional | Whether unauthenticated users will be offered an option to sign up for {% data variables.product.prodname_dotcom %} during the OAuth flow. The default is `true`. Use `false` when a policy prohibits signups. {% ifversion oauth_account_picker %} `prompt` | `string` | Optional | Forces the account picker to appear if set to `select_account`. The account picker will also appear if the application has a non-HTTP redirect URI or if the user has multiple accounts signed in. {% endif %} diff --git a/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md index 048194b01524..e1ea748e6214 100644 --- a/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps.md @@ -64,12 +64,16 @@ This endpoint takes the following input parameters. | `login` | `string` | Optional| Suggests a specific account to use for signing in and authorizing the app. | | `scope`|`string` |Context dependent| A space-delimited list of [scopes](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps). If not provided, `scope` defaults to an empty list for users that have not authorized any scopes for the application. For users who have authorized scopes for the application, the user won't be shown the OAuth authorization page with the list of scopes. Instead, this step of the flow will automatically complete with the set of scopes the user has authorized for the application. For example, if a user has already performed the web flow twice and has authorized one token with `user` scope and another token with `repo` scope, a third web flow that does not provide a `scope` will receive a token with `user` and `repo` scope. | | `state` | `string` |Strongly recommended| {% data reusables.apps.state_description %} | +| {% ifversion pkce_support %} | +| `code_challenge` | `string` | Strongly recommended | Used to secure the authentication flow with PKCE (Proof Key for Code Exchange). Required if `code_challenge_method` is included. Must be a 43 character SHA-256 hash of a random string generated by the client. See the [PKCE RFC](https://datatracker.ietf.org/doc/html/rfc7636) for more details about this security extension. +| `code_challenge_method` | `string` | Strongly recommended | Used to secure the authentication flow with PKCE (Proof Key for Code Exchange). Required if `code_challenge` is included. Must be `S256` - the `plain` code challenge method is not supported. +| {% endif %} | | `allow_signup`|`string` | Optional | Whether or not unauthenticated users will be offered an option to sign up for GitHub during the OAuth flow. The default is `true`. Use `false` when a policy prohibits signups. | | {% ifversion oauth_account_picker %} | | `prompt` | `string` | Optional | Forces the account picker to appear if set to `select_account`. The account picker will also appear if the application has a non-HTTP redirect URI or if the user has multiple accounts signed in. | | {% endif %} | -The PKCE (Proof Key for Code Exchange) parameters `code_challenge` and `code_challenge_method` are not supported at this time. CORS pre-flight requests (OPTIONS) are not supported at this time. +{% ifversion not pkce_support %}The PKCE (Proof Key for Code Exchange) parameters `code_challenge` and `code_challenge_method` are not supported at this time. {% endif %}CORS pre-flight requests (OPTIONS) are not supported at this time. ### 2. Users are redirected back to your site by GitHub @@ -87,6 +91,9 @@ Parameter name | Type | Required?| Description `client_secret` | `string` | Required | The client secret you received from {% data variables.product.github %} for your {% data variables.product.prodname_oauth_app %}. `code` | `string` | Required | The code you received as a response to Step 1. `redirect_uri` | `string` | Strongly recommended | The URL in your application where users are sent after authorization. We can use this to match against the URI originally provided when the `code` was issued, to prevent attacks against your service. +| {% ifversion pkce_support %} | +`code_verifier` | `string` | Strongly recommended | Used to secure the authentication flow with PKCE (Proof Key for Code Exchange). Required if `code_challenge` was sent during the user authorization. Must be the original value used to generate the `code_challenge` in the authorization request. This can be stored in a cookie alongside the `state` parameter or in a session variable during authentication, depending on your application architecture. +| {% endif %} | By default, the response takes the following form: diff --git a/content/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp.md b/content/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp.md index e799618fca39..993a3f81e521 100644 --- a/content/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp.md +++ b/content/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp.md @@ -189,7 +189,10 @@ For example, {% data variables.product.prodname_copilot_short %} will add commen Now you can review the pull request and make any adjustments. Once you have verified that the changes are valid, you can merge as with any other pull request. +## Hands-on practice + +Try the [Integrate MCP with {% data variables.product.prodname_copilot %}](https://github.com/skills/integrate-mcp-with-copilot/) Skills exercise for practical experience integrating MCP with {% data variables.product.prodname_copilot %}. + ## Further reading -* **Hands-on practice**: Try the [Integrate MCP with Copilot](https://github.com/skills/integrate-mcp-with-copilot/) Skills course for practical experience with MCP and agent mode. * **MCP fundamentals**: For more information about setting up and configuring MCP servers, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/extending-copilot-chat-with-mcp). diff --git a/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md index f256fe9fa51d..07946dd8f855 100644 --- a/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md +++ b/content/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site.md @@ -15,7 +15,7 @@ With access control for {% data variables.product.prodname_pages %}, you can res {% data reusables.pages.privately-publish-ghec-only %} -If your enterprise uses {% data variables.product.prodname_emus %}, access control is not available, and all {% data variables.product.prodname_pages %} sites are only accessible to other enterprise members. For more information about {% data variables.product.prodname_emus %}, see [AUTOTITLE](/pages/getting-started-with-github-pages/github-pages-limits#limits-for-enterprise-managed-users). +If your enterprise uses {% data variables.product.prodname_emus %}, {% data variables.product.prodname_pages %} sites can only be published as private, and all {% data variables.product.prodname_pages %} sites are only accessible to other enterprise members. For more information about {% data variables.product.prodname_emus %}, see [AUTOTITLE](/pages/getting-started-with-github-pages/github-pages-limits#limits-for-enterprise-managed-users). If your organization uses {% data variables.product.prodname_ghe_cloud %} without {% data variables.product.prodname_emus %}, you can choose to publish your project sites privately or publicly to anyone on the internet. diff --git a/data/features/pkce_support.yml b/data/features/pkce_support.yml new file mode 100644 index 000000000000..7a488e71f18b --- /dev/null +++ b/data/features/pkce_support.yml @@ -0,0 +1,5 @@ +# Reference: github/docs-content#18773 +# Support for PKCE in GitHub Apps and OAuth apps +versions: + fpt: '*' + ghec: '*' diff --git a/data/reusables/actions/about-deployment-with-github-actions.md b/data/reusables/actions/about-deployment-with-github-actions.md deleted file mode 100644 index b07d10a6d78d..000000000000 --- a/data/reusables/actions/about-deployment-with-github-actions.md +++ /dev/null @@ -1 +0,0 @@ -You can deliver deployments through {% data variables.product.prodname_actions %} and environments or with the REST API and third party apps. For more information about using environments to deploy with {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment). For more information about deployments with the REST API, see [AUTOTITLE](/rest/repos#deployments). diff --git a/data/reusables/actions/environment-example.md b/data/reusables/actions/environment-example.md deleted file mode 100644 index f7c5522142a9..000000000000 --- a/data/reusables/actions/environment-example.md +++ /dev/null @@ -1,43 +0,0 @@ -You can specify an environment for each job in your workflow. To do so, add a [`jobs..environment`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idenvironment) key followed by the name of the environment. - -For example, this workflow will use an environment called `production`. - -```yaml -name: Deployment - -on: - push: - branches: - - main - -jobs: - deployment: - runs-on: ubuntu-latest - environment: production - steps: - - name: deploy - # ...deployment-specific steps -``` - -When the above workflow runs, the `deployment` job will be subject to any rules configured for the `production` environment. For example, if the environment requires reviewers, the job will pause until one of the reviewers approves the job. - -You can also specify a URL for the environment. The specified URL will appear on the deployments page for the repository (accessed by clicking **Environments** on the home page of your repository) and in the visualization graph for the workflow run. If a pull request triggered the workflow, the URL is also displayed as a **View deployment** button in the pull request timeline. When using the "Require deployments to succeed before merging" rule, only the `name` specified is being checked even if a URL has also been specified. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-deployments-to-succeed-before-merging). - -```yaml -name: Deployment - -on: - push: - branches: - - main - -jobs: - deployment: - runs-on: ubuntu-latest - environment: - name: production - url: https://github.com - steps: - - name: deploy - # ...deployment-specific steps -``` diff --git a/data/reusables/actions/reusable-workflow-artifacts.md b/data/reusables/actions/reusable-workflow-artifacts.md deleted file mode 100644 index 90f8d2bf64c5..000000000000 --- a/data/reusables/actions/reusable-workflow-artifacts.md +++ /dev/null @@ -1 +0,0 @@ -All actions and workflows called within a run have write access to that run's artifacts. diff --git a/data/reusables/apps/web-app-flow-exchange-code.md b/data/reusables/apps/web-app-flow-exchange-code.md index 23098943045e..b5da9d3dcf52 100644 --- a/data/reusables/apps/web-app-flow-exchange-code.md +++ b/data/reusables/apps/web-app-flow-exchange-code.md @@ -6,4 +6,5 @@ `client_secret` | `string` | **Required.** The client secret for your {% data variables.product.prodname_github_app %}. You can generate a client secret on the settings page for your app. `code` | `string` | **Required.** The code you received in the previous step. `redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to one of the URLs you provided as a "Callback URL" when setting up your {% data variables.product.prodname_github_app %} and can't contain any additional parameters. +{% ifversion pkce_support %} `code_verifier` | `string` | Strongly recommended | Used to secure the authentication flow with PKCE (Proof Key for Code Exchange). Required if `code_challenge` was sent during the user authorization. Must be the original value used to generate the `code_challenge` in the authorization request. This can be stored in a cookie alongside the `state` parameter or in a session variable during authentication, depending on your application architecture.{% endif %} `repository_id` | `string` | The ID of a single repository that the user access token can access. If the {% data variables.product.prodname_github_app %} or user cannot access the repository, this will be ignored. Use this parameter to restrict the access of the user access token further. diff --git a/src/events/components/experiments/experiments.ts b/src/events/components/experiments/experiments.ts index 7c5e83be7d24..6e3e72ec67ff 100644 --- a/src/events/components/experiments/experiments.ts +++ b/src/events/components/experiments/experiments.ts @@ -15,20 +15,19 @@ type Experiment = { } // Update this with the name of the experiment, e.g. | 'example_experiment' -export type ExperimentNames = 'ai_search_experiment' +export type ExperimentNames = 'placeholder_experiment' export const EXPERIMENTS = { - ai_search_experiment: { - key: 'ai_search_experiment', - isActive: true, // Set to false when the experiment is over - // We still use an experiment for the AI Search until we: - // 1. Move analytics over the main dashboard - // 2. Don't require an emergency rollback, which experiments provides us - percentOfUsersToGetExperiment: 100, // 100% of users will get the experiment - includeVariationInContext: true, // All events will include the `experiment_variation` of the `ai_search_experiment` - limitToLanguages: ['en'], // Only users with the `en` language will be included in the experiment - alwaysShowForStaff: true, // When set to true, staff will always see the experiment (determined by the `staffonly` cookie) - turnOnWithURLParam: 'ai_search', /// When the query param `?feature=ai_search` is set, the experiment will be enabled + // Placeholder experiment to maintain type compatibility + placeholder_experiment: { + key: 'placeholder_experiment', + isActive: false, // Inactive placeholder + percentOfUsersToGetExperiment: 0, + includeVariationInContext: false, + limitToLanguages: [], + limitToVersions: [], + alwaysShowForStaff: false, + turnOnWithURLParam: 'placeholder', // Placeholder URL param }, /* Add new experiments here, example: 'example_experiment': { diff --git a/src/fixtures/helpers/turn-off-experiments.ts b/src/fixtures/helpers/turn-off-experiments.ts index 46e7eb3d0931..9767310f3edd 100644 --- a/src/fixtures/helpers/turn-off-experiments.ts +++ b/src/fixtures/helpers/turn-off-experiments.ts @@ -44,3 +44,18 @@ export function turnOffExperimentsBeforeEach(test: typeof Test) { await turnOffExperimentsInPage(page) }) } + +export async function dismissCTAPopover(page: Page) { + // Set the CTA popover to permanently dismissed in localStorage + await page.evaluate(() => { + localStorage.setItem( + 'ctaPopoverState', + JSON.stringify({ + dismissedCount: 0, + lastDismissedAt: null, + permanentlyDismissed: true, + }), + ) + }) + await page.reload() +} diff --git a/src/fixtures/tests/playwright-local-dev.spec.ts b/src/fixtures/tests/playwright-local-dev.spec.ts index 5a37441fdd59..8f85e6d8d69f 100644 --- a/src/fixtures/tests/playwright-local-dev.spec.ts +++ b/src/fixtures/tests/playwright-local-dev.spec.ts @@ -12,31 +12,40 @@ */ import { test, expect } from '@playwright/test' -import { turnOffExperimentsInPage } from '../helpers/turn-off-experiments' +import { dismissCTAPopover, turnOffExperimentsInPage } from '../helpers/turn-off-experiments' const TEST_EARLY_ACCESS = Boolean(JSON.parse(process.env.TEST_EARLY_ACCESS || 'false')) test('view home page', async ({ page }) => { await page.goto('/') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) + await expect(page).toHaveTitle(/GitHub Docs/) }) test('click "Get started" from home page', async ({ page }) => { await page.goto('/') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) + await page.getByRole('link', { name: 'Get started' }).click() await expect(page).toHaveTitle(/Get started with GitHub/) await expect(page).toHaveURL(/\/en\/get-started/) }) -test('search "git" and get results', async ({ page }) => { +test('search "foo" and get results', async ({ page }) => { await page.goto('/') await turnOffExperimentsInPage(page) - await page.getByTestId('site-search-input').click() - await page.getByTestId('site-search-input').fill('git') - await page.getByTestId('site-search-input').press('Enter') - await expect(page.getByRole('heading', { name: /\d+ Search results for "git"/ })).toBeVisible() + await dismissCTAPopover(page) + + await page.locator('[data-testid="search"]:visible').click() + await page.getByTestId('overlay-search-input').fill('foo') + // Wait for search results to load + await page.waitForTimeout(1000) + // Click "View more results" to get to the search page + await page.getByText('View more results').click() + await expect(page.getByRole('heading', { name: /\d+ Search results for "foo"/ })).toBeVisible() }) test('view the early-access links page', async ({ page }) => { @@ -44,6 +53,8 @@ test('view the early-access links page', async ({ page }) => { await page.goto('/early-access') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) + await expect(page).toHaveURL(/\/en\/early-access/) await page.getByRole('heading', { name: 'Early Access documentation', level: 1 }).click() const links = await page.$$eval( diff --git a/src/fixtures/tests/playwright-rendering.spec.ts b/src/fixtures/tests/playwright-rendering.spec.ts index 6f879ad0c1be..a04a803e21ed 100644 --- a/src/fixtures/tests/playwright-rendering.spec.ts +++ b/src/fixtures/tests/playwright-rendering.spec.ts @@ -1,6 +1,6 @@ import dotenv from 'dotenv' import { test, expect } from '@playwright/test' -import { turnOffExperimentsInPage } from '../helpers/turn-off-experiments' +import { turnOffExperimentsInPage, dismissCTAPopover } from '../helpers/turn-off-experiments' // This exists for the benefit of local testing. // In GitHub Actions, we rely on setting the environment variable directly @@ -20,6 +20,8 @@ test('view home page', async ({ page }) => { test('logo link keeps current version', async ({ page }) => { await page.goto('/enterprise-cloud@latest') + await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) // Basically clicking into any page that isn't the home page for this version. await page.getByTestId('product').getByRole('link', { name: 'Get started' }).click() await expect(page).toHaveURL(/\/en\/enterprise-cloud@latest\/get-started/) @@ -55,10 +57,19 @@ test('do a search from home page and click on "Foo" page', async ({ page }) => { await page.goto('/') await turnOffExperimentsInPage(page) - await page.getByTestId('site-search-input').click() - await page.getByTestId('site-search-input').fill('serve playwright') - await page.keyboard.press('Enter') - await expect(page).toHaveURL(/\/search\?query=serve\+playwright/) + await dismissCTAPopover(page) + + // Use the search overlay + await page.locator('[data-testid="search"]:visible').click() + await page.getByTestId('overlay-search-input').fill('serve playwright') + // Wait for search results to load + await page.waitForTimeout(1000) + // Click "View more results" to get to the search page + await page.getByText('View more results').click() + + await expect(page).toHaveURL( + /\/search\?search-overlay-input=serve\+playwright&query=serve\+playwright/, + ) await expect(page).toHaveTitle(/\d Search results for "serve playwright"/) await page.getByRole('link', { name: 'For Playwright' }).click() @@ -67,19 +78,14 @@ test('do a search from home page and click on "Foo" page', async ({ page }) => { await expect(page).toHaveTitle(/For Playwright/) }) -test('open new search, and perform a general search', async ({ page }) => { +test('open search, and perform a general search', async ({ page }) => { test.skip(!SEARCH_TESTS, 'No local Elasticsearch, no tests involving search') await page.goto('/') - - // Enable the AI search experiment by overriding the control group - await page.evaluate(() => { - // @ts-expect-error overrideControlGroup is a custom function added to the window object - window.overrideControlGroup('ai_search_experiment', 'treatment') - }) + await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) await page.locator('[data-testid="search"]:visible').click() - await page.getByTestId('overlay-search-input').fill('serve playwright') // Wait for the results to load // NOTE: In the UI we wait for results to load before allowing "enter", because we don't want @@ -100,17 +106,11 @@ test('open new search, and perform a general search', async ({ page }) => { await expect(page).toHaveTitle(/For Playwright/) }) -test('open new search, and select a general search article', async ({ page }) => { +test('open search, and select a general search article', async ({ page }) => { test.skip(!SEARCH_TESTS, 'No local Elasticsearch, no tests involving search') await page.goto('/') - // Enable the AI search experiment by overriding the control group - await page.evaluate(() => { - // @ts-expect-error overrideControlGroup is a custom function added to the window object - window.overrideControlGroup('ai_search_experiment', 'treatment') - }) - await page.locator('[data-testid="search"]:visible').click() await page.getByTestId('overlay-search-input').fill('serve playwright') @@ -126,17 +126,11 @@ test('open new search, and select a general search article', async ({ page }) => await expect(page).toHaveTitle(/For Playwright/) }) -test('open new search, and get auto-complete results', async ({ page }) => { +test('open search, and get auto-complete results', async ({ page }) => { test.skip(!SEARCH_TESTS, 'No local Elasticsearch, no tests involving search') await page.goto('/') - // Enable the AI search experiment by overriding the control group - await page.evaluate(() => { - // @ts-expect-error overrideControlGroup is a custom function added to the window object - window.overrideControlGroup('ai_search_experiment', 'treatment') - }) - await page.locator('[data-testid="search"]:visible').click() let listGroup = page.getByTestId('ai-autocomplete-suggestions') @@ -186,9 +180,17 @@ test('search from enterprise-cloud and filter by top-level Fooing', async ({ pag await page.goto('/enterprise-cloud@latest') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) + + // Use the search overlay + await page.locator('[data-testid="search"]:visible').click() + await page.getByTestId('overlay-search-input').fill('fixture') + // Wait for search results to load + await page.waitForTimeout(1000) + // Click "View more results" to get to the search page + await page.getByText('View more results').click() - await page.getByTestId('site-search-input').fill('fixture') - await page.getByTestId('site-search-input').press('Enter') + // Now we're on the search results page, apply the filter await page.getByText('Fooing (1)').click() await page.getByRole('link', { name: 'Clear' }).click() @@ -201,6 +203,7 @@ test.describe('platform picker', () => { test('switch operating systems', async ({ page }) => { await page.goto('/get-started/liquid/platform-specific') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) await page.getByTestId('platform-picker').getByRole('link', { name: 'Mac' }).click() await expect(page).toHaveURL(/\?platform=mac/) @@ -217,6 +220,7 @@ test.describe('platform picker', () => { // default platform set to windows in fixture fronmatter await page.goto('/get-started/liquid/platform-specific') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) await expect( page.getByTestId('minitoc').getByRole('link', { name: 'Macintosh until 1999' }), ).not.toBeVisible() @@ -235,6 +239,7 @@ test.describe('platform picker', () => { test('remember last clicked OS', async ({ page }) => { await page.goto('/get-started/liquid/platform-specific') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) await page.getByTestId('platform-picker').getByRole('link', { name: 'Windows' }).click() // Return and now the cookie should start us off on Windows again @@ -248,6 +253,7 @@ test.describe('tool picker', () => { test('switch tools', async ({ page }) => { await page.goto('/get-started/liquid/tool-specific') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) await page.getByTestId('tool-picker').getByRole('link', { name: 'GitHub CLI' }).click() await expect(page).toHaveURL(/\?tool=cli/) @@ -273,6 +279,7 @@ test.describe('tool picker', () => { test('remember last clicked tool', async ({ page }) => { await page.goto('/get-started/liquid/tool-specific') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) await page.getByTestId('tool-picker').getByRole('link', { name: 'Web browser' }).click() // Return and now the cookie should start us off with Web UI content again @@ -286,6 +293,7 @@ test.describe('tool picker', () => { // default tool set to desktop in fixture fronmatter await page.goto('/get-started/liquid/tool-specific') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) await expect( page.getByTestId('minitoc').getByRole('link', { name: 'Desktop section' }), ).toBeVisible() @@ -320,6 +328,7 @@ test.describe('hover cards', () => { test('hover over link', async ({ page }) => { await page.goto('/pages/quickstart') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) // hover over a link and check for intro content from hovercard await page @@ -382,6 +391,7 @@ test.describe('hover cards', () => { test('use keyboard shortcut to open hover card', async ({ page }) => { await page.goto('/pages/quickstart') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) // Simply putting focus on the link should not open the hovercard await page @@ -414,6 +424,7 @@ test.describe('hover cards', () => { test('able to use Esc to close hovercard', async ({ page }) => { await page.goto('/pages/quickstart') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) // hover over a link and check for intro content from hovercard await page @@ -574,6 +585,7 @@ test.describe('test nav at different viewports', () => { }) await page.goto('/get-started/foo/bar') await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) // header sign-up button is not visible await expect(page.getByTestId('header-signup')).not.toBeVisible() @@ -614,11 +626,19 @@ test.describe('test nav at different viewports', () => { }) await page.goto('/get-started/foo/bar') await turnOffExperimentsInPage(page) - await page.getByRole('button', { name: 'Open Search Bar' }).click() - await page.getByTestId('site-search-input').click() - await page.getByTestId('site-search-input').fill('serve playwright') - await page.getByTestId('site-search-input').press('Enter') - await expect(page).toHaveURL(/\/search\?query=serve\+playwright/) + await dismissCTAPopover(page) + + // Use the search overlay + await page.locator('[data-testid="mobile-search-button"]:visible').click() + await page.getByTestId('overlay-search-input').fill('serve playwright') + // Wait for search results to load + await page.waitForTimeout(1000) + // Click "View more results" to get to the search page + await page.getByText('View more results').click() + + await expect(page).toHaveURL( + /\/search\?search-overlay-input=serve\+playwright&query=serve\+playwright/, + ) await expect(page).toHaveTitle(/\d Search results for "serve playwright"/) }) @@ -631,10 +651,19 @@ test.describe('test nav at different viewports', () => { }) await page.goto('/get-started/foo/bar') await turnOffExperimentsInPage(page) - await page.getByTestId('site-search-input').click() - await page.getByTestId('site-search-input').fill('serve playwright') - await page.getByTestId('site-search-input').press('Enter') - await expect(page).toHaveURL(/\/search\?query=serve\+playwright/) + await dismissCTAPopover(page) + + // Use the search overlay + await page.locator('[data-testid="mobile-search-button"]:visible').click() + await page.getByTestId('overlay-search-input').fill('serve playwright') + // Wait for search results to load + await page.waitForTimeout(1000) + // Click "View more results" to get to the search page + await page.getByText('View more results').click() + + await expect(page).toHaveURL( + /\/search\?search-overlay-input=serve\+playwright&query=serve\+playwright/, + ) await expect(page).toHaveTitle(/\d Search results for "serve playwright"/) }) }) @@ -844,3 +873,114 @@ test.describe('translations', () => { await expect(page).toHaveURL('/ja/get-started/start-your-journey/hello-world') }) }) + +test('open search, and ask Copilot (Ask AI) a question', async ({ page }) => { + test.skip(!SEARCH_TESTS, 'No local Elasticsearch, no tests involving search') + + // Mock the CSE Copilot endpoint + await page.route('**/api/ai-search/v1', async (route) => { + // Simulate the streaming response from CSE Copilot + const mockResponse = `{"chunkType":"SOURCES","sources":[{"title":"Creating a new repository","index":"/en/get-started","url":"http://localhost:4000/en/get-started"}]} + +{"chunkType":"MESSAGE_CHUNK","text":"Creating "} +{"chunkType":"MESSAGE_CHUNK","text":"a "} +{"chunkType":"MESSAGE_CHUNK","text":"repository "} +{"chunkType":"MESSAGE_CHUNK","text":"on "} +{"chunkType":"MESSAGE_CHUNK","text":"GitHub "} +{"chunkType":"MESSAGE_CHUNK","text":"is "} +{"chunkType":"MESSAGE_CHUNK","text":"something "} +{"chunkType":"MESSAGE_CHUNK","text":"you "} +{"chunkType":"MESSAGE_CHUNK","text":"should "} +{"chunkType":"MESSAGE_CHUNK","text":"already "} +{"chunkType":"MESSAGE_CHUNK","text":"know "} +{"chunkType":"MESSAGE_CHUNK","text":"how "} +{"chunkType":"MESSAGE_CHUNK","text":"to "} +{"chunkType":"MESSAGE_CHUNK","text":"do "} +{"chunkType":"MESSAGE_CHUNK","text":":shrug:"}` + + await route.fulfill({ + status: 200, + headers: { + 'Content-Type': 'application/x-ndjson', + 'Transfer-Encoding': 'chunked', + }, + body: mockResponse, + }) + }) + + await page.goto('/') + await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) + + await page.locator('[data-testid="search"]:visible').click() + await page.getByTestId('overlay-search-input').fill('How do I create a Repository?') + // Pressing enter should ask AI the question + await page.keyboard.press('Enter') + + // Wait for the AI response to appear + await expect(page.getByText('Creating a repository on GitHub')).toBeVisible() + + // Verify that sources are displayed + await expect(page.getByText('Creating a new repository')).toBeVisible() + + // Verify the full response appears + await expect(page.getByText('something you should already know how to do')).toBeVisible() + + // Open the "Creating new repository" source link list item + // Find the references section first + const aiReferencesSection = page.getByTestId('ai-references') + await expect(aiReferencesSection).toBeVisible() + + // Wait for the reference list to be populated + await expect(page.getByText('Creating a new repository')).toBeVisible() +}) + +test('open search, Ask AI returns 400 error and shows general search results', async ({ page }) => { + test.skip(!SEARCH_TESTS, 'No local Elasticsearch, no tests involving search') + + // Mock the CSE Copilot endpoint to return a 400 error + await page.route('**/api/ai-search/v1', async (route) => { + await route.fulfill({ + status: 400, + headers: { + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ + upstreamStatus: 400, + }), + }) + }) + + await page.goto('/') + await turnOffExperimentsInPage(page) + await dismissCTAPopover(page) + + await page.locator('[data-testid="search"]:visible').click() + await page.getByTestId('overlay-search-input').fill('foo') + // Pressing enter should trigger Ask AI, get 400 error, and show general search results + await page.keyboard.press('Enter') + + // Wait for general search results to appear + await expect(page.getByRole('link', { name: 'Foo' })).toBeVisible() + await expect(page.getByRole('link', { name: 'Bar' })).toBeVisible() + + // Wait for the AI error message to appear + // This is a canned response for the 400 error + await page.waitForTimeout(1000) // Wait for the AI error message to appear + + // Verify the AI error message appears (canned response for 400 error) + await expect( + page + .getByRole('paragraph') + .getByText( + /Sorry, I'm unable to answer that question. Please try asking a different question./, + ), + ).toBeVisible() + + // Verify general search results appear above the AI section + const searchResults = page.getByTestId('general-autocomplete-suggestions') + const aiSection = page.locator('#ask-ai-result-container') + + await expect(searchResults).toBeVisible() + await expect(aiSection).toBeVisible() +}) diff --git a/src/frame/components/page-footer/SupportSection.tsx b/src/frame/components/page-footer/SupportSection.tsx index 0c6e7f34bec0..b153c5df4658 100644 --- a/src/frame/components/page-footer/SupportSection.tsx +++ b/src/frame/components/page-footer/SupportSection.tsx @@ -9,8 +9,6 @@ import { useRouter } from 'next/router' import { useTranslation } from '@/languages/components/useTranslation' import { AISearchCTAPopup } from '@/search/components/input/AISearchCTAPopup' import { useSearchOverlayContext } from '@/search/components/context/SearchOverlayContext' -import { EXPERIMENTS } from '@/events/components/experiments/experiments' -import { useShouldShowExperiment } from '@/events/components/experiments/useShouldShowExperiment' import styles from './SupportSection.module.scss' @@ -20,9 +18,6 @@ export const SupportSection = () => { const router = useRouter() const { t } = useTranslation('footer') const { setIsSearchOpen } = useSearchOverlayContext() - const { showExperiment: showNewSearch } = useShouldShowExperiment( - EXPERIMENTS.ai_search_experiment, - ) const isDeprecated = enterpriseServerReleases.isOldestReleaseDeprecated && @@ -34,7 +29,7 @@ export const SupportSection = () => { const showSurvey = !isDeprecated && !isSitePolicyDocs const showContribution = !isDeprecated && !isEarlyAccess && isEnglish const showSupport = true - const showCopilotCTA = !isDeprecated && !isEarlyAccess && isEnglish && showNewSearch + const showCopilotCTA = !isDeprecated && !isEarlyAccess && isEnglish return (
diff --git a/src/frame/components/page-header/Header.tsx b/src/frame/components/page-header/Header.tsx index 403a621e5404..ef38c90108a4 100644 --- a/src/frame/components/page-header/Header.tsx +++ b/src/frame/components/page-header/Header.tsx @@ -15,11 +15,8 @@ import { VersionPicker } from '@/versions/components/VersionPicker' import { SidebarNav } from '@/frame/components/sidebar/SidebarNav' import { AllProductsLink } from '@/frame/components/sidebar/AllProductsLink' import { SearchBarButton } from '@/search/components/input/SearchBarButton' -import { OldHeaderSearchAndWidgets } from './OldHeaderSearchAndWidgets' import { HeaderSearchAndWidgets } from './HeaderSearchAndWidgets' import { useInnerWindowWidth } from './hooks/useInnerWindowWidth' -import { EXPERIMENTS } from '@/events/components/experiments/experiments' -import { useShouldShowExperiment } from '@/events/components/experiments/useShouldShowExperiment' import { useMultiQueryParams } from '@/search/components/hooks/useMultiQueryParams' import { SearchOverlayContainer } from '@/search/components/input/SearchOverlayContainer' import { useCTAPopoverContext } from '@/frame/components/context/CTAContext' @@ -50,21 +47,28 @@ export const Header = () => { const { initializeCTA } = useCTAPopoverContext() const { isSearchOpen, setIsSearchOpen } = useSearchOverlayContext() - const { showExperiment: showNewSearch, experimentLoading: newSearchLoading } = - useShouldShowExperiment(EXPERIMENTS.ai_search_experiment) - let SearchButton: JSX.Element | null = ( + const SearchButtonLarge: JSX.Element = ( ) - if (!showNewSearch) { - SearchButton = null - } else { - initializeCTA() - } + + const SearchButtonSmall: JSX.Element = ( + + ) + + // Initialize the CTA(s) + initializeCTA() useEffect(() => { function onScroll() { @@ -175,22 +179,14 @@ export const Header = () => {
{/* In larger viewports, we want to show the search bar next to the version picker */} - {!newSearchLoading &&
{SearchButton}
} +
{SearchButtonLarge}
- {newSearchLoading ? null : showNewSearch ? ( - - ) : ( - - )} + {!isHomepageVersion && !isSearchResultsPage && (
@@ -254,15 +250,13 @@ export const Header = () => {
)} - {showNewSearch && ( - - )} + ) diff --git a/src/frame/components/page-header/OldHeaderSearchAndWidgets.module.scss b/src/frame/components/page-header/OldHeaderSearchAndWidgets.module.scss deleted file mode 100644 index 87a6e495e4de..000000000000 --- a/src/frame/components/page-header/OldHeaderSearchAndWidgets.module.scss +++ /dev/null @@ -1,39 +0,0 @@ -@import "@primer/css/support/variables/layout.scss"; -@import "@primer/css/support/mixins/layout.scss"; - -// Contains the search input, language picker, and sign-up button. When the -// search input is open and up to sm (where the language picker and sign-up -// button are hidden) we need to take up almost all the header width but then at -// md and above we don't want the search input to take up the header width. -.widgetsContainer { - width: 100%; - - @include breakpoint(md) { - width: auto; - } -} - -// Contains the search input and used when the smaller width search input UI is -// closed to hide the full width input, but as the width increases to md and -// above we show the search input along the other UI widgets (the menu button, -// the language picker, etc.) -.searchContainerWithClosedSearch { - display: none; - - @include breakpoint(md) { - display: block; - } -} - -// Contains the search input and used when the smaller width search input UI is -// open and we set it full width but as the browser width increases to md and -// above we don't take up the whole width anymore since we now show other UI -// widgets. -.searchContainerWithOpenSearch { - width: 100%; - margin-right: -1px; - - @include breakpoint(md) { - width: auto; - } -} diff --git a/src/frame/components/page-header/OldHeaderSearchAndWidgets.tsx b/src/frame/components/page-header/OldHeaderSearchAndWidgets.tsx deleted file mode 100644 index 7e64bed8fe7d..000000000000 --- a/src/frame/components/page-header/OldHeaderSearchAndWidgets.tsx +++ /dev/null @@ -1,174 +0,0 @@ -import cx from 'classnames' -import { SearchIcon, XIcon, KebabHorizontalIcon, LinkExternalIcon } from '@primer/octicons-react' -import { IconButton, ActionMenu, ActionList } from '@primer/react' - -import { LanguagePicker } from '@/languages/components/LanguagePicker' -import { useTranslation } from '@/languages/components/useTranslation' -import { OldSearchInput } from '@/search/components/input/OldSearchInput' -import { VersionPicker } from '@/versions/components/VersionPicker' -import { DEFAULT_VERSION, useVersion } from '@/versions/components/useVersion' -import { useHasAccount } from '../hooks/useHasAccount' -import { useMainContext } from '../context/MainContext' - -import styles from './OldHeaderSearchAndWidgets.module.scss' - -type Props = { - isSearchOpen: boolean - setIsSearchOpen: (value: boolean) => void - width: number | null -} - -export function OldHeaderSearchAndWidgets({ isSearchOpen, setIsSearchOpen, width }: Props) { - const { error } = useMainContext() - const { currentVersion } = useVersion() - const { t } = useTranslation(['header']) - const { hasAccount } = useHasAccount() - const signupCTAVisible = - hasAccount === false && // don't show if `null` - (currentVersion === DEFAULT_VERSION || currentVersion === 'enterprise-cloud@latest') - - return ( -
- {/* */} - {error !== '404' && ( -
- -
- )} - -
- -
- - {signupCTAVisible && ( - - )} - - setIsSearchOpen(!isSearchOpen)} - aria-label="Open Search Bar" - aria-expanded={isSearchOpen ? 'true' : 'false'} - icon={SearchIcon} - /> - setIsSearchOpen(!isSearchOpen)} - aria-label="Close Search Bar" - aria-expanded={isSearchOpen ? 'true' : 'false'} - icon={XIcon} - sx={ - isSearchOpen - ? { - // The x button to close the small width search UI when search is open, as the - // browser width increases to md and above we no longer show that search UI so - // the close search button is hidden as well. - // breakpoint(md) - '@media (min-width: 768px)': { - display: 'none', - }, - } - : { - display: 'none', - } - } - /> - - {/* The ... navigation menu at medium and smaller widths */} -
- - - - - - - - {width && width > 544 ? ( - - ) : ( - - )} - - {width && width < 545 && ( - <> - - - - )} - {signupCTAVisible && ( - - {t`sign_up_cta`} - - - )}{' '} - - - - -
-
- ) -} diff --git a/src/ghes-releases/scripts/deprecate/archive-version.ts b/src/ghes-releases/scripts/deprecate/archive-version.ts index f1cd5aed0885..de266713c54b 100755 --- a/src/ghes-releases/scripts/deprecate/archive-version.ts +++ b/src/ghes-releases/scripts/deprecate/archive-version.ts @@ -19,6 +19,7 @@ import loadRedirects from '@/redirects/lib/precompile' import { loadPageMap, loadPages } from '@/frame/lib/page-data' import { languageKeys } from '@/languages/lib/languages' import { RewriteAssetPathsPlugin } from '@/ghes-releases/scripts/deprecate/rewrite-asset-paths' +import type { Page } from '@/types' const port = '4001' const host = `http://localhost:${port}` @@ -27,7 +28,7 @@ const GH_PAGES_URL = `https://github.github.com/docs-ghes-${version}` // Once page-data.js is converted to TS, // we can import the more comprehesive type -type PageList = Array +type PageList = Page[] type MapObj = { [key: string]: string } program diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 712c9f3807c0..7b5742040cdf 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "664cf25da36ebb8f97693e51663addaed26bbae5" + "sha": "b15fded1fc5fc6dcd68dd0425385625ee2e819a4" } \ No newline at end of file diff --git a/src/languages/scripts/purge-fastly-edge-cache-per-language.js b/src/languages/scripts/purge-fastly-edge-cache-per-language.ts old mode 100755 new mode 100644 similarity index 91% rename from src/languages/scripts/purge-fastly-edge-cache-per-language.js rename to src/languages/scripts/purge-fastly-edge-cache-per-language.ts index 96f23698bb4c..3bd868240e6b --- a/src/languages/scripts/purge-fastly-edge-cache-per-language.js +++ b/src/languages/scripts/purge-fastly-edge-cache-per-language.ts @@ -20,7 +20,7 @@ import purgeEdgeCache from '@/workflows/purge-edge-cache' */ const DELAY_BETWEEN_LANGUAGES = 10 * 1000 -const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)) +const sleep = (ms: number): Promise => new Promise((resolve) => setTimeout(resolve, ms)) // This covers things like `/api/webhooks` which isn't language specific. await purgeEdgeCache(makeLanguageSurrogateKey()) @@ -40,7 +40,7 @@ for (const language of languages) { await purgeEdgeCache(makeLanguageSurrogateKey(language)) } -function languagesFromString(str) { +function languagesFromString(str: string): string[] { const languages = str .split(/,/) .map((x) => x.trim()) diff --git a/src/languages/tests/api-search.js b/src/languages/tests/api-search.ts similarity index 100% rename from src/languages/tests/api-search.js rename to src/languages/tests/api-search.ts diff --git a/src/languages/tests/files.js b/src/languages/tests/files.ts similarity index 100% rename from src/languages/tests/files.js rename to src/languages/tests/files.ts diff --git a/src/languages/tests/redirects.js b/src/languages/tests/redirects.ts similarity index 100% rename from src/languages/tests/redirects.js rename to src/languages/tests/redirects.ts diff --git a/src/languages/tests/search.js b/src/languages/tests/search.ts similarity index 100% rename from src/languages/tests/search.js rename to src/languages/tests/search.ts diff --git a/src/languages/tests/translation-error-comments.js b/src/languages/tests/translation-error-comments.ts similarity index 93% rename from src/languages/tests/translation-error-comments.js rename to src/languages/tests/translation-error-comments.ts index 15c2563335a7..26c163cb8ce4 100644 --- a/src/languages/tests/translation-error-comments.js +++ b/src/languages/tests/translation-error-comments.ts @@ -1,4 +1,4 @@ -import { describe, expect, test, vi, beforeEach, afterEach } from 'vitest' +import { describe, expect, test, vi, beforeEach, afterEach, type MockedFunction } from 'vitest' import { createTranslationFallbackComment, EmptyTitleError, @@ -10,7 +10,7 @@ import Page from '@/frame/lib/page' describe('Translation Error Comments', () => { // Mock renderContent for integration tests - let mockRenderContent + let mockRenderContent: MockedFunction<(template: string, context: any) => string> beforeEach(() => { mockRenderContent = vi.fn() @@ -26,7 +26,7 @@ describe('Translation Error Comments', () => { test('includes all fields when token information is available', () => { const error = new Error("Unknown tag 'badtag', line:1, col:3") error.name = 'ParseError' - error.token = { + ;(error as any).token = { file: '/content/test/article.md', getPosition: () => [1, 3], } @@ -48,11 +48,11 @@ describe('Translation Error Comments', () => { test('includes original error message when available', () => { const error = new Error("Unknown variable 'variables.nonexistent.value'") error.name = 'RenderError' - error.token = { + ;(error as any).token = { file: '/content/test/intro.md', getPosition: () => [3, 15], } - error.originalError = new Error('Variable not found: variables.nonexistent.value') + ;(error as any).originalError = new Error('Variable not found: variables.nonexistent.value') const result = createTranslationFallbackComment(error, 'rawIntro') @@ -67,7 +67,7 @@ describe('Translation Error Comments', () => { test('falls back to main error message when no originalError', () => { const error = new Error('Main error message') error.name = 'RenderError' - error.token = { + ;(error as any).token = { file: '/content/test.md', getPosition: () => [1, 1], } @@ -82,7 +82,7 @@ describe('Translation Error Comments', () => { test('includes tokenization error details', () => { const error = new Error('Unexpected token, line:1, col:10') error.name = 'TokenizationError' - error.token = { + ;(error as any).token = { file: '/content/test/page.md', getPosition: () => [1, 10], } @@ -152,7 +152,7 @@ describe('Translation Error Comments', () => { test('handles error with token but no file', () => { const error = new Error('Error message') error.name = 'ParseError' - error.token = { + ;(error as any).token = { // No file property getPosition: () => [5, 10], } @@ -167,7 +167,7 @@ describe('Translation Error Comments', () => { test('handles error with token but no getPosition method', () => { const error = new Error('Error message') error.name = 'ParseError' - error.token = { + ;(error as any).token = { file: '/content/test.md', // No getPosition method } @@ -192,7 +192,9 @@ describe('Translation Error Comments', () => { // Extract the message part to verify truncation const msgMatch = result.match(/msg="([^"]*)"/) expect(msgMatch).toBeTruthy() - expect(msgMatch[1].length).toBeLessThanOrEqual(203) // 200 + '...' + if (msgMatch?.[1]) { + expect(msgMatch[1].length).toBeLessThanOrEqual(203) // 200 + '...' + } }) test('properly escapes quotes in error messages', () => { @@ -244,7 +246,7 @@ describe('Translation Error Comments', () => { test('comment format is valid HTML', () => { const error = new Error('Test error') error.name = 'ParseError' - error.token = { + ;(error as any).token = { file: '/content/test.md', getPosition: () => [1, 1], } @@ -262,7 +264,7 @@ describe('Translation Error Comments', () => { test('contains all required fields when available', () => { const error = new Error('Detailed error message') error.name = 'RenderError' - error.token = { + ;(error as any).token = { file: '/content/detailed-test.md', getPosition: () => [42, 15], } @@ -281,7 +283,7 @@ describe('Translation Error Comments', () => { test('maintains consistent field order', () => { const error = new Error('Test message') error.name = 'ParseError' - error.token = { + ;(error as any).token = { file: '/content/test.md', getPosition: () => [1, 1], } @@ -318,11 +320,11 @@ describe('Translation Error Comments', () => { } // Mock renderContent to simulate error for Japanese, success for English - mockRenderContent.mockImplementation((template, context) => { + mockRenderContent.mockImplementation((template: string, context: any) => { if (context.currentLanguage !== 'en' && template.includes('badtag')) { const error = new Error("Unknown tag 'badtag'") error.name = 'ParseError' - error.token = { + ;(error as any).token = { file: '/content/test.md', getPosition: () => [1, 5], } @@ -355,7 +357,7 @@ describe('Translation Error Comments', () => { }, } - mockRenderContent.mockImplementation((template, context) => { + mockRenderContent.mockImplementation((template: string, context: any) => { if (context.currentLanguage !== 'en' && template.includes('badtag')) { const error = new Error("Unknown tag 'badtag'") error.name = 'ParseError' @@ -382,7 +384,7 @@ describe('Translation Error Comments', () => { const failingCallable = async () => { const error = new Error("Unknown variable 'variables.bad'") error.name = 'RenderError' - error.token = { + ;(error as any).token = { file: '/content/article.md', getPosition: () => [10, 20], } diff --git a/src/redirects/lib/exception-redirects.js b/src/redirects/lib/exception-redirects.ts similarity index 74% rename from src/redirects/lib/exception-redirects.js rename to src/redirects/lib/exception-redirects.ts index 26db181bfe7b..f12134f7bc29 100644 --- a/src/redirects/lib/exception-redirects.js +++ b/src/redirects/lib/exception-redirects.ts @@ -1,8 +1,10 @@ import fs from 'fs' +type Redirects = Record + // This function expects a .txt file in a specific format. -export default function getExceptionRedirects(exceptionsTxtFile) { - const exceptions = {} +export default function getExceptionRedirects(exceptionsTxtFile: string): Redirects { + const exceptions: Redirects = {} const exceptionRedirectsLines = fs .readFileSync(exceptionsTxtFile, 'utf-8') .split('\n') @@ -10,7 +12,7 @@ export default function getExceptionRedirects(exceptionsTxtFile) { .map((line) => line.trim()) .filter((line) => !line.startsWith('#')) - let parent = null + let parent: string | null = null for (const line of exceptionRedirectsLines) { if (line.startsWith('-')) { if (!parent) { diff --git a/src/redirects/lib/permalinks.js b/src/redirects/lib/permalinks.ts similarity index 89% rename from src/redirects/lib/permalinks.js rename to src/redirects/lib/permalinks.ts index d29e009e54b9..6112f6cf11d4 100644 --- a/src/redirects/lib/permalinks.js +++ b/src/redirects/lib/permalinks.ts @@ -1,8 +1,15 @@ import nonEnterpriseDefaultVersion from '@/versions/lib/non-enterprise-default-version' import { getPathWithoutVersion } from '@/frame/lib/path-utils' -export default function permalinkRedirects(permalinks, redirectFrom) { - const redirects = {} +import type { Permalink } from '@/types' + +type Redirects = Record + +export default function permalinkRedirects( + permalinks: Permalink[], + redirectFrom: string[], +): Redirects { + const redirects: Redirects = {} if (!permalinks.length) return redirects // The following is handling for versionless redirect fallbacks! diff --git a/src/redirects/lib/precompile.js b/src/redirects/lib/precompile.ts old mode 100755 new mode 100644 similarity index 86% rename from src/redirects/lib/precompile.js rename to src/redirects/lib/precompile.ts index a295dd79c5a1..069e4dd7632c --- a/src/redirects/lib/precompile.js +++ b/src/redirects/lib/precompile.ts @@ -2,14 +2,20 @@ import { readCompressedJsonFileFallback } from '@/frame/lib/read-json-file' import getExceptionRedirects from './exception-redirects' import { latest } from '@/versions/lib/enterprise-server-releases' +import type { Page } from '@/types' + const EXCEPTIONS_FILE = './src/redirects/lib/static/redirect-exceptions.txt' +type Redirects = Record + // This function runs at server warmup and precompiles possible redirect routes. // It outputs them in key-value pairs within a neat JavaScript object: { oldPath: newPath } -export async function precompileRedirects(pageList) { - const allRedirects = readCompressedJsonFileFallback('./src/redirects/lib/static/developer.json') +export async function precompileRedirects(pageList: Page[]): Promise { + const allRedirects: Redirects = readCompressedJsonFileFallback( + './src/redirects/lib/static/developer.json', + ) - const externalRedirects = readCompressedJsonFileFallback( + const externalRedirects: Redirects = readCompressedJsonFileFallback( './src/redirects/lib/external-sites.json', ) Object.assign(allRedirects, externalRedirects) @@ -37,7 +43,7 @@ export async function precompileRedirects(pageList) { // The advantage of the exception redirects file is that it's encoded in plain // text so it's possible to write comments and it's also possible to write 1 // destination URL once for each N redirect origins. - const exceptions = getExceptionRedirects(EXCEPTIONS_FILE) + const exceptions = getExceptionRedirects(EXCEPTIONS_FILE) as Redirects Object.assign(allRedirects, exceptions) Object.entries(allRedirects).forEach(([fromURI, toURI]) => { diff --git a/src/redirects/scripts/get-new-dotcom-path.js b/src/redirects/scripts/get-new-dotcom-path.ts old mode 100755 new mode 100644 similarity index 86% rename from src/redirects/scripts/get-new-dotcom-path.js rename to src/redirects/scripts/get-new-dotcom-path.ts index 2012697a9c7d..6ddf1fcaa0a1 --- a/src/redirects/scripts/get-new-dotcom-path.js +++ b/src/redirects/scripts/get-new-dotcom-path.ts @@ -15,13 +15,13 @@ const markdownRegex = new RegExp(`${markdownExtension}$`, 'm') const newDotcomDir = 'content/github' -const oldPath = process.argv.slice(2)[0] +const oldPath: string = process.argv.slice(2)[0] assert(oldPath, 'must provide old dotcom path like "foo" or "articles/foo"') -let filename = oldPath +let filename: string = oldPath // get last part of path -if (filename.includes('/')) filename = last(filename.split('/')) +if (filename.includes('/')) filename = last(filename.split('/')) as string // first check whether name is a category const categoryDir = `${newDotcomDir}/${filename.replace(markdownRegex, '')}` @@ -35,7 +35,7 @@ if (fs.existsSync(categoryDir)) { if (!filename.endsWith(markdownExtension)) filename = filename + markdownExtension // run find command -const newPath = execSync(`find ${newDotcomDir} -name ${filename}`).toString() +const newPath: string = execSync(`find ${newDotcomDir} -name ${filename}`).toString() if (!newPath) { console.log(`Cannot find new path for "${oldPath}". Check the name and try again.\n`) diff --git a/src/redirects/scripts/helpers/add-redirect-to-frontmatter.js b/src/redirects/scripts/helpers/add-redirect-to-frontmatter.js deleted file mode 100644 index af7f3d7caa89..000000000000 --- a/src/redirects/scripts/helpers/add-redirect-to-frontmatter.js +++ /dev/null @@ -1,14 +0,0 @@ -// add a new redirect string to redirect_from frontmatter - -export default function addRedirectToFrontmatter(redirectFromData, newRedirectString) { - if (Array.isArray(redirectFromData) && !redirectFromData.includes(newRedirectString)) { - redirectFromData.push(newRedirectString) - } else if (typeof redirectFromData === 'string') { - redirectFromData = [redirectFromData] - redirectFromData.push(newRedirectString) - } else { - redirectFromData = [newRedirectString] - } - - return redirectFromData -} diff --git a/src/redirects/scripts/helpers/add-redirect-to-frontmatter.ts b/src/redirects/scripts/helpers/add-redirect-to-frontmatter.ts new file mode 100644 index 000000000000..f4d333a28bf4 --- /dev/null +++ b/src/redirects/scripts/helpers/add-redirect-to-frontmatter.ts @@ -0,0 +1,17 @@ +// add a new redirect string to redirect_from frontmatter + +export default function addRedirectToFrontmatter( + redirectFromData: string | string[] | undefined, + newRedirectString: string, +): string[] { + if (Array.isArray(redirectFromData) && !redirectFromData.includes(newRedirectString)) { + redirectFromData.push(newRedirectString) + return redirectFromData + } else if (typeof redirectFromData === 'string') { + const redirectArray = [redirectFromData] + redirectArray.push(newRedirectString) + return redirectArray + } else { + return [newRedirectString] + } +} diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 817fcb0a22e0..6c787c06f657 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -576,13 +576,13 @@ } ], "previews": [], + "descriptionHTML": "

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

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

No Content

" } - ], - "descriptionHTML": "

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

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

Lists all GitHub-hosted runners configured in an organization.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Lists all GitHub-hosted runners configured in an organization.

\n

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

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

Get the list of platforms available for GitHub-hosted runners for an organization.

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

OK

" } - ], - "descriptionHTML": "

Get the list of platforms available for GitHub-hosted runners for an organization.

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in 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", @@ -5771,13 +5771,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": "https://api.github.com", @@ -6252,13 +6252,13 @@ } ], "previews": [], + "descriptionHTML": "

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

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

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

\n

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -8338,6 +8338,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -8565,13 +8566,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

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

No Content

" } - ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

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

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

\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 admin: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": "204", @@ -8649,8 +8651,7 @@ "httpStatusCode": "409", "description": "

Conflict when visibility type is not set to selected

" } - ], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

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

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\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 self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

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

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

Gets a specific 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": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific 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": "https://api.github.com", @@ -12300,6 +12301,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -16696,6 +16698,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", @@ -16705,8 +16708,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": "https://api.github.com", @@ -21188,13 +21190,13 @@ } ], "previews": [], + "descriptionHTML": "

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

No Content

" } - ], - "descriptionHTML": "

Updates 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 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", @@ -22128,6 +22130,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -22277,6 +22280,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists all repositories that can access an organization variable\nthat is available to selected repositories.

\n

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

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -22286,8 +22290,7 @@ "httpStatusCode": "409", "description": "

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

" } - ], - "descriptionHTML": "

Lists all repositories that can access an organization variable\nthat is available to selected repositories.

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

Deletes a repository variable using the variable name.

\n

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

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

\n

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

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

Updates an environment 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 app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

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

No Content

" } - ], - "descriptionHTML": "

Updates an environment 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 app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -24371,13 +24374,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": "https://api.github.com", @@ -27430,6 +27433,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -28283,6 +28287,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -30268,6 +30273,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -31121,6 +31127,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -33651,6 +33658,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34504,6 +34512,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -39005,6 +39014,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -39858,6 +39868,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -40275,13 +40286,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": "https://api.github.com", @@ -41165,6 +41176,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -44988,6 +45000,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -48805,6 +48818,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -52298,13 +52312,13 @@ } ], "previews": [], + "descriptionHTML": "

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

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": "https://api.github.com", @@ -52620,6 +52634,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -56421,6 +56436,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -60246,6 +60262,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -64047,6 +64064,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -67859,6 +67877,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -71671,6 +71690,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -76415,6 +76435,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -77571,6 +77592,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -79155,6 +79177,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -86520,6 +86543,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -87582,6 +87606,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -108943,13 +108968,13 @@ } ], "previews": [], + "descriptionHTML": "

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

\n

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

\n

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

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

Updates a check run for a specific commit in a repository.

\n

Note

\n

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

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

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

OK

" } - ], - "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

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

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

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

Lists annotations for a check run using the annotation id.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Lists annotations for a check run using the annotation id.

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -148292,6 +148317,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -150219,6 +150245,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -151587,6 +151614,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -153428,6 +153456,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -153718,13 +153747,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single check suite using its id.

\n

Note

\n

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

\n
\n

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

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

OK

" } - ], - "descriptionHTML": "

Gets a single check suite using its id.

\n

Note

\n

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

\n
\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -155427,6 +155456,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -156856,13 +156886,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.

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

OK

" } - ], - "descriptionHTML": "

Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.

" + ] }, { "serverUrl": "https://api.github.com", @@ -171309,7 +171339,7 @@ "type": "string", "name": "advanced_security", "in": "body", - "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

", + "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

\n

Warning

\n

\ncode_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features.

\n
", "enum": [ "enabled", "disabled", @@ -171318,6 +171348,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "code_security", + "in": "body", + "description": "

The enablement status of GitHub Code Security features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "dependency_graph", @@ -171427,6 +171468,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_protection", + "in": "body", + "description": "

The enablement status of GitHub Secret Protection features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "secret_scanning", @@ -172693,7 +172745,7 @@ "type": "string", "name": "advanced_security", "in": "body", - "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

", + "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

\n

Warning

\n

\ncode_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features.

\n
", "enum": [ "enabled", "disabled", @@ -172701,6 +172753,17 @@ "secret_protection" ] }, + { + "type": "string", + "name": "code_security", + "in": "body", + "description": "

The enablement status of GitHub Code Security features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "dependency_graph", @@ -172804,6 +172867,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_protection", + "in": "body", + "description": "

The enablement status of GitHub Secret Protection features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "secret_scanning", @@ -175053,7 +175127,7 @@ "type": "string", "name": "advanced_security", "in": "body", - "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

", + "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

\n

Warning

\n

\ncode_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features.

\n
", "enum": [ "enabled", "disabled", @@ -175062,6 +175136,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "code_security", + "in": "body", + "description": "

The enablement status of GitHub Code Security features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "dependency_graph", @@ -175171,6 +175256,17 @@ ], "default": "not_set" }, + { + "type": "string", + "name": "secret_protection", + "in": "body", + "description": "

The enablement status of GitHub Secret Protection features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "secret_scanning", @@ -175645,13 +175741,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a code security configuration in an organization.

\n

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

\n

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

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

Successfully created code security configuration

" } - ], - "descriptionHTML": "

Creates a code security configuration in an organization.

\n

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

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -176583,7 +176679,7 @@ "type": "string", "name": "advanced_security", "in": "body", - "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

", + "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

\n

Warning

\n

\ncode_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features.

\n
", "enum": [ "enabled", "disabled", @@ -176591,6 +176687,17 @@ "secret_protection" ] }, + { + "type": "string", + "name": "code_security", + "in": "body", + "description": "

The enablement status of GitHub Code Security features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "dependency_graph", @@ -176694,6 +176801,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_protection", + "in": "body", + "description": "

The enablement status of GitHub Secret Protection features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "secret_scanning", @@ -177340,13 +177458,13 @@ } ], "previews": [], + "descriptionHTML": "

Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

\n

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

\n

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

\n

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

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

Accepted

" } - ], - "descriptionHTML": "

Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

\n

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

\n

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

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -180604,6 +180722,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -182488,6 +182607,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -184231,6 +184351,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -186723,6 +186844,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -188467,6 +188589,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -190578,6 +190701,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -192472,6 +192596,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -194212,6 +194337,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -196009,6 +196135,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -197829,6 +197956,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -203679,6 +203807,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -205491,6 +205620,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -207300,6 +207430,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -209696,6 +209827,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -211713,6 +211845,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -214121,6 +214254,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -216042,6 +216176,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -218650,6 +218785,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -220413,6 +220549,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -222308,6 +222445,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -223790,6 +223928,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -224414,13 +224553,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "https://api.github.com", @@ -225317,6 +225456,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -238764,6 +238904,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -252665,6 +252806,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -253591,13 +253733,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Deletes a secret in a repository using the secret name.

\n

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

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

Create a new snapshot of a repository's dependencies.

\n

The authenticated user must have access to the repository.

\n

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

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

Created

" } - ], - "descriptionHTML": "

Create a new snapshot of a repository's dependencies.

\n

The authenticated user must have access to the repository.

\n

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

" + ] } ], "sboms": [ @@ -261237,13 +261379,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": "https://api.github.com", @@ -261409,13 +261551,13 @@ } ], "previews": [], + "descriptionHTML": "

Enable 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

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

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

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

The enabled custom deployment protection rule

" } - ], - "descriptionHTML": "

Enable 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

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

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

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

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

\n

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

\n

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

\n

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

\n

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

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

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

" } - ], - "descriptionHTML": "

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

\n

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

\n

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

\n

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

\n

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

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

Users with pull access can view a deployment status for a deployment:

", "statusCodes": [ { "httpStatusCode": "200", @@ -264416,8 +264559,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Users with pull access can view a deployment status for a deployment:

" + ] } ] }, @@ -277398,6 +277540,7 @@ } ], "previews": [], + "descriptionHTML": "

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", @@ -277415,8 +277558,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -285296,6 +285438,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -288510,6 +288653,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -291646,6 +291790,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -294715,6 +294860,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -297750,6 +297896,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -300565,6 +300712,7 @@ "enum": [ "completed", "not_planned", + "duplicate", "reopened", null ] @@ -300857,6 +301005,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -304256,6 +304405,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -307660,6 +307810,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -310687,6 +310838,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -318436,6 +318588,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -323212,6 +323365,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -342957,6 +343111,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -345998,6 +346153,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -349035,6 +349191,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -352086,6 +352243,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -365624,6 +365782,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -381091,6 +381250,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -388659,6 +388819,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -392029,13 +392190,13 @@ } ], "previews": [], + "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

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

OK

" } - ], - "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

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

Get overall statistics of API requests within the organization for a user.

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

OK

" } - ], - "descriptionHTML": "

Get overall statistics of API requests within the organization for a user.

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

List the users blocked by an organization.

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

OK

" } - ], - "descriptionHTML": "

List the users blocked by an organization.

" + ] }, { "serverUrl": "https://api.github.com", @@ -399939,6 +400100,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -400405,6 +400585,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -401058,13 +401257,13 @@ } ], "previews": [], + "descriptionHTML": "

Members of an organization can choose to have their membership publicized or not.

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

OK

" } - ], - "descriptionHTML": "

Members of an organization can choose to have their membership publicized or not.

" + ] }, { "serverUrl": "https://api.github.com", @@ -401445,6 +401644,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -401894,6 +402112,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -402349,6 +402586,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -403469,13 +403725,13 @@ } ], "previews": [], + "descriptionHTML": "

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

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

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

" + ] } ], "organization-roles": [ @@ -403930,13 +404186,13 @@ } ], "previews": [], + "descriptionHTML": "

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

\n

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

\n

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

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

No Content

" } - ], - "descriptionHTML": "

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

\n

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

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -407494,6 +407750,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -409256,6 +409513,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -419643,13 +419901,13 @@ } ], "previews": [], + "descriptionHTML": "

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

\n

You must be an organization owner to use this endpoint.

\n

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

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

OK

" } - ], - "descriptionHTML": "

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

\n

You must be an organization owner to use this endpoint.

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -421565,6 +421823,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -422859,6 +423118,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -424101,6 +424361,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -424981,13 +425242,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific package version 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 version 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": "https://api.github.com", @@ -426237,6 +426498,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -427511,6 +427773,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -428802,6 +429065,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -430900,6 +431164,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -432194,6 +432459,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -433503,6 +433769,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -437404,7 +437671,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -437495,7 +437769,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ] }, { @@ -437606,7 +437887,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -437703,7 +437991,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -437931,7 +438226,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -438023,7 +438325,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ] }, { @@ -486052,13 +486361,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": "https://api.github.com", @@ -486750,13 +487059,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

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

\n
\n

Delete a reaction to a team discussion.

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Note

\n

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

\n
\n

Delete a reaction to a team discussion.

\n

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

" + ] }, { "serverUrl": "https://api.github.com", @@ -488926,13 +489235,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": "https://api.github.com", @@ -493646,6 +493955,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -493789,6 +494099,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -494476,6 +494793,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -494616,6 +494934,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -495356,6 +495681,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -495496,6 +495822,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -496111,6 +496444,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -496251,6 +496585,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -496869,6 +497210,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -497009,6 +497351,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -497690,6 +498039,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -497830,6 +498180,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -500998,6 +501355,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -501145,13 +501503,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

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

OK

" } - ], - "descriptionHTML": "

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n
" + ] }, { "serverUrl": "https://api.github.com", @@ -505833,6 +506191,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -510529,6 +510888,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -510796,7 +511156,7 @@ { "type": "object", "name": "advanced_security", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"About GitHub Advanced\nSecurity.\"

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -515489,6 +515849,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -519392,6 +519753,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -519538,13 +519900,13 @@ } ], "previews": [], + "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

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

Accepted

" } - ], - "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

" + ] }, { "serverUrl": "https://api.github.com", @@ -524278,6 +524640,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -525286,6 +525649,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -531344,6 +531708,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -532490,6 +532855,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -538160,6 +538526,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -542838,6 +543205,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -556695,6 +557063,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -558257,6 +558626,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -595014,6 +595384,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -600530,6 +600901,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -606345,6 +606717,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -610631,13 +611004,13 @@ } ], "previews": [], + "descriptionHTML": "

Edits the body text of a discussion comment.

\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}/comments/{comment_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 body text of a discussion comment.

\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}/comments/{comment_number}.

\n
\n

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

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

\n
\n

Edits the body text of a discussion comment.

\n

OAuth app tokens and personal access tokens (classic) need the write: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 Update a discussion comment endpoint.

\n
\n

Edits the body text of a discussion comment.

\n

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

" + ] }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index ff41e428b1e0..a8321caf689d 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -11490,6 +11490,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -17128,6 +17129,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -30619,6 +30621,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -35933,6 +35936,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -36798,6 +36802,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -38795,6 +38800,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -39660,6 +39666,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -42202,6 +42209,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -43067,6 +43075,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -47580,6 +47589,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -48445,6 +48455,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -49764,6 +49775,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -53587,6 +53599,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -57404,6 +57417,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -61219,6 +61233,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -65020,6 +65035,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -68845,6 +68861,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -72646,6 +72663,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -76458,6 +76476,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -80270,6 +80289,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -85014,6 +85034,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -86182,6 +86203,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -87778,6 +87800,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -95155,6 +95178,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -96229,6 +96253,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -157731,6 +157756,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -159670,6 +159696,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -161050,6 +161077,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -162903,6 +162931,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -164914,6 +164943,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -183730,7 +183760,7 @@ "type": "string", "name": "advanced_security", "in": "body", - "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

", + "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

\n

Warning

\n

\ncode_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features.

\n
", "enum": [ "enabled", "disabled", @@ -183739,6 +183769,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "code_security", + "in": "body", + "description": "

The enablement status of GitHub Code Security features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "dependency_graph", @@ -183848,6 +183889,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_protection", + "in": "body", + "description": "

The enablement status of GitHub Secret Protection features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "secret_scanning", @@ -185114,7 +185166,7 @@ "type": "string", "name": "advanced_security", "in": "body", - "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

", + "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

\n

Warning

\n

\ncode_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features.

\n
", "enum": [ "enabled", "disabled", @@ -185122,6 +185174,17 @@ "secret_protection" ] }, + { + "type": "string", + "name": "code_security", + "in": "body", + "description": "

The enablement status of GitHub Code Security features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "dependency_graph", @@ -185225,6 +185288,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_protection", + "in": "body", + "description": "

The enablement status of GitHub Secret Protection features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "secret_scanning", @@ -187474,7 +187548,7 @@ "type": "string", "name": "advanced_security", "in": "body", - "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

", + "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

\n

Warning

\n

\ncode_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features.

\n
", "enum": [ "enabled", "disabled", @@ -187483,6 +187557,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "code_security", + "in": "body", + "description": "

The enablement status of GitHub Code Security features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "dependency_graph", @@ -187592,6 +187677,17 @@ ], "default": "not_set" }, + { + "type": "string", + "name": "secret_protection", + "in": "body", + "description": "

The enablement status of GitHub Secret Protection features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "secret_scanning", @@ -189004,7 +189100,7 @@ "type": "string", "name": "advanced_security", "in": "body", - "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

", + "description": "

The enablement status of GitHub Advanced Security features. enabled will enable both Code Security and Secret Protection features.

\n

Warning

\n

\ncode_security and secret_protection are deprecated values for this field. Prefer the individual code_security and secret_protection fields to set the status of these features.

\n
", "enum": [ "enabled", "disabled", @@ -189012,6 +189108,17 @@ "secret_protection" ] }, + { + "type": "string", + "name": "code_security", + "in": "body", + "description": "

The enablement status of GitHub Code Security features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "dependency_graph", @@ -189115,6 +189222,17 @@ ], "default": "disabled" }, + { + "type": "string", + "name": "secret_protection", + "in": "body", + "description": "

The enablement status of GitHub Secret Protection features.

", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "secret_scanning", @@ -193025,6 +193143,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -194921,6 +195040,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -196676,6 +196796,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -199180,6 +199301,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -200936,6 +201058,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -203059,6 +203182,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -204965,6 +205089,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -206717,6 +206842,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -208526,6 +208652,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -210358,6 +210485,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -216220,6 +216348,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -218044,6 +218173,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -219865,6 +219995,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -222273,6 +222404,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -224302,6 +224434,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -226722,6 +226855,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -228655,6 +228789,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -231275,6 +231410,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -233050,6 +233186,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -234957,6 +235094,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -236451,6 +236589,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -237990,6 +238129,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -251449,6 +251589,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -268134,6 +268275,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -323826,6 +323968,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -327040,6 +327183,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -330176,6 +330320,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -333245,6 +333390,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -336280,6 +336426,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -339095,6 +339242,7 @@ "enum": [ "completed", "not_planned", + "duplicate", "reopened", null ] @@ -339387,6 +339535,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -342786,6 +342935,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -346190,6 +346340,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -349217,6 +349368,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -356966,6 +357118,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -361742,6 +361895,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -381487,6 +381641,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -384528,6 +384683,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -387565,6 +387721,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -390616,6 +390773,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -404154,6 +404312,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -419621,6 +419780,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -427201,6 +427361,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -441490,6 +441651,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -441956,6 +442136,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -442996,6 +443195,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -443445,6 +443663,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -443900,6 +444137,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -449984,6 +450240,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -451758,6 +452015,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -464085,6 +464343,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -465391,6 +465650,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -466645,6 +466905,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -468793,6 +469054,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -470079,6 +470341,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -471382,6 +471645,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -473492,6 +473756,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -474798,6 +475063,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -476119,6 +476385,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -480038,7 +480305,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -480129,7 +480403,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ] }, { @@ -480240,7 +480521,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -480337,7 +480625,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -480565,7 +480860,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -480657,7 +480959,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ] }, { @@ -536280,6 +536589,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -536423,6 +536733,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -537110,6 +537427,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -537250,6 +537568,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -537990,6 +538315,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -538130,6 +538456,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -538745,6 +539078,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -538885,6 +539219,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -539503,6 +539844,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -539643,6 +539985,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -540324,6 +540673,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -540464,6 +540814,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -543631,6 +543988,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -548479,6 +548837,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -553192,6 +553551,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -553472,7 +553832,7 @@ { "type": "object", "name": "advanced_security", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"About GitHub Advanced\nSecurity.\"

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -558177,6 +558537,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -562092,6 +562453,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -566990,6 +567352,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -568010,6 +568373,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -574080,6 +574444,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -575238,6 +575603,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -581702,6 +582068,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -586392,6 +586759,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -602951,6 +603319,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -604525,6 +604894,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -644020,6 +644390,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -649548,6 +649919,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -655375,6 +655747,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json index 5627e7969b01..910ad5a866e3 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 @@ -264,13 +264,13 @@ } ], "previews": [], - "descriptionHTML": "

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

Gets the GitHub Actions cache usage policy for an enterprise.

\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 GitHub Actions cache usage policy for an enterprise.

\n

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

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

Sets the GitHub Actions cache usage policy for an enterprise.

\n

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

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

No Content

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

Sets the GitHub Actions cache usage policy for an enterprise.

\n

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

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

Lists the GitHub Actions caches for a repository.

\n

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

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

OK

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

Lists the GitHub Actions caches for a repository.

\n

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

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

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

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

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

OK

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

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

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

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

Deletes a GitHub Actions cache for a repository, using a cache ID.

\n

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

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

No Content

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

Deletes a GitHub Actions cache for a repository, using a cache ID.

\n

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

" } ], "oidc": [ @@ -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", @@ -2348,7 +2348,6 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -2362,7 +2361,8 @@ "httpStatusCode": "404", "description": "

Resource not found

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

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

\n

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

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

Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

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

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

No Content

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

Sets the GitHub Actions permissions policy for organizations and allowed actions in 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", @@ -4950,13 +4950,13 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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 selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"

\n

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", @@ -7375,6 +7375,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -10524,13 +10525,13 @@ } ], "previews": [], - "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner 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": "

Replaces the list of self-hosted runners that are part of an enterprise 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", @@ -11462,13 +11463,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", @@ -12510,6 +12511,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -12697,13 +12699,13 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

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

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

No Content

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

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

\n

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

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

Lists binaries for the runner application that you can download and run.

\n

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

\n

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

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

OK

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

Lists binaries for the runner application that you can download and run.

\n

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

\n

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

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -25978,6 +25980,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -31239,6 +31242,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -32051,6 +32055,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -33995,6 +34000,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34807,6 +34813,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -35029,13 +35036,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", @@ -37205,6 +37212,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -38017,6 +38025,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -42227,6 +42236,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -43039,6 +43049,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -44170,6 +44181,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -47981,6 +47993,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -51786,6 +51799,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -55589,6 +55603,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -59378,6 +59393,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -62859,13 +62875,13 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

Note

\n

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

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

OK

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

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

\n

Note

\n

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

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -63191,6 +63207,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -66980,6 +66997,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -70780,6 +70798,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -74580,6 +74599,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -78406,13 +78426,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
  • Timeline: The GitHub Enterprise Server global public timeline
    • \n
  • User: The public timeline for any user, using uri_template. For more information, see \"Hypermedia.\"
    • \n
  • Current user public: The public timeline for the authenticated user
    • \n
  • Current user: The private timeline for the authenticated user
    • \n
  • Current user actor: The private timeline for activity created by the authenticated user
    • \n
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
    • \n
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.
    • \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
  • Timeline: The GitHub Enterprise Server global public timeline
    • \n
  • User: The public timeline for any user, using uri_template. For more information, see \"Hypermedia.\"
    • \n
  • Current user public: The public timeline for the authenticated user
    • \n
  • Current user: The private timeline for the authenticated user
    • \n
  • Current user actor: The private timeline for activity created by the authenticated user
    • \n
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
    • \n
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.
    • \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": [ @@ -79308,6 +79328,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -80423,6 +80444,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -80708,13 +80730,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", @@ -81966,6 +81988,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -89287,6 +89310,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -90305,6 +90329,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -93402,13 +93427,13 @@ } ], "previews": [], - "descriptionHTML": "

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

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

The permissions the installation has are included under the permissions key.

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

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

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

Resource not found

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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

", "statusCodes": [ { "httpStatusCode": "204", @@ -127908,7 +127932,8 @@ "httpStatusCode": "404", "description": "

Resource not found

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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -128330,13 +128355,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", @@ -129229,7 +129254,6 @@ } ], "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

Lists who has access to this protected branch.

\n

Note

\n

\nUsers, apps, and teams restrictions are only available for organization-owned repositories.

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

Resource not found

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

Lists who has access to this protected branch.

\n

Note

\n

\nUsers, apps, and teams restrictions are only available for organization-owned repositories.

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

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

\n

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "statusCodes": [ { "httpStatusCode": "200", @@ -130905,7 +130929,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

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

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

\n

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -144655,6 +144680,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -146535,6 +146561,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -147862,6 +147889,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -147969,13 +147997,13 @@ } ], "previews": [], - "descriptionHTML": "

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite.\nYou must have admin permissions in the repository to set preferences for check suites.

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

OK

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

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite.\nYou must have admin permissions in the repository to set preferences for check suites.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -149656,6 +149684,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -151608,6 +151637,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -161307,6 +161337,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -162748,6 +162779,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -163257,13 +163289,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -164234,6 +164266,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -177594,6 +177627,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -186804,6 +186838,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -189137,13 +189172,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.

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

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

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

Default response

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

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

" } ], "protection-rules": [ @@ -201077,13 +201112,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

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

\n

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

\n

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

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

Success

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

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

\n

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

\n

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

" } ], "code-security-and-analysis": [ @@ -203226,13 +203261,13 @@ } ], "previews": [], - "descriptionHTML": "

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

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

OK

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

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

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

OK

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

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", + "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers (Okta, for example), the user GDPR data in the SCIM metadata will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -238186,6 +238221,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -241394,6 +241430,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -244524,6 +244561,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -247587,6 +247625,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -250616,6 +250655,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -253425,6 +253465,7 @@ "enum": [ "completed", "not_planned", + "duplicate", "reopened", null ] @@ -253717,6 +253758,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -257110,6 +257152,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -260508,6 +260551,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -263529,6 +263573,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -271242,6 +271287,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -276006,6 +276052,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -291555,7 +291602,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists all events for an issue.

", "statusCodes": [ { "httpStatusCode": "200", @@ -291565,7 +291611,8 @@ "httpStatusCode": "410", "description": "

Gone

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

Lists all events for an issue.

" } ], "labels": [ @@ -306063,6 +306110,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -319217,7 +319265,6 @@ } ], "previews": [], - "descriptionHTML": "

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

", "statusCodes": [ { "httpStatusCode": "204", @@ -319227,7 +319274,8 @@ "httpStatusCode": "404", "description": "

Resource not found

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

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -320126,6 +320174,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -324152,6 +324201,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -335263,13 +335313,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

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

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

OK

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

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

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

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

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository 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": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

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

\n

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

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -340633,6 +340683,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -341099,6 +341168,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -342139,6 +342227,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -342588,6 +342695,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -343043,6 +343169,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -343820,7 +343965,6 @@ } ], "previews": [], - "descriptionHTML": "

Removing a user from this list will remove them from all the organization's repositories.

", "statusCodes": [ { "httpStatusCode": "204", @@ -343830,7 +343974,8 @@ "httpStatusCode": "422", "description": "

Unprocessable Entity if user is a member of the organization

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

Removing a user from this list will remove them from all the organization's repositories.

" } ], "personal-access-tokens": [ @@ -345450,6 +345595,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -347168,6 +347314,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -355663,13 +355810,13 @@ } ], "previews": [], - "descriptionHTML": "

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

\n

You must be an organization owner to use this endpoint.

\n

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

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

OK

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

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

\n

You must be an organization owner to use this endpoint.

\n

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

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -357439,6 +357586,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -358692,6 +358840,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -359893,6 +360042,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -361988,6 +362138,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -363221,6 +363372,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -364471,6 +364623,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -366528,6 +366681,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -367781,6 +367935,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -369049,6 +369204,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -371327,13 +371483,13 @@ } ], "previews": [], - "descriptionHTML": "

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

\n

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

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

Created

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

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

\n

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

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

Gets the current status of a GitHub Pages deployment.

\n

The authenticated user must have read permission for the GitHub Pages site.

", "statusCodes": [ { "httpStatusCode": "200", @@ -372270,7 +372425,8 @@ "httpStatusCode": "404", "description": "

Resource not found

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

Gets the current status of a GitHub Pages deployment.

\n

The authenticated user must have read permission for the GitHub Pages site.

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

Deletes a review comment.

", "statusCodes": [ { "httpStatusCode": "204", @@ -402320,7 +402475,8 @@ "httpStatusCode": "404", "description": "

Resource not found

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

Deletes a review comment.

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

List the reactions to a pull request review comment.

", "statusCodes": [ { "httpStatusCode": "200", @@ -424530,7 +424685,8 @@ "httpStatusCode": "404", "description": "

Resource not found

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

List the reactions to a pull request review comment.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -427781,6 +427937,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -427924,6 +428081,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -428600,6 +428764,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -428740,6 +428905,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -429471,6 +429643,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -429611,6 +429784,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -430221,6 +430401,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -430361,6 +430542,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -430974,6 +431162,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -431114,6 +431303,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -431784,6 +431980,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -431924,6 +432121,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -435080,6 +435284,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -439875,6 +440080,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -444532,6 +444738,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -444764,7 +444971,7 @@ { "type": "object", "name": "advanced_security", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"About GitHub Advanced\nSecurity.\"

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -449414,6 +449621,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -452644,6 +452852,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -457489,6 +457698,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -458480,6 +458690,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -464497,6 +464708,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -465604,6 +465816,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -465967,7 +466180,6 @@ } ], "previews": [], - "descriptionHTML": "

Users with admin access to the repository can create an autolink.

", "statusCodes": [ { "httpStatusCode": "201", @@ -465977,7 +466189,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

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

Users with admin access to the repository can create an autolink.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -471205,6 +471418,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -475842,6 +476056,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -476128,13 +476343,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": [ @@ -487341,6 +487556,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -488855,6 +489071,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -505125,7 +505342,6 @@ } ], "previews": [], - "descriptionHTML": "

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.

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

Forbidden if the project is not owned by the organization

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

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -506103,6 +506320,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -507396,13 +507614,13 @@ } ], "previews": [], - "descriptionHTML": "

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

\n

Note

\n

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

\n
\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

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

No Content

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

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

\n

Note

\n

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

\n
\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -507470,13 +507688,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", @@ -511871,6 +512089,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -513225,13 +513444,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 Remove a repository from a team endpoint.

\n
\n

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. NOTE: This does not delete the repository, it just removes it from the team.

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

No Content

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

Warning

\n

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

\n
\n

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. NOTE: This does not delete the repository, it just removes it from the team.

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

Edits the body text of a discussion comment.

\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}/comments/{comment_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 body text of a discussion comment.

\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}/comments/{comment_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", @@ -518013,13 +518232,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

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

\n
\n

Deletes a comment on a team discussion.

\n

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

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

No Content

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

Warning

\n

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

\n
\n

Deletes a comment on a team discussion.

\n

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

" } ], "discussions": [ @@ -522258,13 +522477,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", @@ -533721,13 +533940,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the SSH signing keys for a user. This operation is accessible by anyone.

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

OK

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

Lists the SSH signing keys for a user. This operation is accessible by anyone.

" } ] } 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 de7633002909..69f0cecd0f43 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 @@ -7375,6 +7375,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -12510,6 +12511,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -25978,6 +25980,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -31239,6 +31242,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -32051,6 +32055,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -33995,6 +34000,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34807,6 +34813,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -37205,6 +37212,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -38017,6 +38025,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -42227,6 +42236,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -43039,6 +43049,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -44170,6 +44181,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -47981,6 +47993,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -51786,6 +51799,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -55589,6 +55603,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -59378,6 +59393,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -63191,6 +63207,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -66980,6 +66997,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -70780,6 +70798,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -74580,6 +74599,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -79308,6 +79328,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -80423,6 +80444,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -81966,6 +81988,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -89287,6 +89310,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -90305,6 +90329,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -144655,6 +144680,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -146535,6 +146561,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -147862,6 +147889,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -149656,6 +149684,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -151608,6 +151637,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -161307,6 +161337,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -162748,6 +162779,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -164234,6 +164266,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -177594,6 +177627,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -186804,6 +186838,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -216214,7 +216249,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", + "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers (Okta, for example), the user GDPR data in the SCIM metadata will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -238186,6 +238221,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -241394,6 +241430,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -244524,6 +244561,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -247587,6 +247625,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -250616,6 +250655,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -253425,6 +253465,7 @@ "enum": [ "completed", "not_planned", + "duplicate", "reopened", null ] @@ -253717,6 +253758,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -257110,6 +257152,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -260508,6 +260551,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -263529,6 +263573,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -271242,6 +271287,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -276006,6 +276052,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -306063,6 +306110,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -320126,6 +320174,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -324152,6 +324201,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -340645,6 +340695,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -341111,6 +341180,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -342151,6 +342239,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -342600,6 +342707,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -343055,6 +343181,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -348307,6 +348452,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -350025,6 +350171,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -360688,6 +360835,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -361941,6 +362089,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -363142,6 +363291,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -365237,6 +365387,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -366470,6 +366621,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -367720,6 +367872,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -369777,6 +369930,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -371030,6 +371184,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -372298,6 +372453,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -431030,6 +431186,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -431173,6 +431330,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -431849,6 +432013,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -431989,6 +432154,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -432720,6 +432892,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -432860,6 +433033,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -433470,6 +433650,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -433610,6 +433791,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -434223,6 +434411,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -434363,6 +434552,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -435033,6 +435229,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -435173,6 +435370,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -438329,6 +438533,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -443124,6 +443329,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -447781,6 +447987,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -448013,7 +448220,7 @@ { "type": "object", "name": "advanced_security", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"About GitHub Advanced\nSecurity.\"

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -452663,6 +452870,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -455893,6 +456101,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -460738,6 +460947,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -461729,6 +461939,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -467746,6 +467957,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -468853,6 +469065,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -474454,6 +474667,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -479091,6 +479305,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -491077,6 +491292,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -492591,6 +492807,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -509904,6 +510121,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -515672,6 +515890,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { 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 e76a3fc28f5a..4f50fb93bf8f 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 @@ -7375,6 +7375,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -12522,6 +12523,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -26002,6 +26004,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -31275,6 +31278,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -32099,6 +32103,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34055,6 +34060,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34879,6 +34885,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -37289,6 +37296,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -38113,6 +38121,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -42341,6 +42350,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -43165,6 +43175,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -44308,6 +44319,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -48131,6 +48143,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -51948,6 +51961,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -55763,6 +55777,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -59564,6 +59579,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -63389,6 +63405,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -67190,6 +67207,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -71002,6 +71020,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -74814,6 +74833,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -79554,6 +79574,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -80681,6 +80702,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -82236,6 +82258,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -89572,6 +89595,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -90605,6 +90629,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -145269,6 +145294,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -147167,6 +147193,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -148506,6 +148533,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -150318,6 +150346,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -152288,6 +152317,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -165434,6 +165464,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -166887,6 +166918,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -168385,6 +168417,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -181757,6 +181790,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -190979,6 +191013,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -219111,7 +219146,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", + "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers (Okta, for example), the user GDPR data in the SCIM metadata will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -241107,6 +241142,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -244321,6 +244357,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -247457,6 +247494,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -250526,6 +250564,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -253561,6 +253600,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -256376,6 +256416,7 @@ "enum": [ "completed", "not_planned", + "duplicate", "reopened", null ] @@ -256668,6 +256709,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -260067,6 +260109,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -263471,6 +263514,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -266498,6 +266542,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -274247,6 +274292,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -279023,6 +279069,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -309266,6 +309313,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -323356,6 +323404,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -327397,6 +327446,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -343974,6 +344024,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -344440,6 +344509,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -345480,6 +345568,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -345929,6 +346036,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -346384,6 +346510,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -351666,6 +351811,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -353399,6 +353545,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -364536,6 +364683,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -365801,6 +365949,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -367014,6 +367163,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -369121,6 +369271,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -370366,6 +370517,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -371628,6 +371780,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -373697,6 +373850,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -374962,6 +375116,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -376242,6 +376397,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -434986,6 +435142,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -435129,6 +435286,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -435805,6 +435969,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -435945,6 +436110,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -436676,6 +436848,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -436816,6 +436989,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -437426,6 +437606,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -437566,6 +437747,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -438179,6 +438367,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -438319,6 +438508,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -438989,6 +439185,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -439129,6 +439326,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -442288,6 +442492,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -447095,6 +447300,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -451767,6 +451973,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -452011,7 +452218,7 @@ { "type": "object", "name": "advanced_security", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"About GitHub Advanced\nSecurity.\"

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -456673,6 +456880,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -459915,6 +460123,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -464772,6 +464981,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -465775,6 +465985,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -471804,6 +472015,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -472926,6 +473138,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -478539,6 +478752,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -483188,6 +483402,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -495751,6 +495966,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -497277,6 +497493,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -514748,6 +514965,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -520531,6 +520749,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { 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 b2bfbf3674ee..d13aba38b6ba 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 @@ -7375,6 +7375,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -12522,6 +12523,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -26002,6 +26004,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -31275,6 +31278,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -32099,6 +32103,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34055,6 +34060,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34879,6 +34885,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -37289,6 +37296,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -38113,6 +38121,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -42341,6 +42350,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -43165,6 +43175,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -44308,6 +44319,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -48131,6 +48143,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -51948,6 +51961,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -55763,6 +55777,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -59564,6 +59579,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -63389,6 +63405,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -67190,6 +67207,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -71002,6 +71020,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -74814,6 +74833,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -79554,6 +79574,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -80681,6 +80702,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -82236,6 +82258,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -89572,6 +89595,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -90605,6 +90629,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -145367,6 +145392,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -147265,6 +147291,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -148604,6 +148631,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -150416,6 +150444,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -152386,6 +152415,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -169084,6 +169114,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -170537,6 +170568,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -172035,6 +172067,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -185407,6 +185440,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -194847,6 +194881,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -224295,7 +224330,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", + "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers (Okta, for example), the user GDPR data in the SCIM metadata will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -246338,6 +246373,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -249552,6 +249588,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -252688,6 +252725,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -255757,6 +255795,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -258792,6 +258831,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -261607,6 +261647,7 @@ "enum": [ "completed", "not_planned", + "duplicate", "reopened", null ] @@ -261899,6 +261940,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -265298,6 +265340,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -268702,6 +268745,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -271729,6 +271773,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -279478,6 +279523,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -284254,6 +284300,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -314497,6 +314544,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -328587,6 +328635,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -332628,6 +332677,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -349299,6 +349349,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -349765,6 +349834,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -350805,6 +350893,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -351254,6 +351361,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -351709,6 +351835,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -356991,6 +357136,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -358724,6 +358870,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -369870,6 +370017,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -371135,6 +371283,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -372348,6 +372497,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -374455,6 +374605,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -375700,6 +375851,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -376962,6 +377114,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -379031,6 +379184,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -380296,6 +380450,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -381576,6 +381731,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -385003,7 +385159,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -385230,7 +385393,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -385322,7 +385492,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ] }, { @@ -440913,6 +441090,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -441056,6 +441234,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -441732,6 +441917,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -441872,6 +442058,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -442603,6 +442796,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -442743,6 +442937,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -443353,6 +443554,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -443493,6 +443695,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -444106,6 +444315,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -444246,6 +444456,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -444916,6 +445133,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -445056,6 +445274,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -448215,6 +448440,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -453022,6 +453248,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -457694,6 +457921,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -457938,7 +458166,7 @@ { "type": "object", "name": "advanced_security", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"About GitHub Advanced\nSecurity.\"

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -462600,6 +462828,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -465842,6 +466071,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -470699,6 +470929,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -471702,6 +471933,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -477731,6 +477963,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -478853,6 +479086,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -484466,6 +484700,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -489115,6 +489350,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -501687,6 +501923,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -503213,6 +503450,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -522114,6 +522352,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -527897,6 +528136,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { 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 f180482052f7..39bdb03da54d 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 @@ -7375,6 +7375,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -12534,6 +12535,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -26026,6 +26028,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -31311,6 +31314,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -32147,6 +32151,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34115,6 +34120,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -34951,6 +34957,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -37373,6 +37380,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -38209,6 +38217,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -42449,6 +42458,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -43285,6 +43295,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -44440,6 +44451,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -48263,6 +48275,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -52080,6 +52093,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -55895,6 +55909,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -59696,6 +59711,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -63521,6 +63537,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -67322,6 +67339,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -71134,6 +71152,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -74946,6 +74965,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -79686,6 +79706,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -80825,6 +80846,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -82392,6 +82414,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -89740,6 +89763,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -90785,6 +90809,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -145602,6 +145627,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -147512,6 +147538,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -148863,6 +148890,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -150687,6 +150715,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -152669,6 +152698,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -169751,6 +169781,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -171216,6 +171247,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -172726,6 +172758,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -186156,6 +186189,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -195608,6 +195642,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -225097,7 +225132,7 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", + "descriptionHTML": "

Note

\n

\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.

\n
\n

Update a provisioned user's individual attributes.

\n

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

\n

Note

\n

\nComplicated SCIM path selectors that include filters are not supported. For example, a path selector defined as \"path\": \"emails[type eq \\\"work\\\"]\" will not work.

\n
\n

Warning

\n

\nSetting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers (Okta, for example), the user GDPR data in the SCIM metadata will not be purged and the credentials will not be removed.

\n
{\n  \"Operations\":[{\n    \"op\":\"replace\",\n    \"value\":{\n      \"active\":false\n    }\n  }]\n}\n
\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -247245,6 +247280,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -250459,6 +250495,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -253595,6 +253632,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -256664,6 +256702,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -259699,6 +259738,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -262514,6 +262554,7 @@ "enum": [ "completed", "not_planned", + "duplicate", "reopened", null ] @@ -262806,6 +262847,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -266205,6 +266247,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -269609,6 +269652,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -272636,6 +272680,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -280385,6 +280430,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -285161,6 +285207,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -315404,6 +315451,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ], "examples": [ @@ -329501,6 +329549,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -333554,6 +333603,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -350682,6 +350732,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -351148,6 +351217,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -352188,6 +352276,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -352637,6 +352744,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -353092,6 +353218,25 @@ "admin" ] }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "examples": [ + true + ] + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "examples": [ + "ent:team-one", + "ent:team-two" + ] + }, "organization_url": { "type": "string", "format": "uri", @@ -358374,6 +358519,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -360119,6 +360265,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -372079,6 +372226,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -373356,6 +373504,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -374581,6 +374730,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -376700,6 +376850,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -377957,6 +378108,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -379231,6 +379383,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -381312,6 +381465,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -382589,6 +382743,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -383881,6 +384036,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -387320,7 +387476,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -387547,7 +387710,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ], "type": "string" }, @@ -387639,7 +387809,14 @@ "enum": [ "maven_repository", "nuget_feed", - "goproxy_server" + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry" ] }, { @@ -443238,6 +443415,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -443381,6 +443559,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -444057,6 +444242,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -444197,6 +444383,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -444928,6 +445121,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -445068,6 +445262,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -445678,6 +445879,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -445818,6 +446020,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -446431,6 +446640,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -446571,6 +446781,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -447241,6 +447458,7 @@ "body": "Description of the release", "draft": false, "prerelease": false, + "immutable": false, "created_at": "2013-02-27T19:35:32Z", "published_at": "2013-02-27T19:35:32Z", "author": { @@ -447381,6 +447599,13 @@ false ] }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean", + "examples": [ + false + ] + }, "created_at": { "type": "string", "format": "date-time" @@ -450540,6 +450765,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -455359,6 +455585,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -460043,6 +460270,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -460299,7 +460527,7 @@ { "type": "object", "name": "advanced_security", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"About GitHub Advanced\nSecurity.\"

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -464973,6 +465201,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -468227,6 +468456,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -473096,6 +473326,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -474111,6 +474342,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -480152,6 +480384,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -481286,6 +481519,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -487721,6 +487955,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -492382,6 +492617,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -506006,6 +506242,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -507551,6 +507788,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -527915,6 +528153,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { @@ -533710,6 +533949,7 @@ ], "properties": { "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 92ac14a55511..d54d81429f4c 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "664cf25da36ebb8f97693e51663addaed26bbae5" + "sha": "b15fded1fc5fc6dcd68dd0425385625ee2e819a4" } \ No newline at end of file diff --git a/src/search/components/input/AISearchCTAPopup.tsx b/src/search/components/input/AISearchCTAPopup.tsx index 1aeabbe69bb7..7d0909d205f2 100644 --- a/src/search/components/input/AISearchCTAPopup.tsx +++ b/src/search/components/input/AISearchCTAPopup.tsx @@ -16,12 +16,14 @@ export function AISearchCTAPopup({ setIsSearchOpen, isDismissible = true, bannerType = 'popover', + instanceId = '', }: { isOpen: boolean dismiss?: () => void setIsSearchOpen: (value: boolean) => void isDismissible?: boolean bannerType?: 'popover' | 'footer' + instanceId?: string }) { const { t } = useTranslation('search') const { permanentDismiss } = useCTAPopoverContext() @@ -90,7 +92,7 @@ export function AISearchCTAPopup({ /> 0 ? ( <> - + (null) - useEffect(() => { - if (!atMediumViewport && isSearchOpen) { - // This adds focus in particular for iOS to focus and bring - // up the keyboard when you touch the search input text area. - inputRef.current?.focus() - } - }, [atMediumViewport, isSearchOpen]) - - return ( -
-
-
{ - event.preventDefault() - if (!localQuery.trim()) return - - sendEvent({ - type: EventType.search, - search_query: localQuery, - search_context: GENERAL_SEARCH_CONTEXT, - }) - - redirectSearch() - }} - > - - - - -
-
- ) -} diff --git a/src/search/components/input/SearchBarButton.tsx b/src/search/components/input/SearchBarButton.tsx index d8640750e61f..524bc760cdc4 100644 --- a/src/search/components/input/SearchBarButton.tsx +++ b/src/search/components/input/SearchBarButton.tsx @@ -14,9 +14,16 @@ type Props = { setIsSearchOpen: (value: boolean) => void params: QueryParams searchButtonRef: React.RefObject + instanceId?: string } -export function SearchBarButton({ isSearchOpen, setIsSearchOpen, params, searchButtonRef }: Props) { +export function SearchBarButton({ + isSearchOpen, + setIsSearchOpen, + params, + searchButtonRef, + instanceId, +}: Props) { const { t } = useTranslation('search') const { isOpen, dismiss } = useCTAPopoverContext() @@ -42,15 +49,20 @@ export function SearchBarButton({ isSearchOpen, setIsSearchOpen, params, searchB const placeHolderElements = t('search.input.placeholder') .split(/({{[^}]+}})/) .filter((item) => item.trim() !== '') - .map((item) => <>{item.trim()}) - placeHolderElements[1] = + .map((item, index) => {item.trim()}) + placeHolderElements[1] = return ( <> {/* We don't want to show the input when overlay is open */} {!isSearchOpen ? ( <> - + {/* On mobile only the IconButton is shown */} =3.18' isPublic: true isPrivateWithGhas: true - hasPushProtection: false + hasPushProtection: true hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Yandex diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index ec24b2bd2adb..263a57948664 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,5 +1,5 @@ { - "sha": "feedd2ca729f955bcd0ca1ec16d7ed00874dc9cb", - "blob-sha": "cb3a0e220b9ccc9c248b2a0be0dbeeb37bdd1d50", + "sha": "aac09ec57fa0c6167e20c7d9895d56caa97f4f5f", + "blob-sha": "9d7b8f2eaea28aab49e0f9d4190b9cd16cfcbc1f", "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file diff --git a/src/types.ts b/src/types.ts index 23d60c353dfb..1f78aa94c714 100644 --- a/src/types.ts +++ b/src/types.ts @@ -323,6 +323,7 @@ export type Permalink = { pageVersion: string title: string href: string + hrefWithoutLanguage: string } export type FrontmatterVersions = { @@ -361,6 +362,7 @@ export type Page = { effectiveDate?: string fullTitle?: string render: (context: Context) => Promise + buildRedirects: () => Record octicon?: string category?: string[] complexity?: string[] diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 20290a9c96e2..1c507ab979dd 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -2283,7 +2283,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -3932,7 +3932,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -5582,7 +5582,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -7244,7 +7244,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -88423,6 +88423,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -88642,6 +88652,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -89246,6 +89266,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -89484,6 +89514,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -202988,6 +203028,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -203559,6 +203605,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -204191,6 +204243,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -204559,6 +204617,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -204930,6 +204994,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -205500,6 +205570,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -205868,6 +205944,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -222077,7 +222159,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -226278,6 +226360,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -229039,6 +229122,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -231046,6 +231130,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -233807,6 +233892,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -235814,6 +235900,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -238575,6 +238662,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -240582,6 +240670,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -243343,6 +243432,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 7c01e0b3e6e0..b36b05369149 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -4393,7 +4393,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -6058,7 +6058,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -7724,7 +7724,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -9402,7 +9402,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -92084,6 +92084,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -92303,6 +92313,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -92907,6 +92927,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -93145,6 +93175,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -206649,6 +206689,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -207220,6 +207266,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -207852,6 +207904,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -208220,6 +208278,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -208591,6 +208655,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -209161,6 +209231,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -209529,6 +209605,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -225741,7 +225823,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -229958,6 +230040,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -232719,6 +232802,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -234726,6 +234810,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -237487,6 +237572,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -239494,6 +239580,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -242255,6 +242342,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -244262,6 +244350,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, @@ -247023,6 +247112,7 @@ "completed", "reopened", "not_planned", + "duplicate", null ] }, diff --git a/src/webhooks/data/ghes-3.13/schema.json b/src/webhooks/data/ghes-3.13/schema.json index 6d6aabae127b..7df3ed3a5072 100644 --- a/src/webhooks/data/ghes-3.13/schema.json +++ b/src/webhooks/data/ghes-3.13/schema.json @@ -2272,7 +2272,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -3858,7 +3858,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -5445,7 +5445,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -7044,7 +7044,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -81980,6 +81980,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -82199,6 +82209,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -82803,6 +82823,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -83041,6 +83071,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -189178,6 +189218,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -189749,6 +189795,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -190381,6 +190433,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -190749,6 +190807,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -191120,6 +191184,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -191690,6 +191760,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -192058,6 +192134,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -201989,7 +202071,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 0cdbc2ab918f..9bbebfb6fcc0 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -3327,7 +3327,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -4913,7 +4913,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -6500,7 +6500,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -8099,7 +8099,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -83048,6 +83048,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -83267,6 +83277,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -83871,6 +83891,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -84109,6 +84139,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -190246,6 +190286,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -190817,6 +190863,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -191449,6 +191501,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -191817,6 +191875,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -192188,6 +192252,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -192758,6 +192828,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -193126,6 +193202,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -203468,7 +203550,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index a3d7cddd1fd8..846bf707794b 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -3416,7 +3416,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -5028,7 +5028,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -6641,7 +6641,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -8266,7 +8266,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -83231,6 +83231,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -83450,6 +83460,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -84054,6 +84074,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -84292,6 +84322,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -190429,6 +190469,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -191000,6 +191046,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -191632,6 +191684,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -192000,6 +192058,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -192371,6 +192435,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -192941,6 +193011,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -193309,6 +193385,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -204113,7 +204195,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index 06346dd40db9..48b291c31f27 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -4471,7 +4471,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -6083,7 +6083,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -7696,7 +7696,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -9321,7 +9321,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -84415,6 +84415,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -84634,6 +84644,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -85238,6 +85258,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -85476,6 +85506,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -191613,6 +191653,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -192184,6 +192230,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -192816,6 +192868,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -193184,6 +193242,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -193555,6 +193619,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -194125,6 +194195,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -194493,6 +194569,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -206200,7 +206282,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index 466edc60e5e3..f501849b0941 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -4471,7 +4471,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -6099,7 +6099,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -7728,7 +7728,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -9369,7 +9369,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", @@ -85966,6 +85966,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -86185,6 +86195,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -86789,6 +86809,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -87027,6 +87057,16 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "direct_membership", + "description": "

Whether the user has direct membership in the organization.

" + }, + { + "type": "array of strings", + "name": "enterprise_teams_providing_indirect_membership", + "description": "

The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.

" + }, { "type": "string", "name": "state", @@ -193164,6 +193204,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -193735,6 +193781,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -194367,6 +194419,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -194735,6 +194793,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -195106,6 +195170,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -195676,6 +195746,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -196044,6 +196120,12 @@ "description": "", "isRequired": true }, + { + "type": "boolean", + "name": "immutable", + "description": "

Whether or not the release is immutable.

", + "isRequired": true + }, { "type": "string or null", "name": "name", @@ -208549,7 +208631,7 @@ { "type": "object", "name": "advanced_security", - "description": "", + "description": "

Enable or disable GitHub Advanced Security for the repository.

\n

For standalone Code Scanning or Secret Protection products, this parameter cannot be used.

", "childParamsGroups": [ { "type": "string", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 410b359640df..1c58a484e055 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "664cf25da36ebb8f97693e51663addaed26bbae5" + "sha": "b15fded1fc5fc6dcd68dd0425385625ee2e819a4" } \ No newline at end of file