diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b5f0ccbfe..2fa7a86b9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -25,11 +25,3 @@ Thanks again! - [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**) - [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) - [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md). - -### Writer impact (This section is for GitHub staff members only): - -- [ ] This pull request impacts the contribution experience - - [ ] I have added the 'writer impact' label - - [ ] I have added a description and/or a video demo of the changes below (eg. a "before and after video") - - diff --git a/.github/workflows/copy-api-issue-to-internal.yml b/.github/workflows/copy-api-issue-to-internal.yml deleted file mode 100644 index db8d822cb..000000000 --- a/.github/workflows/copy-api-issue-to-internal.yml +++ /dev/null @@ -1,69 +0,0 @@ -name: Copy to REST API issue to docs-content - -# **What it does**: Copies an issue in the open source repo to the docs-content repo, comments on and closes the original issue -# **Why we have it**: REST API updates cannot be made in the open source repo. Instead, we copy the issue to an internal issue (we do not transfer so that the issue does not disappear for the contributor) and close the original issue. -# **Who does it impact**: Open source and docs-content maintainers - -on: - issues: - types: - - labeled - -jobs: - transfer-issue: - name: Transfer issue - runs-on: ubuntu-latest - if: github.event.label.name == 'rest-description' && github.repository == 'github/docs' - steps: - - name: Check if this run was triggered by a member of the docs team - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - id: triggered-by-member - with: - github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - result-encoding: string - script: | - const triggerer_login = context.payload.sender.login - const teamMembers = await github.request( - `/orgs/github/teams/docs/members?per_page=100` - ) - const logins = teamMembers.data.map(member => member.login) - if (logins.includes(triggerer_login)) { - console.log(`This workflow was triggered by ${triggerer_login} (on the docs team).`) - return 'true' - } - console.log(`This workflow was triggered by ${triggerer_login} (not on the docs team), so no action will be taken.`) - return 'false' - - - name: Exit if not triggered by a docs team member - if: steps.triggered-by-member.outputs.result == 'false' - run: | - echo Aborting. This workflow must be triggered by a member of the docs team. - exit 1 - - - name: Create an issue in the docs-content repo - run: | - new_issue_url="$(gh issue create --title "$ISSUE_TITLE" --body "$ISSUE_BODY" --repo github/docs-content)" - echo 'NEW_ISSUE='$new_issue_url >> $GITHUB_ENV - env: - GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - ISSUE_TITLE: ${{ github.event.issue.title }} - ISSUE_BODY: ${{ github.event.issue.body }} - - - name: Comment on the new issue - run: gh issue comment $NEW_ISSUE --body "This issue was originally opened in the open source repo as $OLD_ISSUE" - env: - GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - NEW_ISSUE: ${{ env.NEW_ISSUE }} - OLD_ISSUE: ${{ github.event.issue.html_url }} - - - name: Comment on the old issue - run: gh issue comment $OLD_ISSUE --body "Thank you for opening this issue! Updates to the REST API description must be made internally. I have copied your issue to an internal issue, so I will close this issue." - env: - GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - OLD_ISSUE: ${{ github.event.issue.html_url }} - - - name: Close the old issue - run: gh issue close $OLD_ISSUE - env: - GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - OLD_ISSUE: ${{ github.event.issue.html_url }} diff --git a/.github/workflows/move-ready-to-merge-pr.yaml b/.github/workflows/move-ready-to-merge-issues.yaml similarity index 66% rename from .github/workflows/move-ready-to-merge-pr.yaml rename to .github/workflows/move-ready-to-merge-issues.yaml index 9986e0b8a..014822f0a 100644 --- a/.github/workflows/move-ready-to-merge-pr.yaml +++ b/.github/workflows/move-ready-to-merge-issues.yaml @@ -1,7 +1,7 @@ -name: Move and unlabel ready to merge PRs +name: Move and unlabel ready to merge issues -# **What it does**: When a PR in the open source repo is labeled "ready to merge," the "waiting for review" label is removed and the PR is moved to the "Triage" column. -# **Why we have it**: To help with managing our project boards. +# **What it does**: This moves ready to merge issues on the project board for the open source repo. When an issue in the open source repo is labeled "ready to merge," the "waiting for review" label is removed and the issue is moved to the "Triage" column. +# **Why we have it**: To help with managing our project boards. # **Who does it impact**: Open source contributors, open-source maintainers. on: @@ -14,7 +14,7 @@ jobs: if: github.repository == 'github/docs' && github.event.label.name == 'ready to merge' runs-on: ubuntu-latest steps: - - name: move PR + - name: move issue uses: alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9 with: project: Docs team reviews diff --git a/.github/workflows/no-response.yaml b/.github/workflows/no-response.yaml index 59a5b8bee..1e4052061 100644 --- a/.github/workflows/no-response.yaml +++ b/.github/workflows/no-response.yaml @@ -9,7 +9,7 @@ name: No Response on: issue_comment: - types: [created] + types: created schedule: # Schedule for five minutes after the hour every hour @@ -27,6 +27,4 @@ jobs: to our request for more information from the original author. With only the information that is currently in the issue, we don't have enough information to take action. Please reach out if you have or find the answers we need so - that we can investigate further. See [this blog post on bug reports and the - importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/) - for more information about the kind of information that may be helpful. + that we can investigate further. See [this blog post on bug reports and the importance of repro steps](https://www.lee-dohm.com/2015/01/04/writing-good-bug-reports/) for more information about the kind of information that may be helpful. diff --git a/.github/workflows/site-policy-sync.yml b/.github/workflows/site-policy-sync.yml index 12bb02ffb..e1a3a1d7b 100644 --- a/.github/workflows/site-policy-sync.yml +++ b/.github/workflows/site-policy-sync.yml @@ -1,8 +1,8 @@ name: site-policy-sync -# **What it does**: Updates our site-policy repo when changes happen to site policy docs. -# **Why we have it**: We want keep site-policy repo up to date. -# **Who does it impact**: Site-policy team. +# **What it does**: Updates our site policy docs when changes happen to site policy. +# **Why we have it**: We want up to date site policy docs. +# **Who does it impact**: Site policy team. # Controls when the action will run. on: @@ -30,10 +30,6 @@ jobs: steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f - # Sets commit message - - name: custom message - run: | - echo "MESSAGE=${{github.event.pull_request.title}}" >> $GITHUB_ENV # Pushes to other repo - name: Push folder to another repository @@ -46,6 +42,6 @@ jobs: destination_branch: 'main' destination_branch_create: 'repo-sync' destination_folder: 'Policies' - user_email: 'site-policy-bot@users.noreply.github.com' - user_name: 'site-policy-bot' - commit_msg: '${{ env.MESSAGE }}' + user_email: 'pcihon@users.noreply.github.com' + user_name: 'pcihon' + commit_msg: 'Automatic sync from GitHub Docs.' diff --git a/.github/workflows/transfer-api-issue-to-openapi.yml b/.github/workflows/transfer-api-issue-to-openapi.yml deleted file mode 100644 index fac0bf96b..000000000 --- a/.github/workflows/transfer-api-issue-to-openapi.yml +++ /dev/null @@ -1,55 +0,0 @@ -name: Transfer REST API issue to rest-api-description - -# **What it does**: Transfers an issue in the open source repo to the open source rest-api-description repo -# **Why we have it**: Requests to change the OpenAPI schema (unless the schema is just a description update) should be made in github/rest-api-description -# **Who does it impact**: Open source and docs-content maintainers - -on: - issues: - types: - - labeled - -jobs: - transfer-issue: - name: Transfer issue - runs-on: ubuntu-latest - if: github.event.label.name == 'rest-schema' && github.repository == 'github/docs' - steps: - - name: Check if this run was triggered by a member of the docs team - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - id: triggered-by-member - with: - github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - result-encoding: string - script: | - const triggerer_login = context.payload.sender.login - const teamMembers = await github.request( - `/orgs/github/teams/docs/members?per_page=100` - ) - const logins = teamMembers.data.map(member => member.login) - if (logins.includes(triggerer_login)) { - console.log(`This workflow was triggered by ${triggerer_login} (on the docs team).`) - return 'true' - } - console.log(`This workflow was triggered by ${triggerer_login} (not on the docs team), so no action will be taken.`) - return 'false' - - - name: Exit if not triggered by a docs team member - if: steps.triggered-by-member.outputs.result == 'false' - run: | - echo Aborting. This workflow must be triggered by a member of the docs team. - exit 1 - - - name: Comment on the old issue - run: gh issue comment $OLD_ISSUE --body "Thank you for opening this issue! Changes to the REST API schema can be requested in [github/rest-api-description](https://github.com/github/rest-api-description). I will transfer your issue over to that open source repo." - env: - GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - OLD_ISSUE: ${{ github.event.issue.html_url }} - - - name: Transfer the issue to the rest-api-description repo - run: | - new_issue_url="$(gh issue transfer $OLD_ISSUE github/rest-api-description)" - echo 'NEW_ISSUE='$new_issue_url >> $GITHUB_ENV - env: - GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} - OLD_ISSUE: ${{ github.event.issue.html_url }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f65ef1d11..20fa5bdae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,8 +95,6 @@ A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and When we merge those changes, they should be deployed to the live site within 24 hours. :earth_africa: To learn more about opening a pull request in this repo, see [Opening a pull request](#opening-a-pull-request) below. -We cannot accept contributions to the [REST API reference documentation](https://docs.github.com/en/rest/reference). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [github/rest-api-description](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository. - ### :question: Support We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with GitHub, unrelated to our documentation, please [contact GitHub Support directly](https://support.github.com/contact). Any issues, discussions, or pull requests opened here requesting support will be given information about how to contact GitHub Support, then closed and locked. diff --git a/assets/images/help/codespaces/vscode-change-machine-choose-repo.png b/assets/images/help/codespaces/vscode-change-machine-choose-repo.png deleted file mode 100644 index b64b5949d..000000000 Binary files a/assets/images/help/codespaces/vscode-change-machine-choose-repo.png and /dev/null differ diff --git a/assets/images/help/codespaces/vscode-change-machine-choose-type.png b/assets/images/help/codespaces/vscode-change-machine-choose-type.png deleted file mode 100644 index 96a27335f..000000000 Binary files a/assets/images/help/codespaces/vscode-change-machine-choose-type.png and /dev/null differ diff --git a/assets/images/help/codespaces/vscode-change-machine-type-option.png b/assets/images/help/codespaces/vscode-change-machine-type-option.png deleted file mode 100644 index 021eff1d4..000000000 Binary files a/assets/images/help/codespaces/vscode-change-machine-type-option.png and /dev/null differ diff --git a/assets/images/help/profile/badge-arctic-code-vault-small.png b/assets/images/help/profile/badge-arctic-code-vault-small.png deleted file mode 100644 index 2956f872f..000000000 Binary files a/assets/images/help/profile/badge-arctic-code-vault-small.png and /dev/null differ diff --git a/assets/images/help/profile/badge-mars-2020-small.png b/assets/images/help/profile/badge-mars-2020-small.png deleted file mode 100644 index 1a757124a..000000000 Binary files a/assets/images/help/profile/badge-mars-2020-small.png and /dev/null differ diff --git a/assets/images/help/profile/badge-sponsors-small.png b/assets/images/help/profile/badge-sponsors-small.png deleted file mode 100644 index ce45811a6..000000000 Binary files a/assets/images/help/profile/badge-sponsors-small.png and /dev/null differ diff --git a/assets/images/help/profile/profile-badge-settings.png b/assets/images/help/profile/profile-badge-settings.png deleted file mode 100644 index 570f43f52..000000000 Binary files a/assets/images/help/profile/profile-badge-settings.png and /dev/null differ diff --git a/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png b/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png deleted file mode 100644 index c142169c7..000000000 Binary files a/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png and /dev/null differ diff --git a/assets/images/help/repository/repo-transfer-complete.png b/assets/images/help/repository/repo-transfer-complete.png index 1224f6a1f..c33bd0a9a 100644 Binary files a/assets/images/help/repository/repo-transfer-complete.png and b/assets/images/help/repository/repo-transfer-complete.png differ diff --git a/assets/images/help/repository/repo-transfer-free-plan-warnings.png b/assets/images/help/repository/repo-transfer-free-plan-warnings.png index 59bc8de07..773476309 100644 Binary files a/assets/images/help/repository/repo-transfer-free-plan-warnings.png and b/assets/images/help/repository/repo-transfer-free-plan-warnings.png differ diff --git a/assets/images/help/settings/actions-workflow-permissions-enterprise.png b/assets/images/help/settings/actions-workflow-permissions-enterprise.png deleted file mode 100644 index 408d7be4c..000000000 Binary files a/assets/images/help/settings/actions-workflow-permissions-enterprise.png and /dev/null differ diff --git a/assets/images/help/settings/actions-workflow-permissions-organization.png b/assets/images/help/settings/actions-workflow-permissions-organization.png deleted file mode 100644 index 8c234f7fd..000000000 Binary files a/assets/images/help/settings/actions-workflow-permissions-organization.png and /dev/null differ diff --git a/assets/images/help/settings/actions-workflow-permissions-repository.png b/assets/images/help/settings/actions-workflow-permissions-repository.png deleted file mode 100644 index 6ff49cae9..000000000 Binary files a/assets/images/help/settings/actions-workflow-permissions-repository.png and /dev/null differ diff --git a/assets/images/help/settings/codespaces-image-registry-secret-example.png b/assets/images/help/settings/codespaces-image-registry-secret-example.png deleted file mode 100644 index 4d3a03c26..000000000 Binary files a/assets/images/help/settings/codespaces-image-registry-secret-example.png and /dev/null differ diff --git a/assets/images/help/sponsors/example-of-open-source-project-dependency.png b/assets/images/help/sponsors/example-of-open-source-project-dependency.png deleted file mode 100644 index c395f164f..000000000 Binary files a/assets/images/help/sponsors/example-of-open-source-project-dependency.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsors-earch-options.png b/assets/images/help/sponsors/sponsors-earch-options.png deleted file mode 100644 index de92ba338..000000000 Binary files a/assets/images/help/sponsors/sponsors-earch-options.png and /dev/null differ diff --git a/assets/images/help/sponsors/sponsors-search-options.png b/assets/images/help/sponsors/sponsors-search-options.png deleted file mode 100644 index de92ba338..000000000 Binary files a/assets/images/help/sponsors/sponsors-search-options.png and /dev/null differ diff --git a/content/actions/guides/about-continuous-integration.md b/content/actions/guides/about-continuous-integration.md index afc06b4bd..305d9cbde 100644 --- a/content/actions/guides/about-continuous-integration.md +++ b/content/actions/guides/about-continuous-integration.md @@ -53,7 +53,6 @@ For a definition of common terms, see "[Core concepts for {% data variables.prod Browse the complete list of CI workflow templates offered by {% data variables.product.product_name %} in the {% if currentVersion == "free-pro-team@latest" %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@next" %} ### Skipping workflow runs If you want to temporarily prevent a workflow from being triggered, you can add a skip instruction to the commit message. Workflows that would otherwise be triggered `on: push` or `on: pull_request`, won't be triggered if you add any any of the following strings to the commit message in a push, or the HEAD commit of a pull request: @@ -73,7 +72,6 @@ You won't be able to merge the pull request if your repository is configured to **Note:** Skip instructions only apply to the `push` and `pull_request` events. For example, adding `[skip ci]` to a commit message won't stop a workflow that's triggered `on: pull_request_target` from running. {% endnote %} -{% endif %} ### Notifications for workflow runs diff --git a/content/actions/guides/adding-labels-to-issues.md b/content/actions/guides/adding-labels-to-issues.md index 65696f7d1..618af66b8 100644 --- a/content/actions/guides/adding-labels-to-issues.md +++ b/content/actions/guides/adding-labels-to-issues.md @@ -29,6 +29,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l 2. {% data reusables.actions.make-workflow-file %} 3. Copy the following YAML contents into your workflow file. + {% raw %} ```yaml{:copy} name: Label issues on: @@ -38,17 +39,14 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l - opened jobs: label_issues: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - issues: write{% endif %} + runs-on: ubuntu-latest steps: - name: Label issues uses: andymckay/labeler@1.0.2 with: add-labels: "triage" - repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} ``` - + {% endraw %} 4. Customize the parameters in your workflow file: - Change the value for `add-labels` to the list of labels that you want to add to the issue. Separate multiple labels with commas. For example, `"help wanted, good first issue"`. For more information about labels, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." 5. {% data reusables.actions.commit-workflow %} diff --git a/content/actions/guides/building-and-testing-net.md b/content/actions/guides/building-and-testing-net.md index d734043f7..a8c32c9ca 100644 --- a/content/actions/guides/building-and-testing-net.md +++ b/content/actions/guides/building-and-testing-net.md @@ -227,6 +227,7 @@ jobs: You can configure your workflow to publish your Dotnet package to a package registry when your CI tests pass. You can use repository secrets to store any tokens or credentials needed to publish your binary. The following example creates and publishes a package to {% data variables.product.prodname_registry %} using `dotnet core cli`. +{% raw %} ```yaml name: Upload dotnet package @@ -236,10 +237,7 @@ on: jobs: deploy: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - packages: write - contents: read{% endif %} + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-dotnet@v1 @@ -247,10 +245,11 @@ jobs: dotnet-version: '3.1.x' # SDK Version to use. source-url: https://nuget.pkg.github.com//index.json env: - NUGET_AUTH_TOKEN: {% raw %}${{secrets.GITHUB_TOKEN}}{% endraw %} + NUGET_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}} - run: dotnet build --configuration Release - name: Create the package run: dotnet pack --configuration Release - name: Publish the package to GPR run: dotnet nuget push /bin/Release/*.nupkg ``` +{% endraw %} diff --git a/content/actions/guides/building-and-testing-ruby.md b/content/actions/guides/building-and-testing-ruby.md index d450f2450..79faf88e3 100644 --- a/content/actions/guides/building-and-testing-ruby.md +++ b/content/actions/guides/building-and-testing-ruby.md @@ -264,6 +264,7 @@ You can configure your workflow to publish your Ruby package to any package regi You can store any access tokens or credentials needed to publish your package using repository secrets. The following example creates and publishes a package to `GitHub Package Registry` and `RubyGems`. +{% raw %} ```yaml name: Ruby Gem @@ -280,12 +281,9 @@ on: jobs: build: name: Build + Publish - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - packages: write - contents: read{% endif %} + runs-on: ubuntu-latest - steps:{% raw %} + steps: - uses: actions/checkout@v2 - name: Set up Ruby 2.6 uses: ruby/setup-ruby@v1 @@ -314,5 +312,6 @@ jobs: gem build *.gemspec gem push *.gem env: - GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"{% endraw %} + GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}" ``` +{% endraw %} diff --git a/content/actions/guides/closing-inactive-issues.md b/content/actions/guides/closing-inactive-issues.md index 9df2821fb..461ef0aca 100644 --- a/content/actions/guides/closing-inactive-issues.md +++ b/content/actions/guides/closing-inactive-issues.md @@ -29,6 +29,7 @@ In the tutorial, you will first make a workflow file that uses the [`actions/sta 2. {% data reusables.actions.make-workflow-file %} 3. Copy the following YAML contents into your workflow file. + {% raw %} ```yaml{:copy} name: Close inactive issues on: @@ -37,10 +38,7 @@ In the tutorial, you will first make a workflow file that uses the [`actions/sta jobs: close-issues: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - issues: write - pull-requests: write{% endif %} + runs-on: ubuntu-latest steps: - uses: actions/stale@v3 with: @@ -51,9 +49,9 @@ In the tutorial, you will first make a workflow file that uses the [`actions/sta close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale." days-before-pr-stale: -1 days-before-pr-close: -1 - repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + repo-token: ${{ secrets.GITHUB_TOKEN }} ``` - + {% endraw %} 4. Customize the parameters in your workflow file: - Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every day at 1:30 UTC. For more information about scheduled workflows, see "[Scheduled events](/actions/reference/events-that-trigger-workflows#scheduled-events)." - Change the value for `days-before-issue-stale` to the number of days without activity before the `actions/stale` action labels an issue. If you never want this action to label issues, set this value to `-1`. diff --git a/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md b/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md index 092804c1a..50f5ad45a 100644 --- a/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md +++ b/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md @@ -29,6 +29,7 @@ In the tutorial, you will first make a workflow file that uses the [`peter-evans 2. {% data reusables.actions.make-workflow-file %} 3. Copy the following YAML contents into your workflow file. + {% raw %} ```yaml{:copy} name: Add comment on: @@ -38,18 +39,16 @@ In the tutorial, you will first make a workflow file that uses the [`peter-evans jobs: add-comment: if: github.event.label.name == 'help-wanted' - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - issues: write{% endif %} + runs-on: ubuntu-latest steps: - name: Add comment uses: peter-evans/create-or-update-comment@v1 with: - issue-number: {% raw %}${{ github.event.issue.number }}{% endraw %} + issue-number: ${{ github.event.issue.number }} body: | This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles: ``` - + {% endraw %} 4. Customize the parameters in your workflow file: - Replace `help-wanted` in `if: github.event.label.name == 'help-wanted'` with the label that you want to act on. If you want to act on more than one label, separate the conditions with `||`. For example, `if: github.event.label.name == 'bug' || github.event.label.name == 'fix me'` will comment whenever the `bug` or `fix me` labels are added to an issue. - Change the value for `body` to the comment that you want to add. GitHub flavored markdown is supported. For more information about markdown, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)." diff --git a/content/actions/guides/deploying-to-amazon-elastic-container-service.md b/content/actions/guides/deploying-to-amazon-elastic-container-service.md index 532118e62..6e32e331f 100644 --- a/content/actions/guides/deploying-to-amazon-elastic-container-service.md +++ b/content/actions/guides/deploying-to-amazon-elastic-container-service.md @@ -73,6 +73,7 @@ The following example workflow demonstrates how to build a container image and p Ensure that you provide your own values for all the variables in the `env` key of the workflow. +{% raw %} ```yaml{:copy} name: Deploy to Amazon ECS @@ -97,12 +98,9 @@ defaults: jobs: deploy: name: Deploy - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - packages: write - contents: read{% endif %} + runs-on: ubuntu-latest - {% raw %}steps: + steps: - name: Checkout uses: actions/checkout@v2 @@ -144,9 +142,9 @@ jobs: task-definition: ${{ steps.task-def.outputs.task-definition }} service: ${{ env.ECS_SERVICE }} cluster: ${{ env.ECS_CLUSTER }} - wait-for-service-stability: true{% endraw %} + wait-for-service-stability: true ``` - +{% endraw %} ### Additional resources diff --git a/content/actions/guides/managing-github-actions-with-github-cli.md b/content/actions/guides/managing-github-actions-with-github-cli.md index 51e5fec62..b337f7490 100644 --- a/content/actions/guides/managing-github-actions-with-github-cli.md +++ b/content/actions/guides/managing-github-actions-with-github-cli.md @@ -33,5 +33,5 @@ For more information on using commands in specific scenarios, see the following - "[Manually running a workflow](/actions/managing-workflow-runs/manually-running-a-workflow#running-a-workflow-using-github-cli)" - "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts#download-artifacts-through-github-cli)" - "[Using workflow run logs](/actions/managing-workflow-runs/using-workflow-run-logs#viewing-logs-through-github-cli)" -- "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history#viewing-workflow-run-history-with-github-cli)"{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} -- "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow#disabling-and-enabling-workflows-through-github-cli)"{% endif %} +- "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history#viewing-workflow-run-history-with-github-cli)" +- "[Disabling and enabling a workflow](/actions/managing-workflow-runs/disabling-and-enabling-a-workflow#disabling-and-enabling-workflows-through-github-cli)" diff --git a/content/actions/guides/publishing-docker-images.md b/content/actions/guides/publishing-docker-images.md index c09641b57..0421ca4cf 100644 --- a/content/actions/guides/publishing-docker-images.md +++ b/content/actions/guides/publishing-docker-images.md @@ -98,6 +98,7 @@ The `build-push-action` options required for {% data variables.product.prodname_ * `registry`: Must be set to `docker.pkg.github.com`. * `repository`: Must be set in the format `OWNER/REPOSITORY/IMAGE_NAME`. For example, for an image named `octo-image` stored on {% data variables.product.prodname_dotcom %} at `http://github.com/octo-org/octo-repo`, the `repository` option should be set to `octo-org/octo-repo/octo-image`. +{% raw %} ```yaml{:copy} name: Publish Docker image on: @@ -106,23 +107,21 @@ on: jobs: push_to_registry: name: Push Docker image to GitHub Packages - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - packages: write - contents: read{% endif %} + runs-on: ubuntu-latest steps: - name: Check out the repo uses: actions/checkout@v2 - name: Push to GitHub Packages uses: docker/build-push-action@v1 with: - username: {% raw %}${{ github.actor }}{% endraw %} - password: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} registry: docker.pkg.github.com repository: my-org/my-repo/my-image tag_with_ref: true ``` +{% endraw %} {% data reusables.github-actions.docker-tag-with-ref %} @@ -132,6 +131,7 @@ In a single workflow, you can publish your Docker image to multiple registries b The following example workflow uses the `build-push-action` steps from the previous sections ("[Publishing images to Docker Hub](#publishing-images-to-docker-hub)" and "[Publishing images to {% data variables.product.prodname_registry %}](#publishing-images-to-github-packages)") to create a single workflow that pushes to both registries. +{% raw %} ```yaml{:copy} name: Publish Docker image on: @@ -140,28 +140,26 @@ on: jobs: push_to_registries: name: Push Docker image to multiple registries - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - packages: write - contents: read{% endif %} + runs-on: ubuntu-latest steps: - name: Check out the repo uses: actions/checkout@v2 - name: Push to Docker Hub uses: docker/build-push-action@v1 with: - username: {% raw %}${{ secrets.DOCKER_USERNAME }}{% endraw %} - password: {% raw %}${{ secrets.DOCKER_PASSWORD }}{% endraw %} + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} repository: my-docker-hub-namespace/my-docker-hub-repository tag_with_ref: true - name: Push to GitHub Packages uses: docker/build-push-action@v1 with: - username: {% raw %}${{ github.actor }}{% endraw %} - password: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} registry: docker.pkg.github.com repository: my-org/my-repo/my-image tag_with_ref: true ``` +{% endraw %} The above workflow checks out the {% data variables.product.prodname_dotcom %} repository, and uses the `build-push-action` action twice to build and push the Docker image to Docker Hub and {% data variables.product.prodname_registry %}. For both steps, it sets the `build-push-action` option [`tag_with_ref`](https://github.com/marketplace/actions/build-and-push-docker-images#tag_with_ref) to automatically tag the built Docker image with the Git reference of the workflow event. This workflow is triggered on publishing a {% data variables.product.prodname_dotcom %} release, so the reference for both registries will be the Git tag for the release. diff --git a/content/actions/guides/publishing-java-packages-with-gradle.md b/content/actions/guides/publishing-java-packages-with-gradle.md index 8e0fc734c..6a7f10ecd 100644 --- a/content/actions/guides/publishing-java-packages-with-gradle.md +++ b/content/actions/guides/publishing-java-packages-with-gradle.md @@ -108,7 +108,7 @@ Each time you create a new release, you can trigger a workflow to publish your p You can define a new Maven repository in the publishing block of your _build.gradle_ that points to {% data variables.product.prodname_registry %}. In that repository configuration, you can also take advantage of environment variables set in your CI workflow run. You can use the `GITHUB_ACTOR` environment variable as a username, and you can set the `GITHUB_TOKEN` environment variable with your `GITHUB_TOKEN` secret. -{% data reusables.github-actions.github-token-permissions %} +The `GITHUB_TOKEN` exists in your repository by default and has read and write permissions for packages in the repository where the workflow runs. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." For example, if your organization is named "octocat" and your repository is named "hello-world", then the {% data variables.product.prodname_registry %} configuration in _build.gradle_ would look similar to the below example. @@ -133,6 +133,7 @@ publishing { With this configuration, you can create a workflow that publishes your package to the Maven Central Repository by running the `gradle publish` command. +{% raw %} ```yaml{:copy} name: Publish package to GitHub Packages on: @@ -140,10 +141,7 @@ on: types: [created] jobs: publish: - runs-on: ubuntu-latest {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - contents: read - packages: write {% endif %} + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-java@v2 @@ -153,11 +151,12 @@ jobs: - name: Publish package run: gradle publish env: - GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +{% endraw %} {% data reusables.github-actions.gradle-workflow-steps %} -1. Runs the `gradle publish` command to publish to {% data variables.product.prodname_registry %}. The `GITHUB_TOKEN` environment variable will be set with the content of the `GITHUB_TOKEN` secret. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}The `permissions` key specifies the access that the `GITHUB_TOKEN` secret will allow.{% endif %} +1. Runs the `gradle publish` command to publish to {% data variables.product.prodname_registry %}. The `GITHUB_TOKEN` environment variable will be set with the content of the `GITHUB_TOKEN` secret. For more information about using secrets in your workflow, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." @@ -200,6 +199,7 @@ publishing { With this configuration, you can create a workflow that publishes your package to both the Maven Central Repository and {% data variables.product.prodname_registry %} by running the `gradle publish` command. +{% raw %} ```yaml{:copy} name: Publish package to the Maven Central Repository and GitHub Packages on: @@ -207,10 +207,7 @@ on: types: [created] jobs: publish: - runs-on: ubuntu-latest {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - contents: read - packages: write {% endif %} + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Set up Java @@ -220,13 +217,14 @@ jobs: distribution: 'adopt' - name: Publish to the Maven Central Repository run: gradle publish - env: {% raw %} + env: MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }} MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }} - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}{% endraw %} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +{% endraw %} {% data reusables.github-actions.gradle-workflow-steps %} -1. Runs the `gradle publish` command to publish to the `OSSRH` Maven repository and {% data variables.product.prodname_registry %}. The `MAVEN_USERNAME` environment variable will be set with the contents of your `OSSRH_USERNAME` secret, and the `MAVEN_PASSWORD` environment variable will be set with the contents of your `OSSRH_TOKEN` secret. The `GITHUB_TOKEN` environment variable will be set with the content of the `GITHUB_TOKEN` secret. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}The `permissions` key specifies the access that the `GITHUB_TOKEN` secret will allow.{% endif %} +1. Runs the `gradle publish` command to publish to the `OSSRH` Maven repository and {% data variables.product.prodname_registry %}. The `MAVEN_USERNAME` environment variable will be set with the contents of your `OSSRH_USERNAME` secret, and the `MAVEN_PASSWORD` environment variable will be set with the contents of your `OSSRH_TOKEN` secret. The `GITHUB_TOKEN` environment variable will be set with the content of the `GITHUB_TOKEN` secret. For more information about using secrets in your workflow, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." diff --git a/content/actions/guides/publishing-java-packages-with-maven.md b/content/actions/guides/publishing-java-packages-with-maven.md index 7b3d6fbe4..d9fad3346 100644 --- a/content/actions/guides/publishing-java-packages-with-maven.md +++ b/content/actions/guides/publishing-java-packages-with-maven.md @@ -112,9 +112,9 @@ This workflow performs the following steps: Each time you create a new release, you can trigger a workflow to publish your package. The workflow in the example below runs when the `release` event triggers with type `created`. The workflow publishes the package to {% data variables.product.prodname_registry %} if CI tests pass. For more information on the `release` event, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#release)." -In this workflow, you can use the `setup-java` action. This action installs the given version of the JDK into the `PATH`, and also sets up a Maven _settings.xml_ for publishing the package to {% data variables.product.prodname_registry %}. The generated _settings.xml_ defines authentication for a server with an `id` of `github`, using the `GITHUB_ACTOR` environment variable as the username and the `GITHUB_TOKEN` environment variable as the password. The `GITHUB_TOKEN` environment variable is assigned the value of the special `GITHUB_TOKEN` secret. +In this workflow, you can use the `setup-java` action. This action installs the given version of the JDK into the `PATH`, and also sets up a Maven _settings.xml_ for publishing the package to {% data variables.product.prodname_registry %}. The generated _settings.xml_ defines authentication for a server with an `id` of `github`, using the `GITHUB_ACTOR` environment variable as the username and the `GITHUB_TOKEN` environment variable as the password. -{% data reusables.github-actions.github-token-permissions %} +The `GITHUB_TOKEN` exists in your repository by default and has read and write permissions for packages in the repository where the workflow runs. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." For a Maven-based project, you can make use of these settings by creating a distribution repository in your _pom.xml_ file with an `id` of `github` that points to your {% data variables.product.prodname_registry %} endpoint. @@ -137,6 +137,7 @@ For example, if your organization is named "octocat" and your repository is name With this configuration, you can create a workflow that publishes your package to {% data variables.product.prodname_registry %} by making use of the automatically generated _settings.xml_. +{% raw %} ```yaml{:copy} name: Publish package to GitHub Packages on: @@ -144,10 +145,7 @@ on: types: [created] jobs: publish: - runs-on: ubuntu-latest {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - contents: read - packages: write {% endif %} + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-java@v2 @@ -157,8 +155,9 @@ jobs: - name: Publish package run: mvn --batch-mode deploy env: - GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +{% endraw %} This workflow performs the following steps: @@ -174,6 +173,7 @@ You can publish your packages to both the Maven Central Repository and {% data v Ensure your _pom.xml_ file includes a distribution management repository for both your {% data variables.product.prodname_dotcom %} repository and your Maven Central Repository provider. For example, if you deploy to the Central Repository through the OSSRH hosting project, you might want to specify it in a distribution management repository with the `id` set to `ossrh`, and you might want to specify {% data variables.product.prodname_registry %} in a distribution management repository with the `id` set to `github`. +{% raw %} ```yaml{:copy} name: Publish package to the Maven Central Repository and GitHub Packages on: @@ -181,10 +181,7 @@ on: types: [created] jobs: publish: - runs-on: ubuntu-latest {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - contents: read - packages: write {% endif %} + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Set up Java for publishing to Maven Central Repository @@ -197,7 +194,7 @@ jobs: server-password: MAVEN_PASSWORD - name: Publish to the Maven Central Repository run: mvn --batch-mode deploy - env:{% raw %} + env: MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }} MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }} - name: Set up Java for publishing to GitHub Packages @@ -208,8 +205,9 @@ jobs: - name: Publish to GitHub Packages run: mvn --batch-mode deploy env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}{% endraw %} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +{% endraw %} This workflow calls the `setup-java` action twice. Each time the `setup-java` action runs, it overwrites the Maven _settings.xml_ file for publishing packages. For authentication to the repository, the _settings.xml_ file references the distribution management repository `id`, and the username and password. diff --git a/content/actions/guides/publishing-nodejs-packages.md b/content/actions/guides/publishing-nodejs-packages.md index 58aff7c38..3e359adce 100644 --- a/content/actions/guides/publishing-nodejs-packages.md +++ b/content/actions/guides/publishing-nodejs-packages.md @@ -112,7 +112,7 @@ However, if you do provide the `repository` key, then the repository in that key #### Authenticating to the destination repository -To perform authenticated operations against the {% data variables.product.prodname_registry %} registry in your workflow, you can use the `GITHUB_TOKEN`. {% data reusables.github-actions.github-token-permissions %} +To authenticate to the {% data variables.product.prodname_registry %} registry in your workflow, you can use the `GITHUB_TOKEN` from your repository. It is created automatically and has _read_ and _write_ permissions for packages in the repository where the workflow runs. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)." If you want to publish your package to a different repository, you must use a personal access token (PAT) that has permission to write to packages in the destination repository. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" and "[Encrypted secrets](/actions/reference/encrypted-secrets)." @@ -120,6 +120,7 @@ If you want to publish your package to a different repository, you must use a pe This example stores the `GITHUB_TOKEN` secret in the `NODE_AUTH_TOKEN` environment variable. When the `setup-node` action creates an *.npmrc* file, it references the token from the `NODE_AUTH_TOKEN` environment variable. +{% raw %} ```yaml{:copy} name: Node.js Package on: @@ -127,10 +128,7 @@ on: types: [created] jobs: build: - runs-on: ubuntu-latest {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - contents: read - packages: write {% endif %} + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 # Setup .npmrc file to publish to GitHub Packages @@ -143,8 +141,9 @@ jobs: - run: npm install - run: npm publish env: - NODE_AUTH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +{% endraw %} The `setup-node` action creates an *.npmrc* file on the runner. When you use the `scope` input to the `setup-node` action, the *.npmrc* file includes the scope prefix. By default, the `setup-node` action sets the scope in the *.npmrc* file to the account that contains that workflow file. @@ -197,13 +196,13 @@ If you publish a package to both registries, you'll need to ensure that your sco Ensure your *package.json* file includes the scope of your {% data variables.product.prodname_dotcom %} repository and npm registry. For example, if you plan to publish a package in the `octocat/npm-hello-world-test` repository to {% data variables.product.prodname_dotcom %} and https://www.npmjs.com/package/@octocat/npm-hello-world-test, the name in your *package.json* file would be `"name": "@octocat/npm-hello-world-test"`. -To perform authenticated operations against the {% data variables.product.prodname_registry %} registry in your workflow, you can use the `GITHUB_TOKEN`. {% data reusables.github-actions.github-token-permissions %} +To perform authenticated operations against the {% data variables.product.prodname_registry %} registry in your workflow, you can use the `GITHUB_TOKEN`. The `GITHUB_TOKEN` exists in your repository by default and has read and write permissions for packages in the repository where the workflow runs. For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." When you use the `scope` input to the `setup-node` action, the action creates an *.npmrc* file that includes the scope prefix. By default, the `setup-node` action sets the scope in the *.npmrc* file to the user or organization that owns the workflow file. This workflow calls the `setup-node` action two times. Each time the `setup-node` action runs, it overwrites the *.npmrc* file. The *.npmrc* file references the token that allows you to perform authenticated operations against the package registry from the `NODE_AUTH_TOKEN` environment variable. The workflow sets the `NODE_AUTH_TOKEN` environment variable each time the `npm publish` command is run, first with a token to publish to npm (`NPM_TOKEN`) and then with a token to publish to {% data variables.product.prodname_registry %} (`GITHUB_TOKEN`). - +{% raw %} ```yaml{:copy} name: Node.js Package on: @@ -211,10 +210,7 @@ on: types: [created] jobs: build: - runs-on: ubuntu-latest {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - contents: read - packages: write {% endif %} + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 # Setup .npmrc file to publish to npm @@ -225,7 +221,7 @@ jobs: - run: npm install # Publish to npm - run: npm publish --access public - env:{% raw %} + env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} # Setup .npmrc file to publish to GitHub Packages - uses: actions/setup-node@v1 @@ -236,5 +232,6 @@ jobs: # Publish to GitHub Packages - run: npm publish env: - NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}{% endraw %} + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` +{% endraw %} diff --git a/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md b/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md index ee981f4f7..7ab58f630 100644 --- a/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md +++ b/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md @@ -30,6 +30,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l 3. {% data reusables.actions.make-workflow-file %} 4. Copy the following YAML contents into your workflow file. + {% raw %} ```yaml{:copy} name: Remove labels on: @@ -39,18 +40,14 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l jobs: remove_labels: if: github.event.project_card.column_id == '12345678' - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - issues: write - pull-requests: write{% endif %} + runs-on: ubuntu-latest steps: - name: remove labels uses: andymckay/labeler@master with: remove-labels: "needs review" - repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} ``` - + {% endraw %} 5. Customize the parameters in your workflow file: - In `github.event.project_card.column_id == '12345678'`, replace `12345678` with the ID of the column where you want to un-label issues and pull requests that are moved there. diff --git a/content/actions/guides/scheduling-issue-creation.md b/content/actions/guides/scheduling-issue-creation.md index bae7e2956..b261b2a66 100644 --- a/content/actions/guides/scheduling-issue-creation.md +++ b/content/actions/guides/scheduling-issue-creation.md @@ -29,6 +29,7 @@ In the tutorial, you will first make a workflow file that uses the [`imjohnbo/is 2. {% data reusables.actions.make-workflow-file %} 3. Copy the following YAML contents into your workflow file. + {% raw %} ```yaml{:copy} name: Weekly Team Sync on: @@ -38,9 +39,7 @@ In the tutorial, you will first make a workflow file that uses the [`imjohnbo/is jobs: create_issue: name: Create team sync issue - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - issues: write{% endif %} + runs-on: ubuntu-latest steps: - name: Create team sync issue uses: imjohnbo/issue-bot@v3.0 @@ -63,9 +62,9 @@ In the tutorial, you will first make a workflow file that uses the [`imjohnbo/is pinned: false close-previous: false env: - GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ``` - + {% endraw %} 4. Customize the parameters in your workflow file: - Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every Monday at 7:20 UTC. For more information about scheduled workflows, see "[Scheduled events](/actions/reference/events-that-trigger-workflows#scheduled-events)." - Change the value for `assignees` to the list of {% data variables.product.prodname_dotcom %} usernames that you want to assign to the issue. diff --git a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index 8bc46e0ba..e045f5742 100644 --- a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -53,7 +53,7 @@ When creating a group, you must choose a policy that defines which repositories **Warning** - {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} + {% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." @@ -85,7 +85,7 @@ When creating a group, you must choose a policy that defines which organizations **Warning** - {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} + {% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." diff --git a/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md index f32c25533..cbb113098 100644 --- a/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md @@ -443,9 +443,7 @@ jobs: path: vendor/bundle key: administrate-${{ matrix.image }}-${{ hashFiles('Gemfile.lock') }} - name: Install postgres headers - run: | - sudo apt-get update - sudo apt-get install libpq-dev + run: sudo apt-get install libpq-dev - name: Install dependencies run: bundle install --path vendor/bundle - name: Setup environment configuration diff --git a/content/actions/learn-github-actions/security-hardening-for-github-actions.md b/content/actions/learn-github-actions/security-hardening-for-github-actions.md index 81cb9d1f7..c35f54956 100644 --- a/content/actions/learn-github-actions/security-hardening-for-github-actions.md +++ b/content/actions/learn-github-actions/security-hardening-for-github-actions.md @@ -39,8 +39,7 @@ To help prevent accidental disclosure, {% data variables.product.product_name %} - Audit how secrets are used, to help ensure they’re being handled as expected. You can do this by reviewing the source code of the repository executing the workflow, and checking any actions used in the workflow. For example, check that they’re not sent to unintended hosts, or explicitly being printed to log output. - View the run logs for your workflow after testing valid/invalid inputs, and check that secrets are properly redacted, or not shown. It's not always obvious how a command or tool you’re invoking will send errors to `STDOUT` and `STDERR`, and secrets might subsequently end up in error logs. As a result, it is good practice to manually review the workflow logs after testing valid and invalid inputs. - **Use credentials that are minimally scoped** - - Make sure the credentials being used within workflows have the least privileges required, and be mindful that any user with write access to your repository has read access to all secrets configured in your repository. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - - Actions can use the `GITHUB_TOKEN` by accessing it from the `github.token` context. For more information, see "[Context and expression syntax for {% data variables.product.prodname_actions %}](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)." You should therefore make sure that the `GITHUB_TOKEN` is granted the minimum required permissions. It's good security practice to set the default permission for the `GITHUB_TOKEN` to read access only for repository contents. The permissions can then be increased, as required, for individual jobs within the workflow file. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." {% endif %} + - Make sure the credentials being used within workflows have the least privileges required, and be mindful that any user with write access to your repository has read access to all secrets configured in your repository. - **Audit and rotate registered secrets** - Periodically review the registered secrets to confirm they are still required. Remove those that are no longer needed. - Rotate secrets periodically to reduce the window of time during which a compromised secret is valid. @@ -53,7 +52,7 @@ To help prevent accidental disclosure, {% data variables.product.product_name %} The individual jobs in a workflow can interact with (and compromise) other jobs. For example, a job querying the environment variables used by a later job, writing files to a shared directory that a later job processes, or even more directly by interacting with the Docker socket and inspecting other running containers and executing commands in them. -This means that a compromise of a single action within a workflow can be very significant, as that compromised action would have access to all secrets configured on your repository, and may be able to use the `GITHUB_TOKEN` to write to the repository. Consequently, there is significant risk in sourcing actions from third-party repositories on {% data variables.product.prodname_dotcom %}. You can help mitigate this risk by following these good practices: +This means that a compromise of a single action within a workflow can be very significant, as that compromised action would have access to all secrets configured on your repository, and can use the `GITHUB_TOKEN` to write to the repository. Consequently, there is significant risk in sourcing actions from third-party repositories on {% data variables.product.prodname_dotcom %}. You can help mitigate this risk by following these good practices: * **Pin actions to a full length commit SHA** @@ -78,14 +77,14 @@ This means that a compromise of a single action within a workflow can be very si ### Considering cross-repository access -{% data variables.product.prodname_actions %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying a workflow file{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}, elevating the permissions of the `GITHUB_TOKEN` if necessary{% endif %}. Users have specific permissions for each repository, so allowing the `GITHUB_TOKEN` for one repository to grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators. +{% data variables.product.prodname_actions %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so allowing the `GITHUB_TOKEN` for one repository to grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators. We have [a plan on the {% data variables.product.prodname_dotcom %} roadmap](https://github.com/github/roadmap/issues/74) to support a flow that allows cross-repository access within {% data variables.product.product_name %}, but this is not yet a supported feature. Currently, the only way to perform privileged cross-repository interactions is to place a {% data variables.product.prodname_dotcom %} authentication token or SSH key as a secret within the workflow. Because many authentication token types do not allow for granular access to specific resources, there is significant risk in using the wrong token type, as it can grant much broader access than intended. This list describes the recommended approaches for accessing repository data within a workflow, in descending order of preference: 1. **The `GITHUB_TOKEN`** - - This token is intentionally scoped to the single repository that invoked the workflow, and {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}can have {% else %}has {% endif %}the same level of access as a write-access user on the repository. The token is created before each job begins and expires when the job is finished. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." + - This token is intentionally scoped to the single repository that invoked the workflow, and has the same level of access as a write-access user on the repository. The token is created before each job begins and expires when the job is finished. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." - The `GITHUB_TOKEN` should be used whenever possible. 2. **Repository deploy key** - Deploy keys are one of the only credential types that grant read or write access to a single repository, and can be used to interact with another repository within a workflow. For more information, see "[Managing deploy keys](/developers/overview/managing-deploy-keys#deploy-keys)." @@ -104,7 +103,7 @@ This list describes the recommended approaches for accessing repository data wit **Self-hosted** runners on {% data variables.product.product_name %} do not have guarantees around running in ephemeral clean virtual machines, and can be persistently compromised by untrusted code in a workflow. -As a result, self-hosted runners should almost [never be used for public repositories](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories) on {% data variables.product.product_name %}, because any user can open pull requests against the repository and compromise the environment. Similarly, be cautious when using self-hosted runners on private repositories, as anyone who can fork the repository and open a pull request (generally those with read-access to the repository) are able to compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}, depending on its settings, can grant {% else %} grants {% endif %}write-access permissions on the repository. +As a result, self-hosted runners should almost [never be used for public repositories](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories) on {% data variables.product.product_name %}, because any user can open pull requests against the repository and compromise the environment. Similarly, be cautious when using self-hosted runners on private repositories, as anyone who can fork the repository and open a PR (generally those with read-access to the repository) are able to compromise the self-hosted runner environment, including gaining access to secrets and the more privileged `GITHUB_TOKEN` which grants write-access permissions on the repository. When a self-hosted runner is defined at the organization or enterprise level, {% data variables.product.product_name %} can schedule workflows from multiple repositories onto the same runner. Consequently, a security compromise of these environments can result in a wide impact. To help reduce the scope of a compromise, you can create boundaries by organizing your self-hosted runners into separate groups. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." diff --git a/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md b/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md deleted file mode 100644 index a41d459b5..000000000 --- a/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Approving workflow runs from public forks -intro: 'When a first-time contributor submits a pull request to a public repository, a maintainer with write access must approve any workflow runs.' -product: '{% data reusables.gated-features.actions %}' -versions: - free-pro-team: '*' ---- - -Forks of public repositories can submit pull requests that propose changes to a repository's {% data variables.product.prodname_actions %} workflows. Although workflows from forks do not have access to sensitive data such as secrets, they can be an annoyance for maintainers if they are modified for abusive purposes. To help prevent this, workflows on pull requests are not run automatically if they are received from first-time contributors, and must be approved first. - -Maintainers with write access to the repository can use the following procedure to review and run workflows on pull requests from first-time contributors. After a contributor has at least one pull request merged into a project's repository, any future pull requests from that contributor's fork will automatically run workflows. - -{% data reusables.repositories.sidebar-pr %} -{% data reusables.repositories.choose-pr-review %} -{% data reusables.repositories.changed-files %} -1. Inspect the proposed changes in the pull request and ensure that you are comfortable running your workflows on the pull request branch. You should be especially alert to any proposed changes in the `.github/workflows/` directory that affect workflow files. -1. If you are comfortable with running workflows on the pull request branch, return to the {% octicon "comment-discussion" aria-label="The discussion icon" %} **Conversation** tab, and under "Workflow(s) awaiting approval", click **Approve and run**. - - ![Approve and run workflows](/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png) diff --git a/content/actions/managing-workflow-runs/index.md b/content/actions/managing-workflow-runs/index.md index 2e9d58119..2606df2f9 100644 --- a/content/actions/managing-workflow-runs/index.md +++ b/content/actions/managing-workflow-runs/index.md @@ -26,7 +26,6 @@ versions: {% link_in_list /manually-running-a-workflow %} {% link_in_list /re-running-a-workflow %} {% link_in_list /canceling-a-workflow %} -{% link_in_list /approving-workflow-runs-from-public-forks %} {% link_in_list /reviewing-deployments %} {% link_in_list /disabling-and-enabling-a-workflow %} {% link_in_list /deleting-a-workflow-run %} diff --git a/content/actions/reference/authentication-in-a-workflow.md b/content/actions/reference/authentication-in-a-workflow.md index 8fbd46a17..eac1b060d 100644 --- a/content/actions/reference/authentication-in-a-workflow.md +++ b/content/actions/reference/authentication-in-a-workflow.md @@ -28,95 +28,63 @@ The token is also available in the `github.token` context. For more information, ### Using the `GITHUB_TOKEN` in a workflow -You can use the `GITHUB_TOKEN` by using the standard syntax for referencing secrets: {%raw%}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. Examples of using the `GITHUB_TOKEN` include passing the token as an input to an action, or using it to make an authenticated {% data variables.product.prodname_dotcom %} API request. - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} -{% note %} - -**Important:** An action can access the `GITHUB_TOKEN` through the `github.token` context even if the workflow does not explicitly pass the `GITHUB_TOKEN` to the action. As a good security practice, you should always make sure that actions only have the minimum access they require by limiting the permissions granted to the `GITHUB_TOKEN`. For more information, see "[Permissions for the `GITHUB_TOKEN`](#permissions-for-the-github_token)." - -{% endnote %} -{% endif %} +To use the `GITHUB_TOKEN` secret, you must reference it in your workflow file. Using a token might include passing the token as an input to an action that requires it, or making authenticated {% data variables.product.prodname_dotcom %} API calls. {% data reusables.github-actions.actions-do-not-trigger-workflows %} -#### Example 1: passing the `GITHUB_TOKEN` as an input +#### Example passing `GITHUB_TOKEN` as an input This example workflow uses the [labeler action](https://github.com/actions/labeler), which requires the `GITHUB_TOKEN` as the value for the `repo-token` input parameter: - -```yaml -name: Pull request labeler - -on: [ pull_request_target ] - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}permissions: - contents: read - pull-requests: write - -{% endif %} -jobs: - triage: - runs-on: ubuntu-latest - steps: - - uses: actions/labeler@v2 - with: - repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} -``` - - -#### Example 2: calling the REST API + {% raw %} + ```yaml + name: Pull request labeler + on: + - pull_request_target + jobs: + triage: + runs-on: ubuntu-latest + steps: + - uses: actions/labeler@v2 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + ``` + {% endraw %} + +#### Example calling the REST API You can use the `GITHUB_TOKEN` to make authenticated API calls. This example workflow creates an issue using the {% data variables.product.prodname_dotcom %} REST API: -```yaml -name: Create issue on commit - -on: [ push ] - -jobs: - create_commit: - runs-on: ubuntu-latest {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - issues: write {% endif %} - steps: - - name: Create issue using REST API - run: {% raw %}| - curl --request POST \ - --url https://api.github.com/repos/${{ github.repository }}/issues \ - --header 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' \ - --header 'content-type: application/json' \ - --data '{ - "title": "Automated issue for commit: ${{ github.sha }}", - "body": "This issue was automatically created by the GitHub Action workflow **${{ github.workflow }}**. \n\n The commit hash was: _${{ github.sha }}_." - }' \ - --fail{% endraw %} -``` + {% raw %} + ```yaml + name: Create issue on commit + on: + - push + jobs: + create_commit: + runs-on: ubuntu-latest + steps: + - name: Create issue using REST API + run: | + curl --request POST \ + --url https://api.github.com/repos/${{ github.repository }}/issues \ + --header 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' \ + --header 'content-type: application/json' \ + --data '{ + "title": "Automated issue for commit: ${{ github.sha }}", + "body": "This issue was automatically created by the GitHub Action workflow **${{ github.workflow }}**. \n\n The commit hash was: _${{ github.sha }}_." + }' \ + --fail + ``` + {% endraw %} ### Permissions for the `GITHUB_TOKEN` For information about the API endpoints {% data variables.product.prodname_github_apps %} can access with each permission, see "[{% data variables.product.prodname_github_app %} Permissions](/rest/reference/permissions-required-for-github-apps)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} -The following table shows the permissions granted to the `GITHUB_TOKEN` by default. People with admin permissions to an enterprise, organization, or repository can set the default permissions to be either permissive or restricted. For information on how to set the default permissions for the `GITHUB_TOKEN` for your enterprise, organization, or repository, see "[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account#setting-the-permissions-of-the-github_token-for-your-enterprise)," "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)," or "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#setting-the-permissions-of-the-github_token-for-a-repository)." - -| Scope | Default access
(permissive) | Default access
(restricted) | Maximum access
by forked repos | -|---------------|-----------------------------|-----------------------------|--------------------------------| -| actions | read/write | none | read | -| checks | read/write | none | read | -| contents | read/write | read | read | -| deployments | read/write | none | read | -| issues | read/write | none | read | -| metadata | read | read | read | -| packages | read/write | none | read | -| pull requests | read/write | none | read | -| repository projects | read/write | none | read | -| security events | read/write | none | read | -| statuses | read/write | none | read | -{% else %} -| Scope | Access type | Access by forked repos | -|----------|-------------|--------------------------| -| actions | read/write | read | +| Permission | Access type | Access by forked repos | +|------------|-------------|--------------------------| +| actions | read/write | read | | checks | read/write | read | | contents | read/write | read | | deployments | read/write | read | @@ -126,32 +94,9 @@ The following table shows the permissions granted to the `GITHUB_TOKEN` by defau | pull requests | read/write | read | | repository projects | read/write | read | | statuses | read/write | read | -{% endif %} {% data reusables.actions.workflow-runs-dependabot-note %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} -#### Modifying the permissions for the `GITHUB_TOKEN` - -You can modify the permissions for the `GITHUB_TOKEN` in individual workflow files. If the default permissions for the `GITHUB_TOKEN` are restrictive, you may have to elevate the permissions to allow some actions and commands to run successfully. If the default permissions are permissive, you can edit the workflow file to remove some permissions from the `GITHUB_TOKEN`. As a good security practice, you should grant the `GITHUB_TOKEN` the least required access. - -You can see the permissions that `GITHUB_TOKEN` had for a specific job in the "Set up job" section of the workflow run log. For more information, see "[Using workflow run logs](/actions/managing-workflow-runs/using-workflow-run-logs)." - -You can use the `permissions` key in your workflow file to modify permissions for the `GITHUB_TOKEN` for an entire workflow or for individual jobs. This allows you to configure the minimum required permissions for a workflow or job. When the `permissions` key is used, all unspecified permissions are set to no access, with the exception of the `metadata` scope, which always gets read access. - -{% data reusables.github-actions.forked-write-permission %} - -The two workflow examples earlier in this article show the `permissions` key being used at the workflow level, and at the job level. In [Example 1](#example-1-passing-the-github_token-as-an-input) the two permissions are specified for the entire workflow. In [Example 2](#example-2-calling-the-rest-api) write access is granted for one scope for a single job. - -For full details of the `permissions` key, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#permissions)." - -##### How the permissions are calculated for a workflow job - -The permissions for the `GITHUB_TOKEN` are initially set to the default setting for the enterprise, organization, or repository. If the default is set to the restricted permissions at any of these levels then this will apply to the relevant repositories. For example, if you choose the restricted default at the organization level then all repositories in that organization will use the restricted permissions as the default. The permissions are then adjusted based on any configuration within the workflow file, first at the workflow level and then at the job level. Finally, if the workflow was triggered by a pull request from a forked repository, and the **Send write tokens to workflows from pull requests** setting is not selected, the permissions are adjusted to change any write permissions to read only. - -#### Granting additional permissions -{% endif %} - If you need a token that requires permissions that aren't available in the `GITHUB_TOKEN`, you can create a personal access token and set it as a secret in your repository: 1. Use or create a token with the appropriate permissions for that repository. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." diff --git a/content/actions/reference/context-and-expression-syntax-for-github-actions.md b/content/actions/reference/context-and-expression-syntax-for-github-actions.md index cf9743f60..8bdfedc6e 100644 --- a/content/actions/reference/context-and-expression-syntax-for-github-actions.md +++ b/content/actions/reference/context-and-expression-syntax-for-github-actions.md @@ -323,7 +323,7 @@ Returns `true` if `searchString` ends with `searchValue`. This function is not c `format( string, replaceValue0, replaceValue1, ..., replaceValueN)` -Replaces values in the `string`, with the variable `replaceValueN`. Variables in the `string` are specified using the `{N}` syntax, where `N` is an integer. You must specify at least one `replaceValue` and `string`. There is no maximum for the number of variables (`replaceValueN`) you can use. Escape curly braces using double braces. +Replaces values in the `string`, with the variable `replaceValueN`. Variables in the `string` are specified using the `{N}` syntax, where `N` is an integer. You must specify at least one `replaceValue` and `string`. There is no maximum for the number of variables (`replaceValueN`) you can use. Escape curly braces useing double braces. ##### Example diff --git a/content/actions/reference/environments.md b/content/actions/reference/environments.md index aa3570397..779a70ad2 100644 --- a/content/actions/reference/environments.md +++ b/content/actions/reference/environments.md @@ -71,9 +71,6 @@ For more information on syntax to reference environments in workflows, see "[Wor When a workflow references an environment, the environment will appear in the repository's deployments. For more information about viewing current and previous deployments, see "[Viewing deployment history](/developers/overview/viewing-deployment-history)." -### Using concurrency to serialize deployments in an environment -You can use concurrency so that an environment has a maximum of one deployment in progress and one deployment pending at a time. For more information, see "[Workflow syntax for GitHub Actions](/actions/reference/workflow-syntax-for-github-actions#concurrency)." - ### Deleting an environment {% data reusables.github-actions.permissions-statement-environment %} diff --git a/content/actions/reference/workflow-syntax-for-github-actions.md b/content/actions/reference/workflow-syntax-for-github-actions.md index 6fa26dc64..9e2de6816 100644 --- a/content/actions/reference/workflow-syntax-for-github-actions.md +++ b/content/actions/reference/workflow-syntax-for-github-actions.md @@ -110,8 +110,8 @@ The following workflow will run on pushes to `releases/10` or `releases/beta/mon on: push: branches: - - 'releases/**' - - '!releases/**-alpha' + - 'releases/**' + - '!releases/**-alpha' ``` ### `on..paths` @@ -128,7 +128,7 @@ When all the path names match patterns in `paths-ignore`, the workflow will not on: push: paths-ignore: - - 'docs/**' + - 'docs/**' ``` #### Example including paths @@ -139,7 +139,7 @@ If at least one path matches a pattern in the `paths` filter, the workflow runs. on: push: paths: - - '**.js' + - '**.js' ``` #### Excluding paths @@ -160,8 +160,8 @@ This example runs anytime the `push` event includes a file in the `sub-project` on: push: paths: - - 'sub-project/**' - - '!sub-project/docs/**' + - 'sub-project/**' + - '!sub-project/docs/**' ``` #### Git diff comparisons @@ -187,32 +187,6 @@ For more information, see "[About comparing branches in pull requests](/articles For more information about cron syntax, see "[Events that trigger workflows](/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#scheduled-events)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} -### `permissions` - -You can modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." - -You can use `permissions` either as a top-level key, to apply to all jobs in the workflow, or within specific jobs. When you add the `permissions` key within a specific job, all actions and run commands within that job that use the `GITHUB_TOKEN` gain the access rights you specify. For more information, see [`jobs..permissions`](#jobsjob_idpermissions). - -{% data reusables.github-actions.github-token-available-permissions %} -{% data reusables.github-actions.forked-write-permission %} - -#### Example - -This example shows permissions being set for the `GITHUB_TOKEN` that will apply to all jobs in the workflow. All permissions are granted read access. - -```yaml -name: "My workflow" - -on: [ push ] - -permissions: read-all - -jobs: - ... -``` -{% endif %} - ### `env` A `map` of environment variables that are available to the steps of all jobs in the workflow. You can also set environment variables that are only available to the steps of a single job or to a single step. For more information, see [`jobs..env`](#jobsjob_idenv) and [`jobs..steps[*].env`](#jobsjob_idstepsenv). @@ -247,18 +221,6 @@ defaults: working-directory: scripts ``` -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@next" %} -### `concurrency` - -{% data reusables.actions.concurrency-beta %} - -Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use the `github` context. For more information about expressions, see "[Context and expression syntax for {% data variables.product.prodname_actions %}](/actions/reference/context-and-expression-syntax-for-github-actions)." - -You can also specify `concurrency` at the job level. For more information, see [`jobs..concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency). - -{% data reusables.actions.actions-group-concurrency %} - -{% endif %} ### `jobs` A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the `jobs..needs` keyword. @@ -377,34 +339,6 @@ runs-on: [self-hosted, linux] For more information, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} -### `jobs..permissions` - -You can modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)." - -By specifying the permission within a job definition, you can configure a different set of permissions for the `GITHUB_TOKEN` for each job, if required. Alternatively, you can specify the permissions for all jobs in the workflow. For information on defining permissions at the workflow level, see [`permissions`](#permissions). - -{% data reusables.github-actions.github-token-available-permissions %} -{% data reusables.github-actions.forked-write-permission %} - -#### Example - -This example shows permissions being set for the `GITHUB_TOKEN` that will only apply to the job named `stale`. Write access is granted for the `issues` and `pull-requests` scopes. All other scopes will have no access. - -```yaml -jobs: - stale: - runs-on: ubuntu-latest - - permissions: - issues: write - pull-requests: write - - steps: - - uses: actions/stale@v3 -``` -{% endif %} - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ### `jobs..environment` @@ -413,11 +347,10 @@ The environment that the job references. All environment protection rules must p You can provide the environment as only the environment `name`, or as an environment object with the `name` and `url`. The URL maps to `environment_url` in the deployments API. For more information about the deployments API, see "[Deployments](/rest/reference/repos#deployments)." ##### Example using a single environment name -{% raw %} + ```yaml environment: staging_environment ``` -{% endraw %} ##### Example using environment name and URL @@ -439,25 +372,6 @@ environment: {% endraw %} {% endif %} - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@next" %} -### `jobs..concurrency` - -{% data reusables.actions.concurrency-beta %} - -{% note %} - -**Note:** When concurrency is specified at the job level, order is not guaranteed for jobs or runs that queue within 5 minutes of each other. - -{% endnote %} - -Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the `secrets` context. For more information about expressions, see "[Context and expression syntax for {% data variables.product.prodname_actions %}](/actions/reference/context-and-expression-syntax-for-github-actions)." - -You can also specify `concurrency` at the workflow level. For more information, see [`concurrency`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#concurrency). - -{% data reusables.actions.actions-group-concurrency %} - -{% endif %} ### `jobs..outputs` A `map` of outputs for a job. Job outputs are available to all downstream jobs that depend on this job. For more information on defining job dependencies, see [`jobs..needs`](#jobsjob_idneeds). @@ -478,15 +392,15 @@ jobs: output1: ${{ steps.step1.outputs.test }} output2: ${{ steps.step2.outputs.test }} steps: - - id: step1 - run: echo "::set-output name=test::hello" - - id: step2 - run: echo "::set-output name=test::world" + - id: step1 + run: echo "::set-output name=test::hello" + - id: step2 + run: echo "::set-output name=test::world" job2: runs-on: ubuntu-latest needs: job1 steps: - - run: echo ${{needs.job1.outputs.output1}} ${{needs.job1.outputs.output2}} + - run: echo ${{needs.job1.outputs.output1}} ${{needs.job1.outputs.output2}} ``` {% endraw %} @@ -556,14 +470,14 @@ jobs: name: My Job runs-on: ubuntu-latest steps: - - name: Print a greeting - env: - MY_VAR: Hi there! My name is - FIRST_NAME: Mona - MIDDLE_NAME: The - LAST_NAME: Octocat - run: | - echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME. + - name: Print a greeting + env: + MY_VAR: Hi there! My name is + FIRST_NAME: Mona + MIDDLE_NAME: The + LAST_NAME: Octocat + run: | + echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME. ``` {% endraw %} diff --git a/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 6eb8734b5..e31cad845 100644 --- a/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -93,10 +93,6 @@ We recommend using actions to interact with the software installed on runners. T If there is a tool that you'd like to request, please open an issue at [actions/virtual-environments](https://github.com/actions/virtual-environments). This repository also contains announcements about all major software updates on runners. -#### Installing additional software - -You can install additional software on {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Customizing GitHub-hosted runners](/actions/using-github-hosted-runners/customizing-github-hosted-runners)". - ### IP addresses {% note %} diff --git a/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md b/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md deleted file mode 100644 index 789f759f8..000000000 --- a/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Customizing GitHub-hosted runners -intro: >- - You can install additional software on GitHub-hosted runners as a - part of your workflow. -product: '{% data reusables.gated-features.actions %}' -versions: - free-pro-team: '*' - enterprise-server: '>=2.22' -type: tutorial -topics: - - Workflows ---- - -{% data reusables.actions.enterprise-github-hosted-runners %} - -If you require additional software packages on {% data variables.product.prodname_dotcom %}-hosted runners, you can create a job that installs the packages as part of your workflow. - -To see which packages are already installed by default, see "[Preinstalled software](/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software)." - -This guide demonstrates how to create a job that installs additional software on a {% data variables.product.prodname_dotcom %}-hosted runner. - -### Installing software on Ubuntu runners - -The following example demonstrates how to install an `apt` package as part of a job. - -{% raw %} -```yaml -name: Build on Ubuntu -on: push - -jobs: - build: - runs-on: ubuntu-latest - steps: - - name: Check out repository code - uses: actions/checkout@v2 - - name: Install jq tool - run: | - sudo apt-get update - sudo apt-get install jq -``` -{% endraw %} - -{% note %} - -**Note:** Always run `sudo apt-get update` before installing a package. In case the `apt` index is stale, this command fetches and re-indexes any available packages, which helps prevent package installation failures. - -{% endnote %} - -### Installing software on macOS runners - -The following example demonstrates how to install Brew packages and casks as part of a job. - -{% raw %} -```yaml -name: Build on macOS -on: push - -jobs: - build: - runs-on: macos-latest - steps: - - name: Check out repository code - uses: actions/checkout@v2 - - name: Install GitHub CLI - run: | - brew update - brew install gh - - name: Install Microsoft Edge - run: | - brew update - brew install --cask microsoft-edge -``` -{% endraw %} - -### Installing software on Windows runners - -The following example demonstrates how to use [Chocolatey](https://community.chocolatey.org/packages) to install the {% data variables.product.prodname_dotcom %} CLI as part of a job. - -{% raw %} -```yaml -name: Build on Windows -on: push -jobs: - build: - runs-on: windows-latest - steps: - - run: choco install gh - - run: gh version -``` -{% endraw %} diff --git a/content/actions/using-github-hosted-runners/index.md b/content/actions/using-github-hosted-runners/index.md index fb91ee9e6..681269a25 100644 --- a/content/actions/using-github-hosted-runners/index.md +++ b/content/actions/using-github-hosted-runners/index.md @@ -11,7 +11,6 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% link_in_list /about-github-hosted-runners %} -{% link_in_list /customizing-github-hosted-runners %} {% link_in_list /about-ae-hosted-runners %} {% link_in_list /adding-ae-hosted-runners %} {% link_in_list /using-ae-hosted-runners-in-a-workflow %} diff --git a/content/admin/configuration/about-enterprise-configuration.md b/content/admin/configuration/about-enterprise-configuration.md index 6abfe5a55..143603652 100644 --- a/content/admin/configuration/about-enterprise-configuration.md +++ b/content/admin/configuration/about-enterprise-configuration.md @@ -17,7 +17,9 @@ topics: {% endif %} {% if currentVersion == "github-ae@latest" %} -The first time you access your enterprise, you will complete an initial configuration to get {% data variables.product.product_name %} ready to use. The initial configuration includes connecting your enterprise with an identity provider (IdP), authenticating with SAML SSO, configuring policies for repositories and organizations in your enterprise, and configuring SMTP for outbound email. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)." +The first time you access your enterprise, you will complete an initial configuration to get {% data variables.product.product_name %} ready to use. The initial configuration includes connecting your enterprise with an idP, authenticating with SAML SSO, and configuring policies for repositories and organizations in your enterprise. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/initializing-github-ae)." + +For users to receive any emails from {% data variables.product.product_name %} after the initial configuration, you must ask {% data variables.contact.github_support %} to configure outbound email support with your SMTP server. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-email-for-notifications)." Later, you can use the site admin dashboard and enterprise settings to further configure your enterprise, manage users, organizations and repositories, and set policies that reduce risk and increase quality. @@ -27,4 +29,4 @@ All enterprises are configured with subdomain isolation and support for TLS 1.2 ### Further reading - "[Managing users, organizations, and repositories](/admin/user-management)" -- "[Setting policies for your enterprise](/admin/policies)" \ No newline at end of file +- "[Setting policies for your enterprise](/admin/policies)" diff --git a/content/admin/configuration/initializing-github-ae.md b/content/admin/configuration/initializing-github-ae.md index 2b9276c0b..8be6d2979 100644 --- a/content/admin/configuration/initializing-github-ae.md +++ b/content/admin/configuration/initializing-github-ae.md @@ -103,11 +103,11 @@ Once this is initialized, you can reconfigure any settings after the initializat settings to allow incoming emails](/admin/configuration/configuring-email-for-notifications#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." !["Enable" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-enable-email-configure.png) 3. Complete your email server settings: - - In the **Server address** field, type the address of your SMTP server. - - In the **Port** field, type the port that your SMTP server uses to send email. - - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. - - In the **Authentication** dropdown, choose the type of encryption used by your SMTP server. - - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - In the **Authentication** dropdown, choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. 4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. !["Discard" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-discard-email.png) diff --git a/content/admin/enterprise-management/increasing-storage-capacity.md b/content/admin/enterprise-management/increasing-storage-capacity.md index 0007b50b7..1db820873 100644 --- a/content/admin/enterprise-management/increasing-storage-capacity.md +++ b/content/admin/enterprise-management/increasing-storage-capacity.md @@ -31,10 +31,7 @@ As more users join {% data variables.product.product_location %}, you may need t 1. Resize the existing user volume disk using your virtualization platform's tools. {% data reusables.enterprise_installation.ssh-into-instance %} 3. Put the appliance in maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)." -4. Reboot the appliance to detect the new storage allocation: - ```shell - $ sudo reboot - ``` +4. Reboot the appliance to detect the new storage allocation. 5. Run the `ghe-storage-extend` command to expand the `/data/user` filesystem: ```shell $ ghe-storage-extend @@ -43,10 +40,7 @@ As more users join {% data variables.product.product_location %}, you may need t ### Increasing the root partition size using a new appliance 1. Set up a new {% data variables.product.prodname_ghe_server %} instance with a larger root disk using the same version as your current appliance. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/enterprise/{{ currentVersion }}/admin/guides/installation/setting-up-a-github-enterprise-server-instance)." -2. Shut down the current appliance: - ```shell - $ sudo poweroff - ``` +2. Shut down the current appliance. 3. Detach the data disk from the current appliance using your virtualization platform's tools. 4. Attach the data disk to the new appliance with the larger root disk. @@ -63,9 +57,6 @@ As more users join {% data variables.product.product_location %}, you may need t ```shell $ ghe-upgrade PACKAGE-NAME.pkg -s -t /dev/xvdg1 ``` -4. Shut down the appliance: - ```shell - $ sudo poweroff - ``` +4. Shut down the appliance. 5. In the hypervisor, remove the old root disk and attach the new root disk at the same location as the old root disk. 6. Start the appliance. diff --git a/content/admin/enterprise-management/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/upgrading-github-enterprise-server.md index 8ca6149d9..a839c0341 100644 --- a/content/admin/enterprise-management/upgrading-github-enterprise-server.md +++ b/content/admin/enterprise-management/upgrading-github-enterprise-server.md @@ -89,12 +89,7 @@ There are two types of snapshots: {% note %} -**{% if currentVersion ver_gt "enterprise-server@2.22" %}Notes{% else %}Note{% endif %}**: - -{% if currentVersion ver_gt "enterprise-server@2.22" %} -- If {% data variables.product.product_location %} is running a release candidate build, you can't upgrade with a hotpatch. - -- {% endif %}Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)." +**Note**: Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)." {% endnote %} diff --git a/content/admin/github-actions/about-using-actions-in-your-enterprise.md b/content/admin/github-actions/about-using-actions-in-your-enterprise.md index 0e87f2149..473479027 100644 --- a/content/admin/github-actions/about-using-actions-in-your-enterprise.md +++ b/content/admin/github-actions/about-using-actions-in-your-enterprise.md @@ -22,11 +22,11 @@ topics: ### Official actions bundled with your enterprise instance -Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.product_name %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}. +Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.product_name %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}. When {% data variables.product.product_name %} is updated, the bundled official actions are also updated. The bundled official actions include `actions/checkout`, `actions/upload-artifact`, `actions/download-artifact`, `actions/labeler`, and various `actions/setup-` actions, among others. To see all the official actions included on your enterprise instance, browse to the `actions` organization on your instance: https://HOSTNAME/actions. -Each action is a repository in the `actions` organization, and each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action. For information on how to update the bundled official actions, see "[Using the latest version of the official bundled actions](/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions)." +Each action is a repository in the `actions` organization, and each action repository includes the necessary tags, branches, and commit SHAs that your workflows can use to reference the action. {% note %} diff --git a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md index 588e25c8a..a24060641 100644 --- a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md +++ b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md @@ -13,7 +13,6 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -{% data reusables.actions.enterprise-github-connect-warning %} {% data reusables.actions.ae-beta %} By default, {% data variables.product.prodname_actions %} workflows on {% data variables.product.product_name %} cannot use actions directly from {% data variables.product.prodname_dotcom_the_website %} or [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions). diff --git a/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md b/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md index 67d7a3b1b..f545d4949 100644 --- a/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md @@ -14,7 +14,7 @@ topics: Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: -* Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} +* Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference site.data.reusables.actions.enterprise-s3-permission spaces=2 %} {% data reusables.actions.enterprise-common-prereqs %} diff --git a/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md index df78fb814..ba2c6c47a 100644 --- a/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md @@ -15,7 +15,7 @@ topics: Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: * To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from {% data variables.product.product_location %}. -* Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} +* Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference site.data.reusables.actions.enterprise-s3-permission spaces=2 %} {% data reusables.actions.enterprise-common-prereqs %} diff --git a/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md b/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md index 704a7e097..3325c53ca 100644 --- a/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md +++ b/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md @@ -14,31 +14,16 @@ topics: Your enterprise instance includes a number of built-in actions that you can use in your workflows. For more information about the bundled actions, see "[Official actions bundled with your enterprise instance](/admin/github-actions/about-using-actions-in-your-enterprise#official-actions-bundled-with-your-enterprise-instance)." -These bundled actions are a point-in-time snapshot of the official actions found at https://github.com/actions, so there may be newer versions of these actions available. You can use the `actions-sync` tool to update these actions, or you can configure {% data variables.product.prodname_github_connect %} to allow access to the latest actions on {% data variables.product.prodname_dotcom_the_website %}. These options are described in the following sections. +These bundled actions are a point-in-time snapshot of the official actions found at https://github.com/actions; as a result, these actions may be older versions that can be updated. To update these actions, you can use `actions-sync` to retrieve updated versions from {% data variables.product.prodname_dotcom_the_website %}. -### Using `actions-sync` to update the bundled actions +These options are described in more detail in the following sections. -To update the bundled actions, you can use the `actions-sync` tool to update the snapshot. For more information on using `actions-sync`, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/admin/github-actions/manually-syncing-actions-from-githubcom)." +### Using actions-sync to update a bundled action -### Using {% data variables.product.prodname_github_connect %} to access the latest actions +To update the bundled actions, you can use the `actions-sync` tool to synchronize actions with {% data variables.product.prodname_dotcom_the_website %}. For more information on using `actions-sync`, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/admin/github-actions/manually-syncing-actions-from-githubcom)." -You can use {% data variables.product.prodname_github_connect %} to allow {% data variables.product.product_name %} to use actions from {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." +### Using actions from {% data variables.product.prodname_dotcom_the_website %} -Once {% data variables.product.prodname_github_connect %} is configured, you can use the latest version of an action by deleting its local repository in the `actions` organization on your instance. For example, if your enterprise instance is using the `actions/checkout@v1` action, and you need to use `actions/checkout@v2` which isn't available on your enterprise instance, perform the following steps to be able to use the latest `checkout` action from {% data variables.product.prodname_dotcom_the_website %}: +To allow {% data variables.product.product_name %} to use actions directly from {% data variables.product.prodname_dotcom_the_website %}, you can use {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." -1. By default, site administrators are not owners of the bundled actions organization. To get the required access to delete the `checkout` repository, use the `ghe-org-admin-promote` command to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." For example: - - ```shell - $ ghe-org-admin-promote -u octocat -o actions - Do you want to give organization admin privileges for actions to octocat? (y/N) y - Making octocat an admin of actions - --> Adding octocat as an admin of actions - --> octocat is now an admin of the actions organization - --> Done. - ``` -1. On your {% data variables.product.product_name %} instance, delete the `checkout` repository within the `actions` organization. For information on how to delete a repository, see "[Deleting a repository -](/github/administering-a-repository/deleting-a-repository)." -1. It is recommended that you leave the `actions` organization once you no longer require administrative access. For more information, see "[Removing yourself from an organization -](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization)." -1. Configure your workflow's YAML to use `actions/checkout@v2`. -1. Each time your workflow runs, the runner will use the `v2` version of `actions/checkout` from {% data variables.product.prodname_dotcom_the_website %}. +Once configured, you can use a new version of an action from {% data variables.product.prodname_dotcom_the_website %} by manually specifying the required version in the workflow file. For example, to use version `v2.2.1` of `actions/setup-python` from {% data variables.product.prodname_dotcom_the_website %}, you can specify the tag `actions/setup-python@v2.2.1` in your workflow file. diff --git a/content/admin/overview/managing-billing-for-your-enterprise.md b/content/admin/overview/managing-billing-for-your-enterprise.md index a2c781792..8b8000cdc 100644 --- a/content/admin/overview/managing-billing-for-your-enterprise.md +++ b/content/admin/overview/managing-billing-for-your-enterprise.md @@ -26,7 +26,7 @@ For example, here are the costs for users with licenses on different dates. User | License dates | Counted days | Cost ---- | ------------ | ------- | ----- @octocat | January 1 - January 31 | 31 | $39 -@robocat | February 1 - February 28 | 28 | $35.23 +@robocat | February 1 - February 28 | 29 | $35.23 @devtocat | January 15 - January 31 | 17 | $21.39 @doctocat | January 1 - January 15 | 31 | $39 @prodocat | January 7 - January 15 | 25 | $31.45 diff --git a/content/admin/user-management/migrating-to-internal-repositories.md b/content/admin/user-management/migrating-to-internal-repositories.md index 24b7a43c7..c3abc3d40 100644 --- a/content/admin/user-management/migrating-to-internal-repositories.md +++ b/content/admin/user-management/migrating-to-internal-repositories.md @@ -34,12 +34,6 @@ If you don't have private mode enabled, the migration script will have no effect ### Running the migration 1. Connect to the administrative shell. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/admin/installation/accessing-the-administrative-shell-ssh)." -{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} -2. Run the migration command. - ```shell - github-env bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log - ``` -{% else %} 2. Navigate to the `/data/github/current` directory. ```shell cd /data/github/current @@ -48,7 +42,6 @@ If you don't have private mode enabled, the migration script will have no effect ```shell sudo bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log ``` -{% endif %} Log output will appear in the terminal and `/tmp/convert_public_ghes_repos_to_internal.log`. diff --git a/content/code-security/secure-coding/configuring-code-scanning.md b/content/code-security/secure-coding/configuring-code-scanning.md index 0078ca4b8..5c8ac9204 100644 --- a/content/code-security/secure-coding/configuring-code-scanning.md +++ b/content/code-security/secure-coding/configuring-code-scanning.md @@ -187,10 +187,7 @@ Alternatively, you can install Python dependencies manually on any operating sys jobs: CodeQL-Build: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write - actions: read{% endif %} + runs-on: ubuntu-latest steps: - name: Checkout repository diff --git a/content/code-security/secure-coding/running-codeql-code-scanning-in-a-container.md b/content/code-security/secure-coding/running-codeql-code-scanning-in-a-container.md index dfe591b62..0838bf8d0 100644 --- a/content/code-security/secure-coding/running-codeql-code-scanning-in-a-container.md +++ b/content/code-security/secure-coding/running-codeql-code-scanning-in-a-container.md @@ -48,10 +48,7 @@ on: jobs: analyze: name: Analyze - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write - actions: read{% endif %} + runs-on: ubuntu-latest strategy: fail-fast: false diff --git a/content/code-security/secure-coding/troubleshooting-the-codeql-workflow.md b/content/code-security/secure-coding/troubleshooting-the-codeql-workflow.md index bd3a877de..09891aae6 100644 --- a/content/code-security/secure-coding/troubleshooting-the-codeql-workflow.md +++ b/content/code-security/secure-coding/troubleshooting-the-codeql-workflow.md @@ -34,10 +34,7 @@ If an automatic build of code for a compiled language within your project fails, ```yaml jobs: - analyze:{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write - actions: read{% endif %} + analyze: ... strategy: fail-fast: false diff --git a/content/code-security/secure-coding/uploading-a-sarif-file-to-github.md b/content/code-security/secure-coding/uploading-a-sarif-file-to-github.md index cc5471267..6706d947f 100644 --- a/content/code-security/secure-coding/uploading-a-sarif-file-to-github.md +++ b/content/code-security/secure-coding/uploading-a-sarif-file-to-github.md @@ -68,9 +68,7 @@ on: jobs: build: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write{% endif %} + runs-on: ubuntu-latest steps: # This step checks out a copy of your repository. - name: Checkout repository @@ -102,9 +100,6 @@ on: jobs: build: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write{% endif %} steps: - uses: actions/checkout@v2 - name: Run npm install diff --git a/content/code-security/supply-chain-security/configuration-options-for-dependency-updates.md b/content/code-security/supply-chain-security/configuration-options-for-dependency-updates.md index 5baeed457..d5aaa3cb1 100644 --- a/content/code-security/supply-chain-security/configuration-options-for-dependency-updates.md +++ b/content/code-security/supply-chain-security/configuration-options-for-dependency-updates.md @@ -446,12 +446,12 @@ updates: #### `rebase-strategy` -By default, {% data variables.product.prodname_dependabot %} automatically rebases open pull requests when it detects any changes to the pull request. Use `rebase-strategy` to disable this behavior. +By default, {% data variables.product.prodname_dependabot %} automatically rebases open pull requests when it detects conflicts. Use `rebase-strategy` to disable this behavior. Available rebase strategies - `disabled` to disable automatic rebasing. -- `auto` to use the default behavior and rebase open pull requests when changes are detected. +- `auto` to use the default behavior and rebase open pull requests when conflicts are detected. {% data reusables.dependabot.option-affects-security-updates %} @@ -731,7 +731,6 @@ You use the following options to specify access settings. Registry settings must | `url` | The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, `https://` is assumed. {% data variables.product.prodname_dependabot %} adds or ignores trailing slashes as required. | | `username` | The username that {% data variables.product.prodname_dependabot %} uses to access the registry. | | `password` | A reference to a {% data variables.product.prodname_dependabot %} secret containing the password for the specified user. For more information, see "[Managing encrypted secrets for Dependabot](/github/administering-a-repository/managing-encrypted-secrets-for-dependabot)." | -| `key` | A reference to a {% data variables.product.prodname_dependabot %} secret containing an access key for this registry. For more information, see "[Managing encrypted secrets for Dependabot](/github/administering-a-repository/managing-encrypted-secrets-for-dependabot)." | | `token` | A reference to a {% data variables.product.prodname_dependabot %} secret containing an access token for this registry. For more information, see "[Managing encrypted secrets for Dependabot](/github/administering-a-repository/managing-encrypted-secrets-for-dependabot)." | | `replaces-base` | For registries with `type: python-index`, if the boolean value is `true`, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default `https://pypi.org/simple`). | @@ -796,20 +795,6 @@ registries: ``` {% endraw %} -#### `hex-organization` - -The `hex-organization` type supports organization and key. - -{% raw %} -```yaml -registries: - github-hex-org: - type: hex-organization - organization: github - key: ${{secrets.MY_HEX_ORGANIZATION_KEY}} -``` -{% endraw %} - #### `maven-repository` The `maven-repository` type supports username and password, or token. diff --git a/content/code-security/supply-chain-security/index.md b/content/code-security/supply-chain-security/index.md index e5358daad..3204a8868 100644 --- a/content/code-security/supply-chain-security/index.md +++ b/content/code-security/supply-chain-security/index.md @@ -20,7 +20,6 @@ topics: {% link_in_list /exploring-the-dependencies-of-a-repository %} {% topic_link_in_list /keeping-your-dependencies-updated-automatically %} {% link_in_list /about-dependabot-version-updates %} - {% link_in_list /upgrading-from-dependabotcom-to-github-native-dependabot %} {% link_in_list /enabling-and-disabling-version-updates %} {% link_in_list /listing-dependencies-configured-for-version-updates %} {% link_in_list /managing-pull-requests-for-dependency-updates %} diff --git a/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md b/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md deleted file mode 100644 index d37315dfd..000000000 --- a/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Upgrading from Dependabot.com to GitHub-native Dependabot -intro: 'You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated.' -versions: - free-pro-team: '*' -topics: - - repositories ---- - -### About upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} - -Dependabot Preview has been built directly into {% data variables.product.prodname_dotcom %}, so you can use {% data variables.product.prodname_dependabot %} alongside all the other functionality in {% data variables.product.prodname_dotcom %} without having to install and use a separate application. By migrating to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, we can also focus on bringing lots of exciting new features to {% data variables.product.prodname_dependabot %}, including more [ecosystem updates](https://github.com/github/roadmap/issues/150), [improved notifications](https://github.com/github/roadmap/issues/133), and {% data variables.product.prodname_dependabot %} support for [{% data variables.product.prodname_ghe_server %}](https://github.com/github/roadmap/issues/86) and [{% data variables.product.prodname_ghe_managed %}](https://github.com/github/roadmap/issues/135). - -### Differences between Dependabot Preview and {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} - -While most of the Dependabot Preview features exist in {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, a few remain unavailable: -- **Live updates:** We hope to bring these back in the future. For now, you can run {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dependabot %} daily to catch new packages within one day of release. -- **PHP environment variable registries:** For now, you can use {% data variables.product.prodname_actions %} to fetch dependencies from these registries. -- **Auto-merge:** We always recommend verifying your dependencies before merging them; therefore, auto-merge will not be supported for the foreseeable future. For those of you who have vetted your dependencies, or are only using internal dependencies, we recommend adding third-party auto-merge apps, or setting up GitHub Actions to merge. - -In {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, you can configure all version updates using the configuration file. This file is similar to the Dependabot Preview configuration file with a few changes and improvements that will be automatically included in your upgrade pull request. For more information about the upgrade pull request, see "[Upgrading to GitHub-native Dependabot](/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot#upgrading-to-github-native-dependabot)". - -To see update logs for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} that were previously on the Dependabot.com dashboard: - - 1. Navigate to your repository’s **Insights** page. - 2. Click **Dependency graph** to the left. - 3. Click **{% data variables.product.prodname_dependabot %}**. - -For more information about version updates with {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, see "[About Dependabot version updates](/code-security/supply-chain-security/about-dependabot-version-updates)." - -### Upgrading to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} - -Upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} requires only one step: merge the *Upgrade to GitHub-native Dependabot* pull request in your repository. This pull request includes the updated configuration file needed for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}. - -If you have any questions or need help migrating, you can view or open issues in the [dependabot/dependabot-core](https://github.com/dependabot/dependabot-core/issues) repository. - diff --git a/content/communities/documenting-your-project-with-wikis/about-wikis.md b/content/communities/documenting-your-project-with-wikis/about-wikis.md index f814ef736..2fe6a489b 100644 --- a/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -22,12 +22,6 @@ With wikis, you can write content just like everywhere else on {% data variables You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". -{% note %} - -**Note:** Search engines will not index the contents of wikis. To have your content indexed by search engines, you can use [{% data variables.product.prodname_pages %}](/pages) in a public repository. - -{% endnote %} - ### Further reading - "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)" diff --git a/content/developers/apps/creating-ci-tests-with-the-checks-api.md b/content/developers/apps/creating-ci-tests-with-the-checks-api.md index b84c8e12f..da28bc32b 100644 --- a/content/developers/apps/creating-ci-tests-with-the-checks-api.md +++ b/content/developers/apps/creating-ci-tests-with-the-checks-api.md @@ -140,16 +140,18 @@ You'll add this new method as a [Sinatra helper](https://github.com/sinatra/sina ``` ruby # Create a new check run with the status queued def create_check_run - @installation_client.create_check_run( - # [String, Integer, Hash, Octokit Repository object] A GitHub repository. - @payload['repository']['full_name'], - # [String] The name of your check run. - 'Octo RuboCop', - # [String] The SHA of the commit to check - # The payload structure differs depending on whether a check run or a check suite event occurred. - @payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha'], - # [Hash] 'Accept' header option, to avoid a warning about the API not being ready for production use. - accept: 'application/vnd.github.v3+json' + # # At the time of writing, Octokit does not support the Checks API yet, but + # it does provide generic HTTP methods you can use: + # /rest/reference/checks#create-a-check-run + check_run = @installation_client.post( + "repos/#{@payload['repository']['full_name']}/check-runs", + { + accept: 'application/vnd.github.v3+json', + # The name of your check run. + name: 'Octo RuboCop', + # The payload structure differs depending on whether a check run or a check suite event occurred. + head_sha: @payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha'] + } ) end ``` @@ -157,22 +159,25 @@ end ``` ruby # Create a new check run with the status queued def create_check_run - @installation_client.create_check_run( - # [String, Integer, Hash, Octokit Repository object] A GitHub repository. - @payload['repository']['full_name'], - # [String] The name of your check run. - 'Octo RuboCop', - # [String] The SHA of the commit to check - # The payload structure differs depending on whether a check run or a check suite event occurred. - @payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha'], - # [Hash] 'Accept' header option, to avoid a warning about the API not being ready for production use. - accept: 'application/vnd.github.antiope-preview+json' + # # At the time of writing, Octokit does not support the Checks API yet, but + # it does provide generic HTTP methods you can use: + # /rest/reference/checks#create-a-check-run + check_run = @installation_client.post( + "repos/#{@payload['repository']['full_name']}/check-runs", + { + # This header allows for beta access to Checks API + accept: 'application/vnd.github.antiope-preview+json', + # The name of your check run. + name: 'Octo RuboCop', + # The payload structure differs depending on whether a check run or a check suite event occurred. + head_sha: @payload['check_run'].nil? ? @payload['check_suite']['head_sha'] : @payload['check_run']['head_sha'] + } ) end ``` {% endif %} -This code calls the "[Create a check run](/rest/reference/checks#create-a-check-run)" endpoint using the [create_check_run method](https://rdoc.info/gems/octokit/Octokit%2FClient%2FChecks:create_check_run). +This code calls the "[Create a check run](/rest/reference/checks#create-a-check-run)" endpoint using the generic [HTTP `POST` method](http://octokit.github.io/octokit.rb/Octokit/Connection.html#post-instance_method). This method takes two parameters: the URL of the endpoint and the input parameters to the method. To create a check run, only two input parameters are required: `name` and `head_sha`. We will use [Rubocop](https://rubocop.readthedocs.io/en/latest/) to implement the CI test later in this quickstart, which is why the name "Octo Rubocop" is used here, but you can choose any name you'd like for the check run. @@ -235,22 +240,31 @@ def initiate_check_run # to 'in_progress' and run the CI process. When the CI finishes, you'll # update the check run status to 'completed' and add the CI results. - @installation_client.update_check_run( - @payload['repository']['full_name'], - @payload['check_run']['id'], - status: 'in_progress', - accept: 'application/vnd.github.v3+json' + # Octokit doesn't yet support the Checks API, but it does provide generic + # HTTP methods you can use: + # /rest/reference/checks#update-a-check-run + updated_check_run = @installation_client.patch( + "repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", + { + accept: 'application/vnd.github.v3+json', + name: 'Octo RuboCop', + status: 'in_progress', + started_at: Time.now.utc.iso8601 + } ) # ***** RUN A CI TEST ***** # Mark the check run as complete! - @installation_client.update_check_run( - @payload['repository']['full_name'], - @payload['check_run']['id'], - status: 'completed', - conclusion: 'success', - accept: 'application/vnd.github.v3+json' + updated_check_run = @installation_client.patch( + "repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", + { + accept: 'application/vnd.github.v3+json', + name: 'Octo RuboCop', + status: 'completed', + conclusion: 'success', + completed_at: Time.now.utc.iso8601 + } ) end ``` @@ -262,30 +276,40 @@ def initiate_check_run # to 'in_progress' and run the CI process. When the CI finishes, you'll # update the check run status to 'completed' and add the CI results. - @installation_client.update_check_run( - @payload['repository']['full_name'], - @payload['check_run']['id'], - status: 'in_progress', - accept: 'application/vnd.github.antiope-preview+json' + # Octokit doesn't yet support the Checks API, but it does provide generic + # HTTP methods you can use: + # /rest/reference/checks#update-a-check-run + updated_check_run = @installation_client.patch( + "repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", + { + accept: 'application/vnd.github.antiope-preview+json', # This header is necessary for beta access to Checks API + name: 'Octo RuboCop', + status: 'in_progress', + started_at: Time.now.utc.iso8601 + } ) # ***** RUN A CI TEST ***** # Mark the check run as complete! - @installation_client.update_check_run( - @payload['repository']['full_name'], - @payload['check_run']['id'], - status: 'completed', - conclusion: 'success', - accept: 'application/vnd.github.antiope-preview+json' + updated_check_run = @installation_client.patch( + "repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", + { + # This header is necessary for beta access to Checks API + accept: 'application/vnd.github.antiope-preview+json', + name: 'Octo RuboCop', + status: 'completed', + conclusion: 'success', + completed_at: Time.now.utc.iso8601 + } ) end ``` {% endif %} -The code above calls the "[Update a check run](/rest/reference/checks#update-a-check-run)" API endpoint using the [`update_check_run` Octokit method](https://rdoc.info/gems/octokit/Octokit%2FClient%2FChecks:update_check_run) to update the check run that you already created. +The code above calls the "[Update a check run](/rest/reference/checks#update-a-check-run)" API endpoint using the generic [`patch` HTTP method](http://octokit.github.io/octokit.rb/Octokit/Connection.html#patch-instance_method) to update the check run that you already created. -Here's what this code is doing. First, it updates the check run's status to `in_progress` and implicitly sets the `started_at` time to the current time. In [Part 2](#part-2-creating-the-octo-rubocop-ci-test) of this quickstart, you'll add code that kicks off a real CI test under `***** RUN A CI TEST *****`. For now, you'll leave that section as a placeholder, so the code that follows it will just simulate that the CI process succeeds and all tests pass. Finally, the code updates the status of the check run again to `completed`. +Here's what this code is doing. First, it updates the check run's status to `in_progress` and sets the `started_at` time to the current time. In [Part 2](#part-2-creating-the-octo-rubocop-ci-test) of this quickstart, you'll add code that kicks off a real CI test under `***** RUN A CI TEST *****`. For now, you'll leave that section as a placeholder, so the code that follows it will just simulate that the CI process succeeds and all tests pass. Finally, the code updates the status of the check run again to `completed`. You'll notice in the "[Update a check run](/rest/reference/checks#update-a-check-run)" docs that when you provide a status of `completed`, the `conclusion` and `completed_at` parameters are required. The `conclusion` summarizes the outcome of a check run and can be `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. You'll set the conclusion to `success`, the `completed_at` time to the current time, and the status to `completed`. @@ -589,23 +613,29 @@ Now you've got all the information you need to update your check run. In the [fi {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ``` ruby # Mark the check run as complete! -@installation_client.update_check_run( - @payload['repository']['full_name'], - @payload['check_run']['id'], - status: 'completed', - conclusion: 'success', - accept: 'application/vnd.github.v3+json' +updated_check_run = @installation_client.patch( + "repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", + { + accept: 'application/vnd.github.v3+json', + name: 'Octo RuboCop', + status: 'completed', + conclusion: 'success', + completed_at: Time.now.utc.iso8601 + } ) ``` {% else %} ``` ruby # Mark the check run as complete! -@installation_client.update_check_run( - @payload['repository']['full_name'], - @payload['check_run']['id'], - status: 'completed', - conclusion: 'success', - accept: 'application/vnd.github.antiope-preview+json' # This header is necessary for beta access to Checks API +updated_check_run = @installation_client.patch( + "repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", + { + accept: 'application/vnd.github.antiope-preview+json', # This header is necessary for beta access to Checks API + name: 'Octo RuboCop', + status: 'completed', + conclusion: 'success', + completed_at: Time.now.utc.iso8601 + } ) ``` {% endif %} @@ -615,45 +645,51 @@ You'll need to update that code to use the `conclusion` variable you set based o {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ``` ruby # Mark the check run as complete! And if there are warnings, share them. -@installation_client.update_check_run( - @payload['repository']['full_name'], - @payload['check_run']['id'], - status: 'completed', - conclusion: conclusion, - output: { - title: 'Octo RuboCop', - summary: summary, - text: text, - annotations: annotations - }, - actions: [{ - label: 'Fix this', - description: 'Automatically fix all linter notices.', - identifier: 'fix_rubocop_notices' - }], - accept: 'application/vnd.github.v3+json' +updated_check_run = @installation_client.patch( + "repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", + { + accept: 'application/vnd.github.v3+json', + name: 'Octo RuboCop', + status: 'completed', + conclusion: conclusion, + completed_at: Time.now.utc.iso8601, + output: { + title: 'Octo RuboCop', + summary: summary, + text: text, + annotations: annotations + }, + actions: [{ + label: 'Fix this', + description: 'Automatically fix all linter notices.', + identifier: 'fix_rubocop_notices' + }] + } ) ``` {% else %} ``` ruby # Mark the check run as complete! And if there are warnings, share them. -@installation_client.update_check_run( - @payload['repository']['full_name'], - @payload['check_run']['id'], - status: 'completed', - conclusion: conclusion, - output: { - title: 'Octo RuboCop', - summary: summary, - text: text, - annotations: annotations - }, - actions: [{ - label: 'Fix this', - description: 'Automatically fix all linter notices.', - identifier: 'fix_rubocop_notices' - }], - accept: 'application/vnd.github.antiope-preview+json' +updated_check_run = @installation_client.patch( + "repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}", + { + accept: 'application/vnd.github.antiope-preview+json', + name: 'Octo RuboCop', + status: 'completed', + conclusion: conclusion, + completed_at: Time.now.utc.iso8601, + output: { + title: 'Octo RuboCop', + summary: summary, + text: text, + annotations: annotations + }, + actions: [{ + label: 'Fix this', + description: 'Automatically fix all linter notices.', + identifier: 'fix_rubocop_notices' + }] + } ) ``` {% endif %} diff --git a/content/developers/overview/secret-scanning.md b/content/developers/overview/secret-scanning.md index 2f3c81857..d7d1e02bf 100644 --- a/content/developers/overview/secret-scanning.md +++ b/content/developers/overview/secret-scanning.md @@ -88,12 +88,6 @@ We strongly recommend you implement signature validation in your secret alert se You can retrieve the {% data variables.product.prodname_dotcom %} secret scanning public key from https://api.github.com/meta/public_keys/secret_scanning and validate the message using the `ECDSA-NIST-P256V1-SHA256` algorithm. -{% note %} - -**Note**: When you send a request to the public key endpoint above, you may hit rate limits. To avoid hitting rate limits, you can use a personal access token as suggested below, or use a conditional request. For more information, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api#conditional-requests)." - -{% endnote %} - Assuming you receive the following message, the code snippets below demonstrate how you could perform signature validation. The code also assumes you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated PAT (https://github.com/settings/tokens). The token does not need any permissions set. @@ -364,3 +358,4 @@ A few important points: **Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at secret-scanning@github.com. {% endnote %} + diff --git a/content/developers/webhooks-and-events/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhook-events-and-payloads.md index 2993bc180..e2a9c0974 100644 --- a/content/developers/webhooks-and-events/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhook-events-and-payloads.md @@ -199,9 +199,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (`https://subdomain.example.com`) then only URLs for the subdomain trigger this event. If you register a domain (`https://example.com`) then URLs for domain and all subdomains trigger this event. See "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" to create a new content attachment. -#### Availability - -- {% data variables.product.prodname_github_app %}s with the `content_references:write` permission +Only {% data variables.product.prodname_github_app %}s can receive this event. {% data variables.product.prodname_github_app %}s must have the `content_references` `write` permission to subscribe to this event. #### Webhook payload example @@ -1010,6 +1008,12 @@ Deliveries for `review_requested` and `review_request_removed` events will have {% endnote %} +{% tip %} + +**Note**: The webhook payload example following the table differs significantly from the Events API payload described in the table. Among other differences, the webhook payload includes both `sender` and `pusher` objects. Sender and pusher are the same user who initiated the `push` event, but the `sender` object contains more detail. + +{% endtip %} + #### Availability - Repository webhooks @@ -1200,7 +1204,7 @@ Key | Type | Description {% data reusables.webhooks.sponsorship_short_desc %} -You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". +You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". #### Availability diff --git a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md index beb9a8185..68990facf 100644 --- a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md +++ b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md @@ -85,22 +85,3 @@ You can disable all workflows for a repository or set a policy that configures w {% data reusables.repositories.settings-sidebar-actions %} {% data reusables.github-actions.private-repository-forks-configure %} {% endif %} - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} -### Setting the permissions of the `GITHUB_TOKEN` for your repository - -{% data reusables.github-actions.workflow-permissions-intro %} - -The default permissions can also be configured in the organization settings. If the more restricted default has been selected in the organization settings, the same option is auto-selected in your repository settings and the permissive option is disabled. - -{% data reusables.github-actions.workflow-permissions-modifying %} - -#### Configuring the default `GITHUB_TOKEN` permissions - -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -{% data reusables.repositories.settings-sidebar-actions %} -1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. - ![Set GITHUB_TOKEN permissions for this repository](/assets/images/help/settings/actions-workflow-permissions-repository.png) -1. Click **Save** to apply the settings. -{% endif %} diff --git a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md index e01f878b7..f92ae3b70 100644 --- a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md @@ -12,7 +12,7 @@ topics: ### About FUNDING files -You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." +You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/articles/about-github-sponsors)." You can add one username, package name, or project name per external funding platform and up to four custom URLs. You can add up to four sponsored developers or organizations in {% data variables.product.prodname_sponsors %}. Add each platform on a new line, using the following syntax: @@ -79,5 +79,5 @@ Anyone with admin permissions can enable a sponsor button in a repository. {% data reusables.files.propose_new_file %} ### Further reading -- "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" +- "[About {% data variables.product.prodname_sponsors %} for open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors)" - "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md index 7a1376f8f..23fb2d23e 100644 --- a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md @@ -87,7 +87,6 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. ```shell - $ sudo apt-get update $ sudo apt-get install xclip # Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`) diff --git a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 4b5a722ad..93182ab50 100644 --- a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -91,7 +91,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav $ touch ~/.ssh/config ``` - * Open your `~/.ssh/config` file, then modify the file to contain the following lines. If your SSH key file has a different name or path than the example code, modify the filename or path to match your current setup. + * Open your `~/.ssh/config` file, then modify the file, replacing ` ~/.ssh/id_ed25519` if you are not using the default location and name for your `id_ed25519` key. ``` Host * diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md index 96f380f96..60dc147f2 100644 --- a/content/github/authenticating-to-github/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/reviewing-your-security-log.md @@ -54,7 +54,7 @@ The events listed in your security log are triggered by your actions. Actions ar | [`project`](#project-category-actions) | Contains all activities related to project boards. | [`public_key`](#public_key-category-actions) | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account). | [`repo`](#repo-category-actions) | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %} -| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} | [`team`](#team-category-actions) | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %} | [`two_factor_authentication`](#two_factor_authentication-category-actions) | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %} | [`user`](#user-category-actions) | Contains all activities related to your account. @@ -93,10 +93,6 @@ An overview of some of the most common actions that are recorded as events in th | Action | Description |------------------|------------------- -| `create` | Triggered when you [create a codespace](/github/developing-online-with-codespaces/creating-a-codespace). -| `resume` | Triggered when you resume a suspended codespace. -| `delete` | Triggered when you [delete a codespace](/github/developing-online-with-codespaces/deleting-a-codespace). -| `manage_access_and_security` | Triggered when you update [the repositories a codespace has access to](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | `trusted_repositories_access_update` | Triggered when you change your user account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). #### `marketplace_agreement_signature` category actions @@ -193,19 +189,19 @@ An overview of some of the most common actions that are recorded as events in th | `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") -| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") +| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") | `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled | `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state -| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") -| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") -| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") -| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") +| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") {% endif %} {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md index d3b7eb7dc..3acbcec27 100644 --- a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md +++ b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md @@ -11,7 +11,7 @@ topics: {% tip %} -**{% data variables.product.prodname_ghe_server %} users**: Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported. +**GitHub Enterprise users**: Accessing GitHub Enterprise via SSH over the HTTPS port is currently not supported. {% endtip %} diff --git a/content/github/developing-online-with-codespaces/index.md b/content/github/developing-online-with-codespaces/index.md index 2dafa60d1..699d24bc7 100644 --- a/content/github/developing-online-with-codespaces/index.md +++ b/content/github/developing-online-with-codespaces/index.md @@ -27,4 +27,5 @@ topics: {% link_in_list /managing-gpg-verification-for-codespaces %} {% link_in_list /deleting-a-codespace %} {% link_in_list /troubleshooting-your-codespace %} -{% link_in_list /using-codespaces-in-visual-studio-code %} \ No newline at end of file +{% link_in_list /using-codespaces-in-visual-studio-code %} +{% link_in_list /using-codespaces-in-visual-studio %} diff --git a/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md index aea5edb98..1db7b63da 100644 --- a/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md @@ -25,12 +25,6 @@ When you enable access and security for a repository owned by your user account, 1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) -### Reviewing your security log for {% data variables.product.prodname_codespaces %} - -The security log is where you can review {% data variables.product.prodname_codespaces %} actions that you have performed. For information about accessing the log, see "[Reviewing your security log](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)." - -The security log includes details on what action occured and when you performed it. For information about {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)". - ### Managing security and access for your organization Organization owners can manage security and access for {% data variables.product.prodname_codespaces %}. @@ -47,9 +41,3 @@ When you enable access and security for a repository owned by your organization, ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) 1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories. !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) - -### Reviewing your organization's audit logs for {% data variables.product.prodname_codespaces %} - -The audit log is where you can review actions related to {% data variables.product.prodname_codespaces %} that have been performed by members of your organization. For information about accessing the log, see "[Reviewing your security log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)." - -The audit log includes details such as who performed the action, what the action was, and when the action was performed. For information on {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)." diff --git a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md index ea9cb83a4..f99fc17ff 100644 --- a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md @@ -22,7 +22,6 @@ You can add encrypted secrets to your user account that you want to use in your - Personal access tokens to cloud services - Service principals - Subscription identifiers -- [Credentials for a private image registry](#allowing-your-codespace-to-access-private-images) You can choose which repositories should have access to each secret. Then, you can use the secret in any codespace you create for a repository that has access to the secret. @@ -68,22 +67,3 @@ You can update the value of an existing secret, and you can change which reposit !["Delete" button](/assets/images/help/settings/codespaces-secret-delete-button.png) 1. Read the warning, then click **OK**. ![Confirmation to delete secret](/assets/images/help/settings/codespaces-secret-delete-warning.png) - -### Allowing your codespace to access private images - -A registry is a secure space for storing and managing private container images, such as Azure Container Registry or DockerHub. By adding a secret, your codespace can access private images within the registry. - -When a codespace launches, {% data variables.product.prodname_codespaces %} will check for the following three secrets, which define the server name, username, and personal access token (PAT) for the container registry. If those secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace. - -- `<*>_CONTAINER_REGISTRY_SERVER` -- `<*>_CONTAINER_REGISTRY_USER` -- `<*>_CONTAINER_REGISTRY_PASSWORD` - -Use the steps in "[Adding a secret](#adding-a-secret)" to add a secret for each of these items. Replace the “<*>” in the name with a consistent identifier. For example, if you had a private image registry in Azure, it might look like the following: - -``` -ACR_CONTAINER_REGISTRY_SERVER = mycompany.azurecr.io -ACR_CONTAINER_REGISTRY_USER = acr-user-here -ACR_CONTAINER_REGISTRY_PASSWORD = -``` -![Image registry secret example](/assets/images/help/settings/codespaces-image-registry-secret-example.png) diff --git a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md index b5ad5e9ab..a190ef196 100644 --- a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md +++ b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md @@ -4,7 +4,6 @@ intro: 'You can develop in your codespace directly in {% data variables.product. product: '{% data reusables.gated-features.codespaces %}' redirect_from: - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code - - /github/developing-online-with-codespaces/using-codespaces-in-visual-studio versions: free-pro-team: '*' topics: @@ -28,7 +27,7 @@ To develop in a codespace directly in {% data variables.product.prodname_vscode ### Creating a codespace in {% data variables.product.prodname_vscode %} -After you connect your {% data variables.product.product_name %} account to the {% data variables.product.prodname_github_codespaces %} extension, you can develop in a codespace that you created on {% data variables.product.product_name %} or in {% data variables.product.prodname_vscode %}. +After you connect your {% data variables.product.product_name %} account to the {% data variables.product.prodname_vs_codespaces %} extension, you can develop in a codespace that you created on {% data variables.product.product_name %} or in {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.click-remote-explorer-icon-vscode %} 2. Click the Add icon, then click **Create New Codespace**. @@ -46,30 +45,6 @@ After you connect your {% data variables.product.product_name %} account to the 3. Click the Connect to Codespace icon. ![The Connect to Codespace icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png) -### Changing the machine type in {% data variables.product.prodname_vscode %} - -You can run your codespace on a choice of three types of machine: Basic, Standard, or Premium. Each of these has a different level of resources and a different billing tier. - -{% note %} - -**Note:** {% data reusables.codespaces.about-billing-for-codespaces %} - -{% endnote %} - -{% data reusables.codespaces.codespaces-machine-types %} - -You can change the machine type of your codespace at any time. - -1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`). -2. Search for and select "Codespaces: Change Machine Type." -![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-type-option.png) -3. Click the codespace that you want to change. -![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-repo.png) -4. Choose the machine type you want to use. -![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/vscode-change-machine-choose-type.png) - -If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts. - ### Deleting a codespace in {% data variables.product.prodname_vscode %} 1. Under "Codespaces", right-click the codespace you want to delete. diff --git a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md new file mode 100644 index 000000000..fb1cb2e46 --- /dev/null +++ b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md @@ -0,0 +1,19 @@ +--- +title: Using Codespaces in Visual Studio +intro: 'This preview has concluded and will no longer be accepting signups.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + free-pro-team: '*' +topics: + - codespaces +--- + +{% note %} + +**Note:** {% data variables.product.prodname_codespaces %} is currently in limited public beta and subject to change. During the beta period, {% data variables.product.prodname_dotcom %} does not make any guarantees about the availability of {% data variables.product.prodname_codespaces %}. + +{% endnote %} + +### About codespaces in {% data variables.product.prodname_vs %} + +The private preview for GitHub Codespaces in Visual Studio 2019 has concluded. For more information, see the [Visual Studio 2019 documentation](https://docs.microsoft.com/visualstudio/ide/codespaces/codespaces-overview?view=vs-2019). diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md index a9ac46838..c7fbdb2ec 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md @@ -154,51 +154,6 @@ If your workflow does not contain a matrix called `language`, then {% data varia with: languages: cpp, csharp, python ``` -{% if currentVersion == "free-pro-team@latest" %} -### Analyzing Python dependencies - -For GitHub-hosted runners that use Linux only, the {% data variables.product.prodname_codeql_workflow %} will try to auto-install Python dependencies to give more results for the CodeQL analysis. You can control this behavior by specifying the `setup-python-dependencies` parameter for the action called by the "Initialize CodeQL" step. By default, this parameter is set to `true`: - -- If the repository contains code written in Python, the "Initialize CodeQL" step installs the necessary dependencies on the GitHub-hosted runner. If the auto-install succeeds, the action also sets the environment variable `CODEQL_PYTHON` to the Python executable file that includes the dependencies. - -- If the repository doesn't have any Python dependencies, or the dependencies are specified in an unexpected way, you'll get a warning and the action will continue with the remaining jobs. The action can run successfully even when there are problems interpreting dependencies, but the results may be incomplete. - -Alternatively, you can install Python dependencies manually on any operating system. You will need to add `setup-python-dependencies` and set it to `false`, as well as set `CODEQL_PYTHON` to the Python executable that includes the dependencies, as shown in this workflow extract: - -```yaml -jobs: - CodeQL-Build: - - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write - actions: read{% endif %} - - steps: - - name: Checkout repository - uses: actions/checkout@v2 - - name: Set up Python - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - run: | - python -m pip install --upgrade pip - if [ -f requirements.txt ]; - then pip install -r requirements.txt; - fi - # Set the `CODEQL-PYTHON` environment variable to the Python executable - # that includes the dependencies - echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: python - # Override the default behavior so that the action doesn't attempt - # to auto-install Python dependencies - setup-python-dependencies: false -``` -{% endif %} ### Running additional queries diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md index 281e290fd..ad4b931e8 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md @@ -44,10 +44,7 @@ on: jobs: analyze: name: Analyze - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write - actions: read{% endif %} + runs-on: ubuntu-latest strategy: fail-fast: false diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md index 17e674e6b..af6461511 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md @@ -29,10 +29,7 @@ If an automatic build of code for a compiled language within your project fails, ```yaml jobs: - analyze:{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write - actions: read{% endif %} + analyze: ... strategy: fail-fast: false diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md index 077bd7be6..5adc5c83f 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md @@ -63,9 +63,7 @@ on: jobs: build: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write{% endif %} + runs-on: ubuntu-latest steps: # This step checks out a copy of your repository. - name: Checkout repository @@ -97,9 +95,6 @@ on: jobs: build: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - security-events: write{% endif %} steps: - uses: actions/checkout@v2 - name: Run npm install diff --git a/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md b/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md index e3d517ddc..010c9aea6 100644 --- a/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md +++ b/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md @@ -21,7 +21,7 @@ Query parameters are optional parts of a URL you can customize to share a specif You must have the proper permissions for any action to use the equivalent query parameter. For example, you must have permission to add a label to an issue to use the `labels` query parameter. -If you create an invalid URL using query parameters, or if you don’t have the proper permissions, the URL will return a `404 Not Found` error page. If you create a URL that exceeds the server limit, the URL will return a `414 URI Too Long` error page. +If you create an invalid URL using query parameters, or if you don’t have the proper permissions, the URL will return a 404 error page. ### Supported query parameters diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md index f5bc43bd2..19604adde 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md @@ -17,5 +17,5 @@ topics: ### Further reading -- "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" -- "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)" +- "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" +- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" diff --git a/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md index 6c23eff62..99413f99b 100644 --- a/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account.md @@ -49,20 +49,3 @@ You can disable all workflows for an enterprise or set a policy that configures {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.github-actions.private-repository-forks-configure %} - -### Setting the permissions of the `GITHUB_TOKEN` for your enterprise - -{% data reusables.github-actions.workflow-permissions-intro %} - -You can set the default permissions for the `GITHUB_TOKEN` in the settings for your enterprise, organizations, or repositories. If you choose the restricted option as the default in your enterprise settings, this prevents the more permissive setting being chosen in the organization or repository settings. - -{% data reusables.github-actions.workflow-permissions-modifying %} - -#### Configuring the default `GITHUB_TOKEN` permissions - -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.policies-tab %} -{% data reusables.enterprise-accounts.actions-tab %} -1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. - ![Set GITHUB_TOKEN permissions for this enterprise](/assets/images/help/settings/actions-workflow-permissions-enterprise.png) -1. Click **Save** to apply the settings. diff --git a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md index 742b05dcd..b5cdcf579 100644 --- a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md @@ -56,7 +56,7 @@ You can change the name that is displayed on your profile. This name may also be ### Adding a bio to your profile -Add a bio to your profile to share information about yourself with other {% data variables.product.product_name %} users. With the help of [@mentions](/articles/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink. +Add a bio to your profile to share information about yourself with other {% data variables.product.product_name %} users. With the help of [@mentions](/articles/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} @@ -122,98 +122,22 @@ When you participate in certain programs, {% data variables.product.prodname_dot | Badge | Program | Description | | --- | --- | --- | -| ![Mars 2020 Helicopter Contributor badge icon](/assets/images/help/profile/badge-mars-2020-small.png) | **Mars 2020 Helicopter Contributor** | If you authored any commit(s) on the default branch up to the relevant version of an open source library used in the Mars 2020 Helicopter Mission, you'll get a Mars 2020 Helicopter Contributor badge on your profile. Hovering over the badge shows you several of the repositories you contributed to that were used in the mission. For the full list of repositories that will qualify you for the badge, see "[List of qualifying repositories for Mars 2020 Helicopter Contributor badge](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#list-of-qualifying-repositories-for-mars-2020-helicopter-contributor-badge)." | -| ![Arctic Code Vault Contributor badge icon](/assets/images/help/profile/badge-arctic-code-vault-small.png) | **{% data variables.product.prodname_arctic_vault %} Contributor** | If you authored any commit(s) on the default branch of a repository that was archived in the 2020 Arctic Vault program, you'll get an {% data variables.product.prodname_arctic_vault %} Contributor badge on your profile. Hovering over the badge shows you several of the repositories you contributed to that were part of the program. For more information on the program, see [{% data variables.product.prodname_archive %}](https://archiveprogram.github.com). | -| ![{% data variables.product.prodname_dotcom %} Sponsor badge icon](/assets/images/help/profile/badge-sponsors-small.png) | **{% data variables.product.prodname_dotcom %} Sponsor** | If you sponsored an open source contributor through {% data variables.product.prodname_sponsors %} you'll get a {% data variables.product.prodname_dotcom %} Sponsor badge on your profile. Clicking the badge takes you to the **Sponsoring** tab of your profile. For more information, see "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)." | -| {% octicon "cpu" aria-label="The Developer Program icon" %} | **Developer Program Member** | If you're a registered member of the {% data variables.product.prodname_dotcom %} Developer Program, building an app with the {% data variables.product.prodname_dotcom %} API, you'll get a Developer Program Member badge on your profile. For more information on the {% data variables.product.prodname_dotcom %} Developer Program, see [GitHub Developer](/program/). | +| {% octicon "north-star" aria-label="The North Star icon" %} | **{% data variables.product.prodname_arctic_vault %} Contributor** | If you authored any commit(s) on the default branch of a repository that was archived in the 2020 Arctic Vault program, you'll get an {% data variables.product.prodname_arctic_vault %} Contributor badge on your profile. For more information on the program, see [{% data variables.product.prodname_archive %}](https://archiveprogram.github.com). | +| {% octicon "cpu" aria-label="The Developer Program icon" %} | **Developer Program Member** | If you're a registered member of the GitHub Developer Program, building an app with the GitHub API, you'll get a Developer Program Member badge on your profile. For more information on the GitHub Developer Program, see [GitHub Developer](/program/). | +| {% octicon "heart-fill" aria-label="The GitHub Sponsor icon" %} | **GitHub Sponsor** | If you sponsored an open source contributor through {% data variables.product.prodname_sponsors %} you'll get a GitHub Sponsor badge on your profile. For more information, see "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)." | | {% octicon "star-fill" aria-label="The star icon" %} | **Pro** | If you use {% data variables.product.prodname_pro %} you'll get a PRO badge on your profile. For more information about {% data variables.product.prodname_pro %}, see "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/githubs-products#github-pro)." | ### Disabling badges on your profile -You can disable some of the badges for {% data variables.product.prodname_dotcom %} programs you're participating in, including the PRO, {% data variables.product.prodname_arctic_vault %} and Mars 2020 Helicopter Contributor badges. +You can disable some of the badges for {% data variables.product.prodname_dotcom %} programs you're participating in, including the PRO and {% data variables.product.prodname_arctic_vault %} badges. {% data reusables.user_settings.access_settings %} 2. Under "Profile settings", deselect the badge you want you disable. - ![Checkbox to no longer display a badge on your profile](/assets/images/help/profile/profile-badge-settings.png) + ![Checkbox to no longer display a badge on your profile](/assets/images/help/profile/display-pro-badge-checkbox.png) 3. Click **Update preferences**. {% endif %} -### List of qualifying repositories for Mars 2020 Helicopter Contributor badge - -If you authored any commit(s) present in the commit history for the listed tag of one or more of the repositories below, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The authored commit must be with a verified email address, associated with your account at the time {% data variables.product.prodname_dotcom %} determined the eligible contributions, in order to be attributed to you. Future changes to verified emails will not have an effect on the badge. We built the list based on information received from NASA's Jet Propulsion Laboratory. - -| {% data variables.product.prodname_dotcom %} Repository | Version | Tag | -|---|---|---| -| [torvalds/linux](https://github.com/torvalds/linux) | 3.4 | [v3.4](https://github.com/torvalds/linux/releases/tag/v3.4) | -| [python/cpython](https://github.com/python/cpython) | 3.9.2 | [v3.9.2](https://github.com/python/cpython/releases/tag/v3.9.2) | -| [boto/boto3](https://github.com/boto/boto3) | 1.17.17 | [1.17.17](https://github.com/boto/boto3/releases/tag/1.17.17) | -| [boto/botocore](https://github.com/boto/botocore) | 1.20.11 | [1.20.11](https://github.com/boto/botocore/releases/tag/1.20.11) | -| [certifi/python-certifi](https://github.com/certifi/python-certifi) | 2020.12.5 | [2020.12.05](https://github.com/certifi/python-certifi/releases/tag/2020.12.05) | -| [chardet/chardet](https://github.com/chardet/chardet) | 4.0.0 | [4.0.0](https://github.com/chardet/chardet/releases/tag/4.0.0) | -| [matplotlib/cycler](https://github.com/matplotlib/cycler) | 0.10.0 | [v0.10.0](https://github.com/matplotlib/cycler/releases/tag/v0.10.0) | -| [elastic/elasticsearch-py](https://github.com/elastic/elasticsearch-py) | 6.8.1 | [6.8.1](https://github.com/elastic/elasticsearch-py/releases/tag/6.8.1) | -| [ianare/exif-py](https://github.com/ianare/exif-py) | 2.3.2 | [2.3.2](https://github.com/ianare/exif-py/releases/tag/2.3.2) | -| [kjd/idna](https://github.com/kjd/idna) | 2.10 | [v2.10](https://github.com/kjd/idna/releases/tag/v2.10) | -| [jmespath/jmespath.py](https://github.com/jmespath/jmespath.py) | 0.10.0 | [0.10.0](https://github.com/jmespath/jmespath.py/releases/tag/0.10.0) | -| [nucleic/kiwi](https://github.com/nucleic/kiwi) | 1.3.1 | [1.3.1](https://github.com/nucleic/kiwi/releases/tag/1.3.1) | -| [matplotlib/matplotlib](https://github.com/matplotlib/matplotlib) | 3.3.4 | [v3.3.4](https://github.com/matplotlib/matplotlib/releases/tag/v3.3.4) | -| [numpy/numpy](https://github.com/numpy/numpy) | 1.20.1 | [v1.20.1](https://github.com/numpy/numpy/releases/tag/v1.20.1) | -| [opencv/opencv-python](https://github.com/opencv/opencv-python) | 4.5.1.48 | [48](https://github.com/opencv/opencv-python/releases/tag/48) | -| [python-pillow/Pillow](https://github.com/python-pillow/Pillow) | 8.1.0 | [8.1.0](https://github.com/python-pillow/Pillow/releases/tag/8.1.0) | -| [pycurl/pycurl](https://github.com/pycurl/pycurl) | 7.43.0.6 | [REL_7_43_0_6](https://github.com/pycurl/pycurl/releases/tag/REL_7_43_0_6) | -| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.7 | [pyparsing_2.4.7](https://github.com/pyparsing/pyparsing/releases/tag/pyparsing_2.4.7) | -| [pyserial/pyserial](https://github.com/pyserial/pyserial) | 3.5 | [v3.5](https://github.com/pyserial/pyserial/releases/tag/v3.5) | -| [dateutil/dateutil](https://github.com/dateutil/dateutil) | 2.8.1 | [2.8.1](https://github.com/dateutil/dateutil/releases/tag/2.8.1) | -| [yaml/pyyaml ](https://github.com/yaml/pyyaml) | 5.4.1 | [5.4.1](https://github.com/yaml/pyyaml/releases/tag/5.4.1) | -| [psf/requests](https://github.com/psf/requests) | 2.25.1 | [v2.25.1](https://github.com/psf/requests/releases/tag/v2.25.1) | -| [boto/s3transfer](https://github.com/boto/s3transfer) | 0.3.4 | [0.3.4](https://github.com/boto/s3transfer/releases/tag/0.3.4) | -| [enthought/scimath](https://github.com/enthought/scimath) | 4.2.0 | [4.2.0](https://github.com/enthought/scimath/releases/tag/4.2.0) | -| [scipy/scipy](https://github.com/scipy/scipy) | 1.6.1 | [v1.6.1](https://github.com/scipy/scipy/releases/tag/v1.6.1) | -| [benjaminp/six](https://github.com/benjaminp/six) | 1.15.0 | [1.15.0](https://github.com/benjaminp/six/releases/tag/1.15.0) | -| [enthought/traits](https://github.com/enthought/traits) | 6.2.0 | [6.2.0](https://github.com/enthought/traits/releases/tag/6.2.0) | -| [urllib3/urllib3](https://github.com/urllib3/urllib3) | 1.26.3 | [1.26.3](https://github.com/urllib3/urllib3/releases/tag/1.26.3) | -| [python-attrs/attrs](https://github.com/python-attrs/attrs) | 19.3.0 | [19.3.0](https://github.com/python-attrs/attrs/releases/tag/19.3.0) | -| [CheetahTemplate3/cheetah3](https://github.com/CheetahTemplate3/cheetah3/) | 3.2.4 | [3.2.4](https://github.com/CheetahTemplate3/cheetah3/releases/tag/3.2.4) | -| [pallets/click](https://github.com/pallets/click) | 7.0 | [7.0](https://github.com/pallets/click/releases/tag/7.0) | -| [pallets/flask](https://github.com/pallets/flask) | 1.1.1 | [1.1.1](https://github.com/pallets/flask/releases/tag/1.1.1) | -| [flask-restful/flask-restful](https://github.com/flask-restful/flask-restful) | 0.3.7 | [0.3.7](https://github.com/flask-restful/flask-restful/releases/tag/0.3.7) | -| [pytest-dev/iniconfig](https://github.com/pytest-dev/iniconfig) | 1.0.0 | [v1.0.0](https://github.com/pytest-dev/iniconfig/releases/tag/v1.0.0) | -| [pallets/itsdangerous](https://github.com/pallets/itsdangerous) | 1.1.0 | [1.1.0](https://github.com/pallets/itsdangerous/releases/tag/1.1.0) | -| [pallets/jinja](https://github.com/pallets/jinja) | 2.10.3 | [2.10.3](https://github.com/pallets/jinja/releases/tag/2.10.3) | -| [lxml/lxml](https://github.com/lxml/lxml) | 4.4.1 | [lxml-4.4.1](https://github.com/lxml/lxml/releases/tag/lxml-4.4.1) | -| [Python-Markdown/markdown](https://github.com/Python-Markdown/markdown) | 3.1.1 | [3.1.1](https://github.com/Python-Markdown/markdown/releases/tag/3.1.1) | -| [pallets/markupsafe](https://github.com/pallets/markupsafe) | 1.1.1 | [1.1.1](https://github.com/pallets/markupsafe/releases/tag/1.1.1) | -| [pypa/packaging](https://github.com/pypa/packaging) | 19.2 | [19.2](https://github.com/pypa/packaging/releases/tag/19.2) | -| [pexpect/pexpect](https://github.com/pexpect/pexpect) | 4.7.0 | [4.7.0](https://github.com/pexpect/pexpect/releases/tag/4.7.0) | -| [pytest-dev/pluggy](https://github.com/pytest-dev/pluggy) | 0.13.0 | [0.13.0](https://github.com/pytest-dev/pluggy/releases/tag/0.13.0) | -| [pexpect/ptyprocess](https://github.com/pexpect/ptyprocess) | 0.6.0 | [0.6.0](https://github.com/pexpect/ptyprocess/releases/tag/0.6.0) | -| [pytest-dev/py](https://github.com/pytest-dev/py) | 1.8.0 | [1.8.0](https://github.com/pytest-dev/py/releases/tag/1.8.0) | -| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.5 | [pyparsing_2.4.5](https://github.com/pyparsing/pyparsing/releases/tag/pyparsing_2.4.5) | -| [pytest-dev/pytest](https://github.com/pytest-dev/pytest) | 5.3.0 | [5.3.0](https://github.com/pytest-dev/pytest/releases/tag/5.3.0) | -| [stub42/pytz](https://github.com/stub42/pytz) | 2019.3 | [release_2019.3](https://github.com/stub42/pytz/releases/tag/release_2019.3) | -| [uiri/toml](https://github.com/uiri/toml) | 0.10.0 | [0.10.0](https://github.com/uiri/toml/releases/tag/0.10.0) | -| [pallets/werkzeug](https://github.com/pallets/werkzeug) | 0.16.0 | [0.16.0](https://github.com/pallets/werkzeug/releases/tag/0.16.0) | -| [dmnfarrell/tkintertable](https://github.com/dmnfarrell/tkintertable) | 1.2 | [v1.2](https://github.com/dmnfarrell/tkintertable/releases/tag/v1.2) | -| [wxWidgets/wxPython-Classic](https://github.com/wxWidgets/wxPython-Classic) | 2.9.1.1 | [wxPy-2.9.1.1](https://github.com/wxWidgets/wxPython-Classic/releases/tag/wxPy-2.9.1.1) | -| [nasa/fprime](https://github.com/nasa/fprime) | 1.3 | [NASA-v1.3](https://github.com/nasa/fprime/releases/tag/NASA-v1.3) | -| [nucleic/cppy](https://github.com/nucleic/cppy) | 1.1.0 | [1.1.0](https://github.com/nucleic/cppy/releases/tag/1.1.0) | -| [opencv/opencv](https://github.com/opencv/opencv) | 4.5.1 | [4.5.1](https://github.com/opencv/opencv/releases/tag/4.5.1) | -| [curl/curl](https://github.com/curl/curl) | 7.72.0 | [curl-7_72_0](https://github.com/curl/curl/releases/tag/curl-7_72_0) | -| [madler/zlib](https://github.com/madler/zlib) | 1.2.11 | [v1.2.11](https://github.com/madler/zlib/releases/tag/v1.2.11) | -| [apache/lucene](https://github.com/apache/lucene) | 7.7.3 | [releases/lucene-solr/7.7.3](https://github.com/apache/lucene/releases/tag/releases%2Flucene-solr%2F7.7.3) | -| [yaml/libyaml](https://github.com/yaml/libyaml) | 0.2.5 | [0.2.5](https://github.com/yaml/libyaml/releases/tag/0.2.5) | -| [elastic/elasticsearch](https://github.com/elastic/elasticsearch) | 6.8.1 | [v6.8.1](https://github.com/elastic/elasticsearch/releases/tag/v6.8.1) | -| [twbs/bootstrap](https://github.com/twbs/bootstrap) | 4.3.1 | [v4.3.1](https://github.com/twbs/bootstrap/releases/tag/v4.3.1) | -| [vuejs/vue](https://github.com/vuejs/vue) | 2.6.10 | [v2.6.10](https://github.com/vuejs/vue/releases/tag/v2.6.10) | -| [carrotsearch/hppc](https://github.com/carrotsearch/hppc) | 0.7.1 | [0.7.1](https://github.com/carrotsearch/hppc/releases/tag/0.7.1) | -| [JodaOrg/joda-time](https://github.com/JodaOrg/joda-time) | 2.10.1 | [v2.10.1](https://github.com/JodaOrg/joda-time/releases/tag/v2.10.1) | -| [tdunning/t-digest](https://github.com/tdunning/t-digest) | 3.2 | [t-digest-3.2](https://github.com/tdunning/t-digest/releases/tag/t-digest-3.2) | -| [HdrHistogram/HdrHistogram](https://github.com/HdrHistogram/HdrHistogram) | 2.1.9 | [HdrHistogram-2.1.9](https://github.com/HdrHistogram/HdrHistogram/releases/tag/HdrHistogram-2.1.9) | -| [locationtech/spatial4j](https://github.com/locationtech/spatial4j) | 0.7 | [spatial4j-0.7](https://github.com/locationtech/spatial4j/releases/tag/spatial4j-0.7) | -| [locationtech/jts](https://github.com/locationtech/jts) | 1.15.0 | [jts-1.15.0](https://github.com/locationtech/jts/releases/tag/jts-1.15.0) | -| [apache/log4j](https://github.com/apache/log4j) | 2.11 | [v1_2_11](https://github.com/apache/log4j/releases/tag/v1_2_11) | - ### Further reading - "[About your profile](/articles/about-your-profile)" diff --git a/content/github/site-policy-deprecated/github-enterprise-subscription-agreement.md b/content/github/site-policy-deprecated/github-enterprise-subscription-agreement.md index cf61a3170..f646a305e 100644 --- a/content/github/site-policy-deprecated/github-enterprise-subscription-agreement.md +++ b/content/github/site-policy-deprecated/github-enterprise-subscription-agreement.md @@ -15,7 +15,7 @@ BY CLICKING THE "I AGREE" OR SIMILAR BUTTON OR BY USING ANY OF THE PRODUCTS (DEF This Agreement applies to the following GitHub offerings, as further defined below (collectively, the **"Products"**): -- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-On Software, and GitHub Enterprise Cloud); +- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-On Software, and GitHub Enterprise Cloud) and GitHub One; - Any Beta Previews; @@ -406,6 +406,8 @@ Some Service features may be subject to additional terms as set forth in the [Gi **"GitHub Insights"** or **“Insights”** means the Software feature which provides Customer with metrics, analytics, and recommendations relating to their use of the Software. GitHub Insights does not include legacy features of GitHub including Organization insights and repository insights. +**“GitHub One”** means the Product bundle which includes GitHub Enterprise, Advanced Security, Insights, Learning Lab for Enterprise Server, and Premium Plus or Engineering Direct Support. + **"Learning Lab for Enterprise Server"** means the Software feature that enables Users to learn about GitHub functionality, including associated Documentation. **"License Key"** means the data file used by the Software's access control mechanism that allows Customer to install, operate, and use the Software. diff --git a/content/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md b/content/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md index 6872bb464..b58d9d35a 100644 --- a/content/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md +++ b/content/github/site-policy-deprecated/github-supplemental-terms-for-microsoft-volume-licensing.md @@ -15,7 +15,7 @@ The following GitHub Supplemental Terms (including any applicable Order Forms) s These Supplemental Terms apply to the following GitHub Offerings, as further defined below (collectively, the "**Products**"): -- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-on Software, and GitHub Enterprise Cloud); +- GitHub Enterprise (comprised of GitHub Enterprise Server, which may include Add-on Software, and GitHub Enterprise Cloud) and GitHub One; - Any related Support; and @@ -274,6 +274,8 @@ In the event of a conflict between the Supplemental Terms, on one hand, and an O **"GitHub Insights"** or **“Insights”** means the Software feature which provides Customer with metrics, analytics, and recommendations relating to their use of the Software. GitHub Insights does not include legacy features of GitHub including organization insights and repository insights. +**“GitHub One”** means the Product bundle which includes GitHub Enterprise, Advanced Security, Insights, Learning Lab for Enterprise Server, and Premium Plus or Engineering Direct Support. + **"Learning Lab for Enterprise Server"** means the Software feature that enables Users to learn about GitHub functionality, including associated Documentation. **"License Key"** means the data file used by the Software's access control mechanism that allows Customer to install, operate, and use the Software. diff --git a/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md b/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md index 335eb3ea3..a4b4d3fc5 100644 --- a/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md +++ b/content/github/site-policy/github-insights-and-data-protection-for-your-organization.md @@ -1,6 +1,7 @@ --- title: GitHub Insights and data protection for your organization intro: '{% data variables.product.prodname_insights %} analyzes your {% data variables.product.prodname_ghe_server %} data. This data could include personal data of individuals in your organization who may have the right to understand how such personal data is being used.' +product: '{% data reusables.gated-features.github-insights %}' redirect_from: - /github/installing-and-configuring-github-insights/github-insights-and-data-protection-for-your-organization - /enterprise-server@2.22/github/site-policy/github-insights-and-data-protection-for-your-organization @@ -13,6 +14,8 @@ topics: - legal --- +For more information about the terms that govern {% data variables.product.prodname_insights %}, see your {% data variables.product.prodname_ghe_one %} subscription agreement. + For the avoidance of doubt, none of the foregoing information should be considered legal advice provided by {% data variables.product.prodname_dotcom %}. You are responsible for securing your own legal analysis of the information provided herein and for your compliance with privacy and data protection laws. It is up to you whether to use {% data variables.product.prodname_insights %} to process your employees’ and users’ data, and if you do so, you are solely responsible for conducting such processing in compliance with applicable law. ### The organization’s roles and responsibilities diff --git a/content/github/site-policy/github-privacy-statement.md b/content/github/site-policy/github-privacy-statement.md index b1f638952..50fe4dd42 100644 --- a/content/github/site-policy/github-privacy-statement.md +++ b/content/github/site-policy/github-privacy-statement.md @@ -64,7 +64,7 @@ We require some basic information at the time of account creation. When you crea ##### Payment information If you sign on to a paid Account with us, send funds through the GitHub Sponsors Program, or buy an application on GitHub Marketplace, we collect your full name, address, and credit card information or PayPal information. Please note, GitHub does not process or store your credit card information or PayPal information, but our third-party payment processor does. -If you list and sell an application on [GitHub Marketplace](https://github.com/marketplace), we require your banking information. If you raise funds through the [GitHub Sponsors Program](https://github.com/sponsors), we require some [additional information](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-bank-information) through the registration process for you to participate in and receive funds through those services and for compliance purposes. +If you list and sell an application on [GitHub Marketplace](https://github.com/marketplace), we require your banking information. If you raise funds through the [GitHub Sponsors Program](https://github.com/sponsors), we require some [additional information](/github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer#submitting-your-bank-information) through the registration process for you to participate in and receive funds through those services and for compliance purposes. ##### Profile information You may choose to give us more information for your Account profile, such as your full name, an avatar which may include a photograph, your biography, your location, your company, and a URL to a third-party website. This information may include User Personal Information. Please note that your profile information may be visible to other Users of our Service. @@ -77,7 +77,7 @@ If you have a paid Account with us, sell an application listed on [GitHub Market ##### Usage information If you're accessing our Service or Website, we automatically collect the same basic information that most services collect, subject, where necessary, to your consent. This includes information about how you use the Service, such as the pages you view, the referring site, your IP address and session information, and the date and time of each request. This is information we collect from every visitor to the Website, whether they have an Account or not. This information may include User Personal information. -##### Cookies +##### Cookies As further described below, we automatically collect information from cookies (such as cookie ID and settings) to keep you logged in, to remember your preferences, to identify you and your device and to analyze your use of our service. ##### Device information @@ -147,7 +147,7 @@ For more information about our disclosure in response to legal requests, see our We may share User Personal Information if we are involved in a merger, sale, or acquisition of corporate entities or business units. If any such change of ownership happens, we will ensure that it is under terms that preserve the confidentiality of User Personal Information, and we will notify you on our Website or by email before any transfer of your User Personal Information. The organization receiving any User Personal Information will have to honor any promises we made in our Privacy Statement or Terms of Service. #### Aggregate, non-personally identifying information -We share certain aggregated, non-personally identifying information with others about how our users, collectively, use GitHub, or how our users respond to our other offerings, such as our conferences or events. +We share certain aggregated, non-personally identifying information with others about how our users, collectively, use GitHub, or how our users respond to our other offerings, such as our conferences or events. We **do not** sell your User Personal Information for monetary or other consideration. @@ -157,13 +157,13 @@ Please note: The California Consumer Privacy Act of 2018 (“CCPA”) requires b #### Access to private repositories -If your repository is private, you control the access to your Content. If you include User Personal Information or Sensitive Personal Information, that information may only be accessible to GitHub in accordance with this Privacy Statement. GitHub personnel [do not access private repository content](/github/site-policy/github-terms-of-service#e-private-repositories) except for +If your repository is private, you control the access to your Content. If you include User Personal Information or Sensitive Personal Information, that information may only be accessible to GitHub in accordance with this Privacy Statement. GitHub personnel [do not access private repository content](/github/site-policy/github-terms-of-service#e-private-repositories) except for - security purposes - to assist the repository owner with a support matter - to maintain the integrity of the Service - to comply with our legal obligations -- if we have reason to believe the contents are in violation of the law, or -- with your consent. +- if we have reason to believe the contents are in violation of the law, or +- with your consent. However, while we do not generally search for content in your repositories, we may scan our servers and content to detect certain tokens or security signatures, known active malware, known vulnerabilities in dependencies, or other content known to violate our Terms of Service, such as violent extremist or terrorist content or child exploitation imagery, based on algorithmic fingerprinting techniques (collectively, "automated scanning"). Our Terms of Service provides more details on [private repositories](/github/site-policy/github-terms-of-service#e-private-repositories). @@ -238,13 +238,13 @@ That said, the email address you have supplied [via your Git commit settings](/g #### Cookies -GitHub only uses strictly necessary cookies. Cookies are small text files that websites often store on computer hard drives or mobile devices of visitors. +GitHub only uses strictly necessary cookies. Cookies are small text files that websites often store on computer hard drives or mobile devices of visitors. -We use cookies solely to provide, secure, and improve our service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, analyze your use of our service, compile statistical reports, and provide information for future development of GitHub. We use our own cookies for analytics purposes, but do not use any third-party analytics service providers. +We use cookies solely to provide, secure, and improve our service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, analyze your use of our service, compile statistical reports, and provide information for future development of GitHub. We use our own cookies for analytics purposes, but do not use any third-party analytics service providers. By using our service, you agree that we can place these types of cookies on your computer or device. If you disable your browser or device’s ability to accept these cookies, you will not be able to log in or use our service. -We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. +We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. #### DNT @@ -321,7 +321,7 @@ In the unlikely event that a dispute arises between you and GitHub regarding our ### Changes to our Privacy Statement -Although most changes are likely to be minor, GitHub may change our Privacy Statement from time to time. We will provide notification to Users of material changes to this Privacy Statement through our Website at least 30 days prior to the change taking effect by posting a notice on our home page or sending email to the primary email address specified in your GitHub account. We will also update our [Site Policy repository](https://github.com/github/site-policy/), which tracks all changes to this policy. For other changes to this Privacy Statement, we encourage Users to [watch](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) or to check our Site Policy repository frequently. +Although most changes are likely to be minor, GitHub may change our Privacy Statement from time to time. We will provide notification to Users of material changes to this Privacy Statement through our Website at least 30 days prior to the change taking effect by posting a notice on our home page or sending email to the primary email address specified in your GitHub account. We will also update our [Site Policy repository](https://github.com/github/site-policy/), which tracks all changes to this policy. For other changes to this Privacy Statement, we encourage Users to [watch](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) or to check our Site Policy repository frequently. ### License diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md similarity index 66% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md index 19f222594..5d9db8333 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md @@ -6,27 +6,25 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-sponsored-developers versions: free-pro-team: '*' -type: 'overview' topics: - - 'Open Source' - - 'Fundamentals' + - sponsors --- ### Joining {% data variables.product.prodname_sponsors %} -{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." After you join {% data variables.product.prodname_sponsors %}, you can add a sponsor button to the open source repository you contribute to, to increase the visibility of your {% data variables.product.prodname_sponsors %} profile and other funding platforms. For more information, see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)." -You can set a goal for your sponsorships. For more information, see "[Managing your sponsorship goal](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal)." +You can set a goal for your sponsorships. For more information, see "[Managing your sponsorship goal](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal)." {% data reusables.sponsors.github-contact-applicants %} ### Sponsorship tiers -{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)." +{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)." It's best to set up a range of different sponsorship options, including monthly and one-time tiers, to make it easy for anyone to support your work. In particular, one-time payments allow people to reward your efforts without worrying about whether their finances will support a regular payment schedule. @@ -36,7 +34,7 @@ It's best to set up a range of different sponsorship options, including monthly {% data reusables.sponsors.payout-info %} -For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors)." +For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors)." ### Sharing feedback about {% data variables.product.prodname_sponsors %} diff --git a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md similarity index 69% rename from content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md index 84e961061..a93f6df83 100644 --- a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md @@ -3,24 +3,21 @@ title: About GitHub Sponsors intro: '{% data variables.product.prodname_sponsors %} allows the developer community to financially support the people and organizations who design, build, and maintain the open source projects they depend on, directly on {% data variables.product.product_name %}.' redirect_from: - /articles/about-github-sponsors - - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors versions: free-pro-team: '*' -type: 'overview' topics: - - 'Open Source' - - 'Fundamentals' + - sponsors --- ### About {% data variables.product.prodname_sponsors %} -{% data reusables.sponsors.sponsorship-details %} +{% data reusables.sponsors.sponsorship-details %} {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." When you become a sponsored developer or sponsored organization, additional terms for {% data variables.product.prodname_sponsors %} apply. For more information, see "[GitHub Sponsors Additional Terms](/github/site-policy/github-sponsors-additional-terms)." @@ -34,9 +31,7 @@ When you become a sponsored developer or sponsored organization, additional term The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/github/site-policy/github-community-guidelines). Payments to sponsored organizations and payments from organizations are not eligible for {% data variables.product.prodname_matching_fund %}. -To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong profile, see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)." - -Donations between sponsored developers will not be matched. +To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong profile, see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)." {% data reusables.sponsors.legal-additional-terms %} @@ -45,6 +40,6 @@ Donations between sponsored developers will not be matched. {% data reusables.sponsors.feedback %} ### Further reading -- "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)" -- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)" +- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" +- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors)" - "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md b/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md similarity index 80% rename from content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md index e228ad265..f85f61fdf 100644 --- a/content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md @@ -1,20 +1,15 @@ --- title: Attributing sponsorships to your organization intro: You can attribute the sponsorships paid by one of your organizations to another organization. -redirect_from: - - /github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization versions: free-pro-team: '*' permissions: People who are organization owners of both organizations can attribute one organization's sponsorships to another organization. -type: 'how_to' topics: - - 'Open Source' - - 'Organizations' - - 'Sponsors profile' + - sponsors --- 1. Navigate to the organization whose sponsorships you want to attribute to another organization. -2. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**. +1. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**. !["Sponsoring" tab](/assets/images/help/sponsors/sponsoring-tab.png) 1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. !["Settings" button](/assets/images/help/sponsors/sponsoring-settings-button.png) diff --git a/content/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md b/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md similarity index 85% rename from content/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md index 6c2a98c2b..861e9dd6d 100644 --- a/content/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md @@ -1,15 +1,10 @@ --- title: Configuring webhooks for events in your sponsored account intro: You can configure webhooks to alert you when you receive new sponsorships or existing sponsors make changes to their sponsorships. -redirect_from: - - /github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Webhooks' - - 'Events' - - 'Open Source' + - sponsors --- ### About webhooks for events in your sponsored account diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md similarity index 83% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md index 406bc187f..de523d754 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md @@ -3,21 +3,20 @@ title: Contacting your sponsors intro: You can send an email to your sponsors who have opted in to receive updates about your work. redirect_from: - /articles/contacting-your-sponsors - - /github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Open Source' - - 'Contacting sponsors' + - sponsors --- ### About sponsorship updates -Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)." +Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/articles/managing-your-sponsorship)." For sponsored developer accounts, the update will come from your user account's primary email address. If you've enabled email address privacy on your user account, the update will come from `noreply@github.com` instead. For sponsored organizations, the update will come from the organization's `noreply@github.com` email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." +You can also contact any one-time sponsors who contributed within the last 30 days and enabled updates. + ### Contacting your sponsors {% data reusables.sponsors.navigate-to-sponsors-dashboard %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md similarity index 86% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md index fc11e798b..83b554458 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md @@ -4,13 +4,10 @@ intro: You can update the information that potential sponsors see about your wor redirect_from: - /articles/editing-your-sponsored-developer-profile - /github/supporting-the-open-source-community-with-github-sponsors/editing-your-sponsored-developer-profile - - /github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Sponsors profile' - - 'Open Source' + - sponsors --- ### About sponsor profiles diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md new file mode 100644 index 000000000..39d60b8fe --- /dev/null +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md @@ -0,0 +1,33 @@ +--- +title: Supporting the open source community with GitHub Sponsors +shortTitle: GitHub Sponsors +intro: 'You can support the people and organizations who design, build, and maintain the open source projects you depend on by compensating them via {% data variables.product.prodname_dotcom %}.' +redirect_from: + - /categories/supporting-the-open-source-community-with-github-sponsors +versions: + free-pro-team: '*' +topics: + - sponsors +--- + + +### Table of Contents + +{% topic_link_in_list /overview %} + {% link_in_list /about-github-sponsors %} +{% topic_link_in_list /sponsoring-open-source-contributors %} + {% link_in_list /sponsoring-an-open-source-contributor %} + {% link_in_list /managing-your-sponsorship %} + {% link_in_list /attributing-sponsorships-to-your-organization %} +{% topic_link_in_list /receiving-sponsorships-through-github-sponsors %} + {% link_in_list /about-github-sponsors-for-open-source-contributors %} + {% link_in_list /setting-up-github-sponsors-for-your-user-account %} + {% link_in_list /setting-up-github-sponsors-for-your-organization %} + {% link_in_list /editing-your-profile-details-for-github-sponsors %} + {% link_in_list /managing-your-sponsorship-goal %} + {% link_in_list /managing-your-sponsorship-tiers %} + {% link_in_list /viewing-your-sponsors-and-sponsorships %} + {% link_in_list /managing-your-payouts-from-github-sponsors %} + {% link_in_list /configuring-webhooks-for-events-in-your-sponsored-account %} + {% link_in_list /contacting-your-sponsors %} + {% link_in_list /tax-information-for-github-sponsors %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md similarity index 76% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md index 1e9bdbfad..caa157285 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md @@ -3,18 +3,15 @@ title: Managing your payouts from GitHub Sponsors intro: 'You can view information about past and future payouts from {% data variables.product.prodname_sponsors %} and edit your bank information.' redirect_from: - /articles/managing-your-payouts-from-github-sponsors - - /github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Sponsors payments' - - 'Open Source' + - sponsors --- ### About payouts from {% data variables.product.prodname_sponsors %} -You can only manage your payouts from {% data variables.product.prodname_sponsors %} if you are paid through Stripe Connect. If you are paid through ACH transfer or wire transfer for your sponsored user account, you will not see the **Payouts** tab on your sponsored open source contributor dashboard. Sponsored organizations can only use Stripe Connect for payouts. For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors#sponsorship-payouts)." +You can only manage your payouts from {% data variables.product.prodname_sponsors %} if you are paid through Stripe Connect. If you are paid through ACH transfer or wire transfer for your sponsored user account, you will not see the **Payouts** tab on your sponsored open source contributor dashboard. Sponsored organizations can only use Stripe Connect for payouts. For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors#sponsorship-payouts)." {% data reusables.sponsors.payout-info %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md similarity index 86% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md index 0e64a0f99..9991858a5 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md @@ -1,15 +1,10 @@ --- title: Managing your sponsorship goal intro: You can set a goal for your sponsored developer or sponsored organization account to help the community understand the impact of sponsoring you. -redirect_from: - - /github/supporting-the-open-source-community-with-github-sponsors/manage-your-sponsorship-goal - - /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Open Source' - - 'Sponsors profile' + - sponsors --- ### About sponsorship goals @@ -18,6 +13,12 @@ You can set a funding goal for your sponsored account and share the goal with yo Your goal can set a target for the number of sponsors you want to have or the amount of money you want to earn each month. You can only set one goal up at a time. After you reach a goal, you can set another goal. +{% note %} + +**Note:** Goals are intended to help people track momentum so only monthly sponsors contribute toward your goal. + +{% endnote %} + ### Setting a goal {% data reusables.sponsors.navigate-to-sponsors-dashboard %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md similarity index 90% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md index e399b8a66..efb3ada4b 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md @@ -4,13 +4,10 @@ intro: 'You can add a new sponsorship tier, or edit or retire an existing tier.' redirect_from: - /articles/changing-your-sponsorship-tiers - /github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers - - /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Open Source' - - 'Sponsors profile' + - sponsors --- ### About sponsorship tiers diff --git a/content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md similarity index 81% rename from content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md index 642e8c4e7..2088f90c1 100644 --- a/content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md @@ -3,17 +3,13 @@ title: Managing your sponsorship intro: You can manage who can see your sponsorship and whether you receive email updates from the sponsored account. redirect_from: - /articles/managing-your-sponsorship - - /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Contacting sponsors' - - 'Privacy' - - 'Open Source' + - sponsors --- -{% data reusables.sponsors.org-sponsors-release-phase %} +{% data reusables.sponsors.org-sponsors-release-phase %} ### Managing the privacy setting for your sponsorship @@ -27,7 +23,7 @@ topics: You can choose whether an account you sponsor can send you email updates about their work. The sponsored account will not have access to your email address. -{% data reusables.sponsors.manage-updates-for-orgs %} +{% data reusables.sponsors.manage-updates-for-orgs %} {% data reusables.sponsors.navigate-to-sponsored-account %} {% data reusables.sponsors.sponsorship-dashboard %} diff --git a/content/sponsors/getting-started-with-github-sponsors/index.md b/content/github/supporting-the-open-source-community-with-github-sponsors/overview.md similarity index 52% rename from content/sponsors/getting-started-with-github-sponsors/index.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/overview.md index 4c473a586..b068234cb 100644 --- a/content/sponsors/getting-started-with-github-sponsors/index.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/overview.md @@ -1,10 +1,10 @@ --- -title: Getting started with GitHub Sponsors +title: Overview intro: 'Learn about {% data variables.product.prodname_sponsors %} and how you can get involved as a sponsor or open source contributor.' +mapTopic: true versions: free-pro-team: '*' +topics: + - sponsors --- -{% link_with_intro /about-github-sponsors %} - -{% link_with_intro /quickstart-for-finding-contributors-to-sponsor %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md new file mode 100644 index 000000000..fb2a1f92f --- /dev/null +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md @@ -0,0 +1,14 @@ +--- +title: Receiving sponsorships through GitHub Sponsors +shortTitle: Receiving sponsorships +intro: 'You or your organization can become a sponsored open source contributor to receive payments for your work, update your sponsorship details, and view and contact your sponsors.' +mapTopic: true +redirect_from: + - /articles/receiving-sponsorships-as-a-sponsored-developer + - /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-as-a-sponsored-developer +versions: + free-pro-team: '*' +topics: + - sponsors +--- + diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md similarity index 89% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md index 02178b1e5..a73b66dc5 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md @@ -4,15 +4,11 @@ intro: 'Your organization can join {% data variables.product.prodname_sponsors % redirect_from: - /articles/setting-up-github-sponsorship-for-your-organization - /articles/receiving-sponsorships-as-a-sponsored-organization - - /github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization permissions: 'Organization owners can set up {% data variables.product.prodname_sponsors %} for an organization.' versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Organizations' - - 'Sponsors profile' - - 'Open Source' + - sponsors --- ### Joining {% data variables.product.prodname_sponsors %} @@ -21,7 +17,7 @@ topics: After you receive an invitation for your organization to join {% data variables.product.prodname_sponsors %}, you can complete the steps below to become a sponsored organization. -To join {% data variables.product.prodname_sponsors %} as an individual contributor outside an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +To join {% data variables.product.prodname_sponsors %} as an individual contributor outside an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)." {% data reusables.sponsors.navigate-to-github-sponsors %} {% data reusables.sponsors.view-eligible-accounts %} @@ -52,6 +48,7 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.save-tier-draft %} {% data reusables.sponsors.review-and-publish-tier %} +{% data reusables.sponsors.enable-custom-amounts %} {% data reusables.sponsors.add-more-tiers %} ### Submitting your bank information @@ -87,5 +84,5 @@ Before your organization can become a sponsored organization, you must enable 2F {% data reusables.sponsors.github-review-app %} ### Further reading -- "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" -- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)" +- "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" +- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors)" diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md similarity index 92% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md index 9855a76d6..b42f03647 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md @@ -4,20 +4,17 @@ intro: 'You can become a sponsored developer by joining {% data variables.produc redirect_from: - /articles/becoming-a-sponsored-developer - /github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer - - /github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account versions: free-pro-team: '*' -type: 'how_to' topics: - - 'User account' - - 'Sponsors profile' + - sponsors --- ### Joining {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.you-can-be-a-sponsored-developer %} {% data reusables.sponsors.stripe-supported-regions %} -To join {% data variables.product.prodname_sponsors %} as an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." +To join {% data variables.product.prodname_sponsors %} as an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.navigate-to-github-sponsors %} 2. If you are an organization owner, you have more than one eligible account. Click **View your eligible accounts**, then in the list of accounts, find your user account. @@ -51,6 +48,7 @@ After {% data variables.product.prodname_dotcom %} reviews your application, you {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.save-tier-draft %} {% data reusables.sponsors.review-and-publish-tier %} +{% data reusables.sponsors.enable-custom-amounts %} {% data reusables.sponsors.add-more-tiers %} ### Submitting your bank information diff --git a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md similarity index 76% rename from content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md index fedec9b4b..aa7befca8 100644 --- a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md @@ -1,25 +1,22 @@ --- title: Sponsoring an open source contributor -intro: 'You can make a monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.' +intro: 'You can make a one-time or monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.' redirect_from: - /articles/sponsoring-a-developer - /articles/sponsoring-an-open-source-contributor - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-a-developer - - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor versions: free-pro-team: '*' permissions: Anyone can sponsor accounts on behalf of their own user account. Organization owners and billing managers can sponsor accounts on behalf of their organization. -type: 'how_to' topics: - - 'Open Source' - - 'Sponsors payments' + - sponsors --- -{% data reusables.sponsors.org-sponsors-release-phase %} +{% data reusables.sponsors.org-sponsors-release-phase %} ### About sponsorships -{% data reusables.sponsors.sponsorship-details %} +{% data reusables.sponsors.sponsorship-details %} You can sponsor an account on behalf of your user account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. - Sustaining specific libraries that your organization's work depends on @@ -27,17 +24,17 @@ You can sponsor an account on behalf of your user account to invest in projects - Developing brand awareness as an organization that values open source - Thanking open source developers for building libraries that complement the product your organization offers -You can use a credit card to sponsor an account on {% data variables.product.product_name %}. If your organization wants to pay by invoice, [contact us](https://support.github.com/contact/org-sponsors-waitlist). +You use your normal payment method to sponsor an account on {% data variables.product.product_name %}. If your organization wants to pay by invoice, [contact us](https://support.github.com/contact/org-sponsors-waitlist). {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -When you sponsor an account using a credit card, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %} +When you sponsor an account the change is effective immediately, unless you are sponsoring on behalf of an organization that pays by invoice. {% data reusables.sponsors.prorated-sponsorship %} Your sponsorship is included in the next scheduled payment to the sponsored account. -{% data reusables.sponsors.manage-updates-for-orgs %} +{% data reusables.sponsors.manage-updates-for-orgs %} If the sponsored account retires your tier, the tier will remain in place for you until you choose a different tier or cancel your subscription. For more information, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)." -If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." +If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.sponsorships-not-tax-deductible %} @@ -59,6 +56,7 @@ Before you can sponsor an account, you must have a verified email address. For m ![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png) 1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization. ![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png) +{% data reusables.sponsors.review-tiers-to-select %} {% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.pay-prorated-amount %} {% data reusables.sponsors.select-sponsorship-billing %} diff --git a/content/sponsors/sponsoring-open-source-contributors/index.md b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md similarity index 60% rename from content/sponsors/sponsoring-open-source-contributors/index.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md index 5bfcaebe2..afbdabd06 100644 --- a/content/sponsors/sponsoring-open-source-contributors/index.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md @@ -1,14 +1,13 @@ --- title: Sponsoring open source contributors intro: 'You can sponsor contributors, receive updates on developers and organizations you sponsor, and display a sponsor badge throughout {% data variables.product.product_name %}.' +mapTopic: true redirect_from: - /articles/sponsoring-open-source-developers - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-developers - - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors versions: free-pro-team: '*' +topics: + - sponsors --- -{% link_with_intro /sponsoring-an-open-source-contributor %} -{% link_with_intro /managing-your-sponsorship %} -{% link_with_intro /attributing-sponsorships-to-your-organization %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md similarity index 54% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md index 373ec09dc..82ebe0fca 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md @@ -6,15 +6,13 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-sponsored-developers versions: free-pro-team: '*' -type: 'overview' topics: - - 'Open Source' - - 'Sponsors payments' + - sponsors --- -If you are a taxpayer in the United States, you must submit a W-9 before you can receive payments. If you are a taxpayer in any other region besides the United States, you must submit a W-8BEN before you can receive payments. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-tax-information)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization#submitting-your-tax-information)." {% data variables.product.prodname_dotcom %} will send you the appropriate forms, notify you when they are due, and give you a reasonable amount of time to complete and send in the forms. +If you are a taxpayer in the United States, you must submit a W-9 before you can receive payments. If you are a taxpayer in any other region besides the United States, you must submit a W-8BEN before you can receive payments. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-tax-information)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization#submitting-your-tax-information)." {% data variables.product.prodname_dotcom %} will send you the appropriate forms, notify you when they are due, and give you a reasonable amount of time to complete and send in the forms. -If you are a taxpayer in the United States and earn more than $600 USD in a tax year, {% data variables.product.prodname_dotcom %} will send you a 1099 before January 31 of the next calendar year. We do not provide tax forms for international taxpayers. +If you are a taxpayer in the United States and earn more than $600 in a tax year, {% data variables.product.prodname_dotcom %} will send you a 1099 before January 31 of the next calendar year. We do not provide tax forms for international taxpayers. {% data variables.product.prodname_dotcom %} does not withhold tax from {% data variables.product.prodname_sponsors %} payments. Sponsored developers are responsible for evaluating and paying their own taxes. @@ -22,4 +20,4 @@ If you are a taxpayer in the United States and earn more than $600 USD in a tax ### Further reading -- [Viewing your sponsors and sponsorships](/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships) +- [Viewing your sponsors and sponsorships](/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships) diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md b/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md similarity index 90% rename from content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md rename to content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md index 668ccedc1..79bd24bdc 100644 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md +++ b/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md @@ -3,18 +3,15 @@ title: Viewing your sponsors and sponsorships intro: You can view and export detailed information and analytics about your sponsors and sponsorships. redirect_from: - /articles/viewing-your-sponsors-and-sponsorships - - /github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships versions: free-pro-team: '*' -type: 'how_to' topics: - - 'Open Source' - - 'Analytics' + - sponsors --- ### About sponsors and sponsorships -You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format. +You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format. ### Viewing your sponsors and sponsorships diff --git a/content/index.md b/content/index.md index b95dbb683..82990b3fb 100644 --- a/content/index.md +++ b/content/index.md @@ -25,7 +25,6 @@ children: - graphql - insights - discussions - - sponsors - communities - pages - education @@ -53,3 +52,4 @@ externalProducts: href: 'https://codeql.github.com/docs' external: true --- + diff --git a/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md index 7df881304..56cf9507a 100644 --- a/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -36,7 +36,6 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`account`](#account-category-actions) | Contains all activities related to your organization account. | [`advisory_credit`](#advisory_credit-category-actions) | Contains all activities related to crediting a contributor for a security advisory in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." | [`billing`](#billing-category-actions) | Contains all activities related to your organization's billing. -| [`codespaces`](#codespaces-category-actions) | Contains all activities related to your organization's codespaces. | [`dependabot_alerts`](#dependabot_alerts-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in existing repositories. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." | [`dependabot_alerts_new_repos`](#dependabot_alerts_new_repos-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot %} alerts in new repositories created in the organization. | [`dependabot_security_updates`](#dependabot_security_updates-category-actions) | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_security_updates %} in existing repositories. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." @@ -144,9 +143,9 @@ For example, you can make a GraphQL request to see all the new organization memb #### Using the REST API -{% note %} +{% note %} -**Note:** The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. +**Note:** The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. {% endnote %} @@ -191,20 +190,6 @@ An overview of some of the most common actions that are recorded as events in th | `change_billing_type` | Triggered when your organization [changes how it pays for {% data variables.product.prodname_dotcom %}](/articles/adding-or-editing-a-payment-method). | `change_email` | Triggered when your organization's [billing email address](/articles/setting-your-billing-email) changes. -#### `codespaces` category actions - -| Action | Description -|------------------|------------------- -| `create` | Triggered when a user [creates a codespace](/github/developing-online-with-codespaces/creating-a-codespace). -| `resume` | Triggered when a user resumes a suspended codespace. -| `delete` | Triggered when a user [deletes a codespace](/github/developing-online-with-codespaces/deleting-a-codespace). -| `create_an_org_secret` | Triggered when a user creates an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces) -| `update_an_org_secret` | Triggered when a user updates an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces). -| `remove_an_org_secret` | Triggered when a user removes an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces). -| `manage_access_and_security` | Triggered when a user updates [which repositories a codespace can access](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). - - - #### `dependabot_alerts` category actions | Action | Description @@ -497,38 +482,6 @@ For more information, see "[Managing the publication of {% data variables.produc | `update_linear_history_requirement_enforcement_level ` | Triggered when required linear commit history is enabled or disabled for a protected branch. {% endif %} -{% if currentVersion == "free-pro-team@latest" %} -#### `pull_request` category actions - -| Action | Description -|------------------|------------------- -| `create` | Triggered when a pull request is created. -| `close` | Triggered when a pull request is closed without being merged. -| `reopen` | Triggered when a pull request is reopened after previously being closed. -| `merge` | Triggered when a pull request is merged. -| `indirect_merge` | Triggered when a pull request is considered merged because its commits were merged into the target branch. -| `ready_for_review` | Triggered when a pull request is marked as ready for review. -| `converted_to_draft` | Triggered when a pull request is converted to a draft. -| `create_review_request` | Triggered when a review is requested. -| `remove_review_request` | Triggered when a review request is removed. - -#### `pull_request_review` category actions - -| Action | Description -|------------------|------------------- -| `submit` | Triggered when a review is submitted. -| `dismiss` | Triggered when a review is dismissed. -| `delete` | Triggered when a review is deleted. - -#### `pull_request_review_comment` category actions - -| Action | Description -|------------------|------------------- -| `create` | Triggered when a review comment is added. -| `update` | Triggered when a review comment is changed. -| `delete` | Triggered when a review comment is deleted. -{% endif %} - #### `repo` category actions | Action | Description @@ -643,19 +596,19 @@ For more information, see "[Managing the publication of {% data variables.produc | `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") -| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") +| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") | `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") -| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled | `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state -| `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") -| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") -| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") -| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") -| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") -| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") +| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") {% endif %} #### `team` category actions diff --git a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index aef1f3772..ca813fdfe 100644 --- a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md +++ b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -86,23 +86,3 @@ You can disable all workflows for an organization or set a policy that configure {% data reusables.organizations.settings-sidebar-actions %} {% data reusables.github-actions.private-repository-forks-configure %} {% endif %} - -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} -### Setting the permissions of the `GITHUB_TOKEN` for your organization - -{% data reusables.github-actions.workflow-permissions-intro %} - -You can set the default permissions for the `GITHUB_TOKEN` in the settings for your organization or your repositories. If you choose the restricted option as the default in your organization settings, the same option is auto-selected in the settings for repositories within your organization, and the permissive option is disabled. If your organization belongs to a {% data variables.product.prodname_enterprise %} account and the more restricted default has been selected in the enterprise settings, you won't be able to choose the more permissive default in your organization settings. - -{% data reusables.github-actions.workflow-permissions-modifying %} - -#### Configuring the default `GITHUB_TOKEN` permissions - -{% data reusables.profile.access_profile %} -{% data reusables.profile.access_org %} -{% data reusables.organizations.org_settings %} -{% data reusables.organizations.settings-sidebar-actions %} -1. Under **Workflow permissions**, choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope. - ![Set GITHUB_TOKEN permissions for this organization](/assets/images/help/settings/actions-workflow-permissions-organization.png) -1. Click **Save** to apply the settings. -{% endif %} diff --git a/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md b/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md index 56b192ffd..a3e01ff5a 100644 --- a/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md +++ b/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md @@ -11,11 +11,11 @@ topics: - teams --- -{% data reusables.sponsors.org-sponsors-release-phase %} +{% data reusables.sponsors.org-sponsors-release-phase %} -The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates. +The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates. -You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)." +You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)." {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} @@ -27,4 +27,4 @@ You can also disable updates from accounts your organization sponsors. For more ### Further reading -- "[{% data variables.product.prodname_sponsors %}](/sponsors)" +- "[Supporting the open source community with {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors)" diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md index fc77ec04c..818a082bf 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md @@ -60,9 +60,9 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | | | Manage viewing of organization dependency insights (see "[Changing the visibility of your organization's dependency insights](/articles/changing-the-visibility-of-your-organizations-dependency-insights)" for details) | **X** | | | | Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | | -| Sponsor accounts and manage the organization's sponsorships (see "[Sponsoring open-source contributors](/sponsors/sponsoring-open-source-contributors)" for details) | **X** | **X** | | +| Sponsor accounts and manage the organization's sponsorships (see "[Sponsoring open-source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" for details) | **X** | **X** | | | Manage email updates from sponsored accounts (see "[Managing updates from accounts your organization's sponsors](/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors)" for details) | **X** | | | -| Attribute your sponsorships to another organization (see "[Attributing sponsorships to your organization](/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization)" for details ) | **X** | | | +| Attribute your sponsorships to another organization (see "[Attributing sponsorships to your organization](/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization)" for details ) | **X** | | | | Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | | | | Manage security and analysis settings (see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" for details) | **X** | | | | Enable and enforce [SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on) | **X** | | | diff --git a/content/packages/guides/using-github-packages-with-github-actions.md b/content/packages/guides/using-github-packages-with-github-actions.md index 1a608d613..3b32b1103 100644 --- a/content/packages/guides/using-github-packages-with-github-actions.md +++ b/content/packages/guides/using-github-packages-with-github-actions.md @@ -35,7 +35,7 @@ For an authentication example, see "[Authenticating with the {% data variables.p #### Authenticating to package registries on {% data variables.product.prodname_dotcom %} -{% if currentVersion == "free-pro-team@latest" %}If you want your workflow to authenticate to {% data variables.product.prodname_registry %} to access a package registry other than the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_name %}, then{% else %}To authenticate to package registries on {% data variables.product.product_name %},{% endif %} we recommend using the `GITHUB_TOKEN` that {% data variables.product.product_name %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %} instead of a personal access token for authentication. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. {% else %}It has read and write permissions for packages in the repository where the workflow runs. {% endif %}For forks, the `GITHUB_TOKEN` is granted read access for the parent repository. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." +{% if currentVersion == "free-pro-team@latest" %}If you want your workflow to authenticate to {% data variables.product.prodname_registry %} to access a package registry other than the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_name %}, then{% else %}To authenticate to package registries on {% data variables.product.product_name %},{% endif %} we recommend using the `GITHUB_TOKEN` that {% data variables.product.product_name %} automatically creates for your repository when you enable {% data variables.product.prodname_actions %} instead of a personal access token for authentication. The `GITHUB_TOKEN` has `read:packages` and `write:packages` scopes to the current repository. For forks, the token also has the `read:packages` scope for the parent repository. You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{{secrets.GITHUB_TOKEN}}`{% endraw %} context. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)." @@ -87,6 +87,7 @@ You can use {% data variables.product.prodname_actions %} to automatically publi The following example demonstrates how you can use {% data variables.product.prodname_actions %} to build and test your app, and then automatically create a Docker image and publish it to {% data variables.product.prodname_registry %}: - Create a new workflow file in your repository (such as `.github/workflows/deploy-image.yml`), and add the following YAML: + {% raw %} ```yaml{:copy} name: Create and publish a package on: @@ -113,12 +114,12 @@ The following example demonstrates how you can use {% data variables.product.pro matrix: os: [ubuntu-latest] node-version: [12.x, 14.x] - steps: {% raw %} + steps: - uses: actions/checkout@v2 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v1 with: - node-version: ${{ matrix.node-version }}{% endraw %} + node-version: ${{ matrix.node-version }} - uses: actions/download-artifact@main with: name: webpack artifacts @@ -131,24 +132,22 @@ The following example demonstrates how you can use {% data variables.product.pro CI: true build-and-push-image: - runs-on: ubuntu-latest {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - contents: read - packages: write {% endif %} + runs-on: ubuntu-latest needs: run-npm-test steps: - name: Checkout uses: actions/checkout@v2 - name: Build container image uses: docker/build-push-action@v1 - with: {% raw %} + with: username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} registry: {% endraw %}{% if currentVersion == "github-ae@latest" %}docker.YOUR-HOSTNAME.com{% else %}docker.pkg.github.com{% endif %}{% raw %} - repository: ${{ github.repository }}/octo-image {% endraw %} + repository: ${{ github.repository }}/octo-image tag_with_sha: true - tag_with_ref: true + tag_with_ref: true ``` + {% endraw %} The relevant settings are explained in the following table: @@ -226,22 +225,7 @@ on: This job uses npm test to test the code. The needs: run-npm-build command makes this job dependent on the run-npm-build job. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - - - -{% raw %} - ```yaml - permissions: - contents: read - packages: write - ``` -{% endraw %} - - - Sets the permissions granted to the GITHUB_TOKEN for the actions in this job. - - {% endif %} + @@ -367,10 +351,9 @@ tag_with_ref: true You can install packages as part of your CI flow using {% data variables.product.prodname_actions %}. For example, you could configure a workflow so that anytime a developer pushes code to a pull request, the workflow resolves dependencies by downloading and installing packages hosted by {% data variables.product.prodname_registry %}. Then, the workflow can run CI tests that require the dependencies. -Installing packages hosted by {% data variables.product.prodname_registry %} through {% data variables.product.prodname_actions %} requires minimal configuration or additional authentication when you use the `GITHUB_TOKEN`.{% if currentVersion == "free-pro-team@latest" %} Data transfer is also free when an action installs a package. For more information, see "[About billing for {% data variables.product.prodname_registry %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages)."{% endif %} +Installing packages hosted by the {% data variables.product.prodname_registry %} through {% data variables.product.prodname_actions %} requires minimal configuration or additional authentication when you use the `GITHUB_TOKEN`.{% if currentVersion == "free-pro-team@latest" %} Data transfer is also free when an action installs a package. For more information, see "[About billing for {% data variables.product.prodname_registry %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-packages)."{% endif %} {% if currentVersion == "free-pro-team@latest" %} -The `GITHUB_TOKEN` cannot install packages from any private repository besides the repository where the action runs. You cannot currently use the `GITHUB_TOKEN` to authenticate to {% data variables.product.prodname_github_container_registry %}. {% endif %} {% data reusables.package_registry.actions-configuration %} @@ -398,6 +381,7 @@ Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, incr For example, this workflow publishes a Docker container using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. +{% raw %} ```yaml{:copy} name: Demo Push @@ -422,12 +406,9 @@ jobs: # Push image to GitHub Packages. # See also https://docs.docker.com/docker-hub/builds/ push: - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - packages: write - contents: read{% endif %} + runs-on: ubuntu-latest - {% raw %}steps: + steps: - uses: actions/checkout@v2 - name: Build image @@ -452,7 +433,8 @@ jobs: echo IMAGE_ID=$IMAGE_ID echo VERSION=$VERSION docker tag $IMAGE_NAME $IMAGE_ID:$VERSION - docker push $IMAGE_ID:$VERSION{% endraw %} + docker push $IMAGE_ID:$VERSION ``` +{% endraw %} {% endif %} diff --git a/content/packages/quickstart.md b/content/packages/quickstart.md index 9bde44268..cb593588c 100644 --- a/content/packages/quickstart.md +++ b/content/packages/quickstart.md @@ -71,10 +71,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor publish-gpr: needs: build - runs-on: ubuntu-latest{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %} - permissions: - packages: write - contents: read{% endif %} + runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index e3fc2daf3..e2410b488 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -47,7 +47,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) 5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} -{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} +{% indented_data_reference site.data.reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. ```shell @@ -81,7 +81,7 @@ To set up an apex domain, such as `example.com`, you must configure a _CNAME_ fi 185.199.111.153 ``` -{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} +{% indented_data_reference site.data.reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. ```shell diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index 9541ad885..205583ffa 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -68,6 +68,14 @@ Project site owned by organization account | `http(s)://pages./.github.com` naming scheme will still be published, but visitors will be redirected from `http(s)://.github.com` to `http(s)://.github.io`. If both a `.github.com` and `.github.io` repository exist, only the `.github.io` repository will be published. + +{% endnote %} +{% endif %} + ### Publishing sources for {% data variables.product.prodname_pages %} sites The publishing source for your {% data variables.product.prodname_pages %} site is the branch and folder where the source files for your site are stored. diff --git a/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md b/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md deleted file mode 100644 index df3ccc248..000000000 --- a/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Quickstart for finding contributors to sponsor -intro: 'Learn some best practices for finding open source contributors to sponsor.' -versions: - free-pro-team: '*' -type: 'quick_start' -topics: - - 'Open Source' ---- - -### Explore projects you depend on - -As you consider where to find open source contributors to sponsor, consider starting at https://github.com/sponsors/community. - -If you're logged in, the sponsors results will start with public dependencies that your repositories depend on. - -![The Babel open source project with highlighted text that says "4 of your repositories depend on this"](/assets/images/help/sponsors/example-of-open-source-project-dependency.png) - -You can also toggle which of your accounts to view results for and further filter or search. - -![Search options on sponsors community search page](/assets/images/help/sponsors/sponsors-search-options.png) - -### Explore whom others sponsor - -You can see whom a user or organization sponsors on their {% data variables.product.prodname_dotcom %} profile page. - -### Consider how you benefit from different contributions - -Consider whether you benefit from the work of open source contributions, such as: - - Documentation - - Design - - Translation - - Newsletters - - Code reviews - - Tutorials - - Mentoring - - Triaging issues and helping with project management - - Answering questions - - Event planning - -For more information on different types of open source contributions, see the [Open source guide](https://opensource.guide/how-to-contribute/#you-dont-have-to-contribute-code). - -You can check if contributors you've benefited from have {% data variables.product.prodname_sponsors %} profiles by using search at https://github.com/sponsors/community. - -### Search for a specific project or contributor - -At https://github.com/sponsors/community, you can search by ecosystem, most used, recently updated, and more. You can filter search results for your personal user account or for organizations that you're a member of. - -### Next steps - -For more information on starting your sponsorship, see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)." diff --git a/content/sponsors/guides.md b/content/sponsors/guides.md deleted file mode 100644 index 45d4336ca..000000000 --- a/content/sponsors/guides.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: GitHub Sponsors guides -shortTitle: Guides -intro: 'Learn how to make the most of {% data variables.product.prodname_sponsors %}.' -allowTitleToDifferFromFilename: true -layout: product-sublanding -versions: - free-pro-team: '*' -includeGuides: - - /sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor - - /sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization - - /sponsors/sponsoring-open-source-contributors/managing-your-sponsorship - - /sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors - - /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account - - /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization - - /sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account ---- \ No newline at end of file diff --git a/content/sponsors/index.md b/content/sponsors/index.md deleted file mode 100644 index efd1738d8..000000000 --- a/content/sponsors/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: GitHub Sponsors Documentation -shortTitle: GitHub Sponsors -intro: 'Invest in the open source projects you depend on, support digital infrastructure, and make open source careers possible by sponsoring open source contributors and their projects. Build a {% data variables.product.prodname_sponsors %} profile and receive compensation for your open source work.' -introLinks: - quickstart: /sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor -redirect_from: - - /categories/supporting-the-open-source-community-with-github-sponsors - - /github/supporting-the-open-source-community-with-github-sponsors -changelog: - label: 'sponsors' -featuredLinks: - guides: - - /sponsors/sponsoring-open-source-contributors/managing-your-sponsorship - - /sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization - - /sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors - guideCards: - - /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account - - /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization - - /sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account - popular: - - /sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor - - /sponsors/getting-started-with-github-sponsors/about-github-sponsors - - /sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors - - /sponsors/sponsoring-open-source-contributors - - /sponsors/about-github-sponsors-for-open-source-contributors -layout: product-landing -versions: - free-pro-team: '*' ---- - - - - - diff --git a/content/sponsors/integrating-with-github-sponsors/getting-started-with-the-sponsors-graphql-api.md b/content/sponsors/integrating-with-github-sponsors/getting-started-with-the-sponsors-graphql-api.md deleted file mode 100644 index 34b2d628b..000000000 --- a/content/sponsors/integrating-with-github-sponsors/getting-started-with-the-sponsors-graphql-api.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Getting started with the Sponsors GraphQL API -intro: 'Using the GraphQL API, you can build custom integrations to manage or review your sponsorships.' -versions: - free-pro-team: '*' -type: 'overview' -topics: - - 'GraphQL' - - 'API' ---- - -To get started with the GraphQL API, see "[Introduction to GraphQL](/graphql/guides/introduction-to-graphql)." - -You can find the details about the Sponsors GraphQL API in the reference docs. For more information, see "[GraphQL reference](/graphql/reference)." We recommend using the GraphQL explorer to build your GraphQL calls. For more information, see "[Using the explorer](/graphql/guides/using-the-explorer)." diff --git a/content/sponsors/integrating-with-github-sponsors/index.md b/content/sponsors/integrating-with-github-sponsors/index.md deleted file mode 100644 index 37e705536..000000000 --- a/content/sponsors/integrating-with-github-sponsors/index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Integrating with GitHub Sponsors -intro: 'As an open source contributor, you can build custom tools to manage your GitHub sponsorships.' -versions: - free-pro-team: '*' ---- - -{% link_with_intro /configuring-webhooks-for-events-in-your-sponsored-account %} -{% link_with_intro /getting-started-with-the-sponsors-graphql-api %} diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/index.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/index.md deleted file mode 100644 index eb4b28abc..000000000 --- a/content/sponsors/receiving-sponsorships-through-github-sponsors/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Receiving sponsorships through GitHub Sponsors -shortTitle: Receiving sponsorships -intro: 'You or your organization can become a sponsored open source contributor to receive payments for your work, update your sponsorship details, and view and contact your sponsors.' -redirect_from: - - /articles/receiving-sponsorships-as-a-sponsored-developer - - /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-as-a-sponsored-developer - - /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors -versions: - free-pro-team: '*' ---- - -{% link_with_intro /about-github-sponsors-for-open-source-contributors %} -{% link_with_intro /setting-up-github-sponsors-for-your-user-account %} -{% link_with_intro /setting-up-github-sponsors-for-your-organization %} -{% link_with_intro /editing-your-profile-details-for-github-sponsors %} -{% link_with_intro /managing-your-sponsorship-goal %} -{% link_with_intro /managing-your-sponsorship-tiers %} -{% link_with_intro /viewing-your-sponsors-and-sponsorships %} -{% link_with_intro /managing-your-payouts-from-github-sponsors %} -{% link_with_intro /contacting-your-sponsors %} -{% link_with_intro /tax-information-for-github-sponsors %} diff --git a/data/allowed-topics.js b/data/allowed-topics.js index 8abb382cb..68e6287fc 100644 --- a/data/allowed-topics.js +++ b/data/allowed-topics.js @@ -15,47 +15,35 @@ module.exports = [ 'Action development', 'Amazon ECS', 'Ant', - 'Analytics', - 'API', 'Azure App Service', 'Azure Pipelines', 'CD', 'CI', 'CircleCI', - 'Contacting sponsors', 'Containers', 'Docker', - 'Events', 'Fundamentals', 'GitLab', 'Google Kubernetes Engine', 'Gradle', - 'GraphQL', 'Java', 'JavaScript', 'Jenkins', 'Maven', 'Migration', 'Node', - 'Open Source', - 'Organizations', 'Packaging', 'Powershell', - 'Privacy', 'Project management', 'Publishing', 'Python', 'Ruby', 'Security', - 'Sponsors payments', - 'Sponsors profile', 'Travis CI', - 'User account', - 'Webhooks', 'Workflows', 'access management', 'accounts', - 'api', // replace this with API + 'api', 'billing', 'cli', 'codespaces', @@ -64,7 +52,7 @@ module.exports = [ 'device verification', 'early access', 'enterprise', - 'events', // replace this with Events + 'events', 'github', 'github apps', 'github search', @@ -76,8 +64,8 @@ module.exports = [ 'mobile', 'notifications', 'oauth apps', - 'open source', // replace this with Open Source - 'organizations', // replace this with Organization + 'open source', + 'organizations', 'pages', 'permissions', 'policy', @@ -87,10 +75,11 @@ module.exports = [ 'pull requests', 'repositories', 'security', + 'sponsors', 'ssh', 'sso', 'teams', 'usernames', - 'webhooks', // replace this with Webhooks + 'webhooks', 'Xcode' ] diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 456cf7ecf..0a3dcff91 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -4723,36 +4723,6 @@ type ConvertProjectCardNoteToIssuePayload { projectCard: ProjectCard } -""" -Autogenerated input type of ConvertPullRequestToDraft -""" -input ConvertPullRequestToDraftInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the pull request to convert to draft - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of ConvertPullRequestToDraft -""" -type ConvertPullRequestToDraftPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that is now a draft. - """ - pullRequest: PullRequest -} - """ Represents a 'convert_to_draft' event on a given pull request. """ @@ -14596,16 +14566,6 @@ type Mutation { input: ConvertProjectCardNoteToIssueInput! ): ConvertProjectCardNoteToIssuePayload - """ - Converts a pull request to draft - """ - convertPullRequestToDraft( - """ - Parameters for ConvertPullRequestToDraft - """ - input: ConvertPullRequestToDraftInput! - ): ConvertPullRequestToDraftPayload - """ Create a new branch protection rule """ diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index fb89df289..e43067219 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -4813,36 +4813,6 @@ type ConvertProjectCardNoteToIssuePayload { projectCard: ProjectCard } -""" -Autogenerated input type of ConvertPullRequestToDraft -""" -input ConvertPullRequestToDraftInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - ID of the pull request to convert to draft - """ - pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"]) -} - -""" -Autogenerated return type of ConvertPullRequestToDraft -""" -type ConvertPullRequestToDraftPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The pull request that is now a draft. - """ - pullRequest: PullRequest -} - """ Represents a 'convert_to_draft' event on a given pull request. """ @@ -15621,16 +15591,6 @@ type Mutation { input: ConvertProjectCardNoteToIssueInput! ): ConvertProjectCardNoteToIssuePayload - """ - Converts a pull request to draft - """ - convertPullRequestToDraft( - """ - Parameters for ConvertPullRequestToDraft - """ - input: ConvertPullRequestToDraftInput! - ): ConvertPullRequestToDraftPayload - """ Create a new branch protection rule """ diff --git a/data/release-notes/3-0/0.yml b/data/release-notes/3-0/0.yml index 76c607039..dbab40a44 100644 --- a/data/release-notes/3-0/0.yml +++ b/data/release-notes/3-0/0.yml @@ -132,7 +132,6 @@ sections: - A race condition can cause dependency graph database migrations to appear to fail. - Instances with a custom timezone that were upgraded from an earlier release of GitHub Enterprise Server may have incorrect timestamps in the web UI. - Old builds of Pages are not cleaned up, which could fill up the user disk (`/data/user/`). - - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. deprecations: - heading: Deprecation of GitHub Enterprise Server 2.19 diff --git a/data/release-notes/3-0/1.yml b/data/release-notes/3-0/1.yml index a6cdaaada..c78862e53 100644 --- a/data/release-notes/3-0/1.yml +++ b/data/release-notes/3-0/1.yml @@ -44,7 +44,6 @@ sections: - 'Dependency graph fails to parse `yarn.lock` Javascript manifest files, resulting in HTTP 500 errors in logs.' - 'Instances with a custom timezone that were upgraded from an earlier release of GitHub Enterprise Server may have incorrect timestamps in the web UI.' - 'Old builds of Pages are not cleaned up, which could fill up the user disk (`/data/user/`).' - - 'When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds.' - | Users may experience assets such as avatars not loading, or a failure to push/pull code. This may be caused by a PID mismatch in the `haproxy-cluster-proxy` service. To determine if you have an affected instance: diff --git a/data/release-notes/3-0/2.yml b/data/release-notes/3-0/2.yml index e6bda3f22..266143486 100644 --- a/data/release-notes/3-0/2.yml +++ b/data/release-notes/3-0/2.yml @@ -30,7 +30,6 @@ sections: - Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters. - reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text. - Old builds of Pages are not cleaned up, which could fill up the user disk (`/data/user/`). - - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. - | Users may experience assets such as avatars not loading, or a failure to push/pull code. This may be caused by a PID mismatch in the `haproxy-cluster-proxy` service. To determine if you have an affected instance: diff --git a/data/release-notes/3-0/3.yml b/data/release-notes/3-0/3.yml index 952e61c7b..09b90b287 100644 --- a/data/release-notes/3-0/3.yml +++ b/data/release-notes/3-0/3.yml @@ -29,7 +29,6 @@ sections: - Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters. - reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text. - Old builds of Pages are not cleaned up, which could fill up the user disk (`/data/user/`). - - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. - | Log rotation may fail to signal services to transition to new log files, leading to older log files continuing to be used, and eventual root disk space exhaustion. To remedy and/or prevent this issue, run the following commands in the [administrative shell](https://docs.github.com/en/enterprise-server/admin/configuration/accessing-the-administrative-shell-ssh) (SSH), or contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/) for assistance: diff --git a/data/release-notes/3-0/4.yml b/data/release-notes/3-0/4.yml index 1f0a4162f..dbd472720 100644 --- a/data/release-notes/3-0/4.yml +++ b/data/release-notes/3-0/4.yml @@ -22,4 +22,3 @@ sections: - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. - Jupyter Notebook rendering in the web UI may fail if the notebook includes non-ASCII UTF-8 characters. - reStructuredText (RST) rendering in the web UI may fail and instead display raw RST markup text. - - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. diff --git a/data/release-notes/3-0/5.yml b/data/release-notes/3-0/5.yml index a51075e52..a611f1d90 100644 --- a/data/release-notes/3-0/5.yml +++ b/data/release-notes/3-0/5.yml @@ -23,4 +23,3 @@ sections: - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. - Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. - - When deleting a branch after merging a pull request, an error message appears although the branch deletion succeeds. diff --git a/data/reusables/actions/actions-group-concurrency.md b/data/reusables/actions/actions-group-concurrency.md deleted file mode 100644 index 493e81cb4..000000000 --- a/data/reusables/actions/actions-group-concurrency.md +++ /dev/null @@ -1,25 +0,0 @@ -When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be `pending`. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify `cancel-in-progress: true`. - -##### Examples using concurrency and the default behavior - -{% raw %} -```yaml -concurrency: staging_environment -``` -{% endraw %} - -{% raw %} -```yaml -concurrency: ci-${{ github.ref }} -``` -{% endraw %} - -##### Example using concurrency to cancel any in-progress job or run - -{% raw %} -```yaml -concurrency: - group: ${{ github.head_ref }} - cancel-in-progress: true -``` -{% endraw %} diff --git a/data/reusables/actions/concurrency-beta.md b/data/reusables/actions/concurrency-beta.md deleted file mode 100644 index c3f2c9a83..000000000 --- a/data/reusables/actions/concurrency-beta.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Note:** Concurrency is currently in beta and subject to change. - -{% endnote %} \ No newline at end of file diff --git a/data/reusables/actions/enterprise-github-connect-warning.md b/data/reusables/actions/enterprise-github-connect-warning.md deleted file mode 100644 index ce755253e..000000000 --- a/data/reusables/actions/enterprise-github-connect-warning.md +++ /dev/null @@ -1,7 +0,0 @@ -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} -{% note %} - -**Note:** With {% data variables.product.prodname_github_connect %} enabled, {% data variables.product.prodname_actions %} will try to find the repository on your {% data variables.product.prodname_ghe_server %} instance first before falling back to {% data variables.product.prodname_dotcom %}. If a user creates an organization and repository in your enterprise that matches an organization and repository name on {% data variables.product.prodname_dotcom %}, the repository on your enterprise will be used in place of the {% data variables.product.prodname_dotcom %} repository. A malicious user could take advantage of this behavior to run code as part of a workflow. - -{% endnote %} -{% endif %} diff --git a/data/reusables/code-scanning/upload-sarif-alert-limit.md b/data/reusables/code-scanning/upload-sarif-alert-limit.md index 6881be29f..c5142332f 100644 --- a/data/reusables/code-scanning/upload-sarif-alert-limit.md +++ b/data/reusables/code-scanning/upload-sarif-alert-limit.md @@ -1,5 +1,5 @@ {% note %} -**Note:** SARIF upload supports a maximum of {% if currentVersion == "github-ae@next" or currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}5000{% else %}1000{% endif %} results per upload. Any results over this limit are ignored. If a tool generates too many results, you should update the configuration to focus on results for the most important rules or queries. +**Note:** SARIF upload supports a maximum of 1000 results per upload. Any results over this limit are ignored. If a tool generates too many results, you should update the configuration to focus on results for the most important rules or queries. {% endnote %} diff --git a/data/reusables/codespaces/codespaces-machine-types.md b/data/reusables/codespaces/codespaces-machine-types.md deleted file mode 100644 index bee246107..000000000 --- a/data/reusables/codespaces/codespaces-machine-types.md +++ /dev/null @@ -1,5 +0,0 @@ -Being able to switch machine types gives you the flexibility you need to choose appropriate resources to fit the work you are doing. As a guide, you might choose different machine types for these tasks: - -* **Basic** for updating a file and raising a pull request -* **Standard** for editing a website -* **Premium** for high compute tasks such as data analysis \ No newline at end of file diff --git a/data/reusables/developer-site/pull_request_forked_repos_link.md b/data/reusables/developer-site/pull_request_forked_repos_link.md index 3d29c028b..54d745b49 100644 --- a/data/reusables/developer-site/pull_request_forked_repos_link.md +++ b/data/reusables/developer-site/pull_request_forked_repos_link.md @@ -10,10 +10,6 @@ When you create a pull request from a forked repository to the base repository, Workflows don't run on forked repositories by default. You must enable GitHub Actions in the **Actions** tab of the forked repository. -{% if currentVersion == "free-pro-team@latest"%} -When a first-time contributor submits a pull request to a public repository, a maintainer with write access must approve running workflows on the pull request. For more information, see "[Approving workflow runs from public forks](/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." -{% endif %} - {% data reusables.actions.forked-secrets %} The permissions for the `GITHUB_TOKEN` in forked repositories is read-only. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." {% note %} diff --git a/data/reusables/gated-features/auto-merge.md b/data/reusables/gated-features/auto-merge.md index 7ce0001db..4f05ac43b 100644 --- a/data/reusables/gated-features/auto-merge.md +++ b/data/reusables/gated-features/auto-merge.md @@ -1 +1 @@ -{% if currentVersion == "github-ae@latest" %}Auto-merge for pull requests is available in internal and private repositories with {% data variables.product.prodname_ghe_managed %}, {% else %}Auto-merge for pull requests is available {% endif %} in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% if enterpriseServerVersions contains "enterprise-server@3.1" %}{% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}{% else %}and {% data variables.product.prodname_ghe_cloud %}{% endif %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} +{% if currentVersion == "github-ae@latest" %}Auto-merge for pull requests is available in internal and private repositories with {% data variables.product.prodname_ghe_managed %}, {% else %}Auto-merge for pull requests is available {% endif %} in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} diff --git a/data/reusables/github-actions/forked-write-permission.md b/data/reusables/github-actions/forked-write-permission.md deleted file mode 100644 index 3fe980424..000000000 --- a/data/reusables/github-actions/forked-write-permission.md +++ /dev/null @@ -1 +0,0 @@ -You can use the `permissions` key to add and remove read permissions for forked repositories, but typically you can't grant write access. The exception to this behavior is where an admin user has selected the **Send write tokens to workflows from pull requests** option in the {% data variables.product.prodname_actions %} settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)." \ No newline at end of file diff --git a/data/reusables/github-actions/github-token-available-permissions.md b/data/reusables/github-actions/github-token-available-permissions.md deleted file mode 100644 index 7e331c760..000000000 --- a/data/reusables/github-actions/github-token-available-permissions.md +++ /dev/null @@ -1,23 +0,0 @@ -Available scopes and access values: - -```yaml -permissions: - actions: read|write|none - checks: read|write|none - contents: read|write|none - deployments: read|write|none - issues: read|write|none - packages: read|write|none - pull-requests: read|write|none - repository-projects: read|write|none - security-events: read|write|none - statuses: read|write|none -``` - -If you specify the access for any of these scopes, all of those that are not specified are set to `none`. - -You can use the following syntax to define read or write access for all of the available scopes: - -```yaml -permissions: read-all|write-all -``` \ No newline at end of file diff --git a/data/reusables/github-actions/github-token-permissions.md b/data/reusables/github-actions/github-token-permissions.md deleted file mode 100644 index 88604df1d..000000000 --- a/data/reusables/github-actions/github-token-permissions.md +++ /dev/null @@ -1 +0,0 @@ -The `GITHUB_TOKEN` secret is set to an access token for the repository each time a job in a workflow begins. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}You should set the permissions for this access token in the workflow file to grant read access for the `contents` scope and write access for the `packages` scope. {% else %}It has read and write permissions for packages in the repository where the workflow runs. {% endif %}For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." \ No newline at end of file diff --git a/data/reusables/github-actions/publish-to-packages-workflow-step.md b/data/reusables/github-actions/publish-to-packages-workflow-step.md index c5a1bf2f4..743020588 100644 --- a/data/reusables/github-actions/publish-to-packages-workflow-step.md +++ b/data/reusables/github-actions/publish-to-packages-workflow-step.md @@ -1 +1 @@ -Runs the `mvn --batch-mode deploy` command to publish to {% data variables.product.prodname_registry %}. The `GITHUB_TOKEN` environment variable will be set with the contents of the `GITHUB_TOKEN` secret. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}The `permissions` key specifies the access granted to the `GITHUB_TOKEN`.{% endif %} +Runs the `mvn --batch-mode deploy` command to publish to {% data variables.product.prodname_registry %}. The `GITHUB_TOKEN` environment variable will be set with the contents of the `GITHUB_TOKEN` secret. diff --git a/data/reusables/github-actions/self-hosted-runner-configure-runner-group-access.md b/data/reusables/github-actions/self-hosted-runner-configure-runner-group-access.md index 3839db944..3b2ba51fe 100644 --- a/data/reusables/github-actions/self-hosted-runner-configure-runner-group-access.md +++ b/data/reusables/github-actions/self-hosted-runner-configure-runner-group-access.md @@ -6,7 +6,7 @@ **Warning** - {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} + {% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." diff --git a/data/reusables/github-actions/supported-github-runners.md b/data/reusables/github-actions/supported-github-runners.md index df406d6f7..514e6e3e3 100644 --- a/data/reusables/github-actions/supported-github-runners.md +++ b/data/reusables/github-actions/supported-github-runners.md @@ -1,7 +1,6 @@ | Virtual environment | YAML workflow label | | --------------------|---------------------| | Windows Server 2019 | `windows-latest` or `windows-2019` | -| Windows Server 2016 | `windows-2016` | | Ubuntu 20.04 | `ubuntu-latest` or `ubuntu-20.04` | | Ubuntu 18.04 | `ubuntu-18.04` | | Ubuntu 16.04 | `ubuntu-16.04` | diff --git a/data/reusables/github-actions/workflow-permissions-intro.md b/data/reusables/github-actions/workflow-permissions-intro.md deleted file mode 100644 index 88382e0d5..000000000 --- a/data/reusables/github-actions/workflow-permissions-intro.md +++ /dev/null @@ -1 +0,0 @@ -You can set the default permissions granted to the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)." You can choose between a restricted set of permissions as the default or a permissive setting. diff --git a/data/reusables/github-actions/workflow-permissions-modifying.md b/data/reusables/github-actions/workflow-permissions-modifying.md deleted file mode 100644 index 14ee1f927..000000000 --- a/data/reusables/github-actions/workflow-permissions-modifying.md +++ /dev/null @@ -1 +0,0 @@ -Anyone with write access to a repository can modify the permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, by editing the `permissions` key in the workflow file. For more information, see [`permissions`](/actions/reference/workflow-syntax-for-github-actions#permissions). \ No newline at end of file diff --git a/data/reusables/repositories/actions-scheduled-workflow-example.md b/data/reusables/repositories/actions-scheduled-workflow-example.md index 3dae8f356..40d253284 100644 --- a/data/reusables/repositories/actions-scheduled-workflow-example.md +++ b/data/reusables/repositories/actions-scheduled-workflow-example.md @@ -6,6 +6,6 @@ This example triggers the workflow every day at 5:30 and 17:30 UTC: on: schedule: # * is a special character in YAML so you have to quote this string - - cron: '30 5,17 * * *' + - cron: '*/30 5,17 * * *' ``` diff --git a/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/data/reusables/secret-scanning/partner-secret-list-private-repo.md index 030bdefa4..b6dae162f 100644 --- a/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -3,10 +3,6 @@ Partner | Supported secret | API slug n/a | JSON Web Token | json_web_token n/a | OAuth Client Credential | api_credential_assignment Adafruit IO | Adafruit IO Key | adafruit_io_key -Adobe | Adobe Device Token | adobe_device_token -Adobe | Adobe Service Token | adobe_service_token -Adobe | Adobe Short-Lived Access Token | adobe_short_lived_access_token -Adobe | Adobe JSON Web Token | adobe_jwt Alibaba Cloud | Alibaba Cloud Access Key ID | alibaba_cloud_access_key_id Alibaba Cloud | Alibaba Cloud Access Key Secret | alibaba_cloud_access_key_secret Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id @@ -32,15 +28,12 @@ Dropbox | Dropbox Short Lived Access Token | dropbox_short_lived_access_token Dynatrace | Dynatrace Access Token | dynatrace_access_token Dynatrace | Dynatrace Internal Token | dynatrace_internal_token Facebook | Facebook Access Token | facebook_access_token -Fastly | Fastly API Token | fastly_api_token Finicity | Finicity App Key | finicity_app_key Frame.io | Frame.io JSON Web Token | frameio_jwt Frame.io| Frame.io Developer Token | frameio_developer_token +GitHub | GitHub SSH Private Key | github_ssh_private_key GitHub | GitHub Personal Access Token | github_personal_access_token -GitHub | GitHub OAuth Access Token | github_oauth_access_token -GitHub | GitHub Refresh Token | github_refresh_token GitHub | GitHub App Installation Access Token | github_app_installation_access_token -GitHub | GitHub SSH Private Key | github_ssh_private_key GoCardless | GoCardless Live Access Token | gocardless_live_access_token GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token Google Cloud | Google API Key | google_api_key @@ -55,7 +48,6 @@ Mailchimp | Mailchimp API Key | mailchimp_api_key Mailgun | Mailgun API Key | mailgun_api_key npm | npm Access Token | npm_access_token NuGet | NuGet API Key | nuget_api_key -OpenAI | OpenAI API Key | openai_api_key Palantir | Palantir JSON Web Token | palantir_jwt Postman | Postman API Key | postman_api_key Proctorio | Proctorio Consumer Key | proctorio_consumer_key diff --git a/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/data/reusables/secret-scanning/partner-secret-list-public-repo.md index a13fab600..f9a562582 100644 --- a/data/reusables/secret-scanning/partner-secret-list-public-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-public-repo.md @@ -1,19 +1,15 @@ Partner | Supported secret --- | --- Adafruit IO | Adafruit IO Key -Adobe | Adobe Device Token -Adobe | Adobe Service Token -Adobe | Adobe Short-Lived Access Token -Adobe | Adobe JSON Web Token Alibaba Cloud | Alibaba Cloud Access Key ID and Access Key Secret pair Amazon Web Services (AWS) | Amazon AWS Access Key ID and Secret Access Key pair Atlassian | Atlassian API Token Atlassian | Atlassian JSON Web Token -Azure | Azure DevOps Personal Access Token -Azure | Azure SAS Token -Azure | Azure Service Management Certificate -Azure | Azure SQL Connection String -Azure | Azure Storage Account Key +Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token +Azure | Azure SAS Token | azure_sas_token +Azure | Azure Service Management Certificate | azure_management_certificate +Azure | Azure SQL Connection String | azure_sql_connection_string +Azure | Azure Storage Account Key | azure_storage_account_key Clojars | Clojars Deploy Token CloudBees CodeShip | CloudBees CodeShip Credential Databricks | Databricks Access Token @@ -30,11 +26,9 @@ Dynatrace | Dynatrace Internal Token Finicity | Finicity App Key Frame.io | Frame.io JSON Web Token Frame.io| Frame.io Developer Token +GitHub | GitHub SSH Private Key GitHub | GitHub Personal Access Token -GitHub | GitHub OAuth Access Token -GitHub | GitHub Refresh Token GitHub | GitHub App Installation Access Token -GitHub | GitHub SSH Private Key GoCardless | GoCardless Live Access Token GoCardless | GoCardless Sandbox Access Token Google Cloud | Google API Key @@ -47,7 +41,6 @@ Mailgun | Mailgun API Key MessageBird | MessageBird API Key npm | npm Access Token NuGet | NuGet API Key -OpenAI | OpenAI API Key Palantir | Palantir JSON Web Token Plivo | Plivo Auth Token Postman | Postman API Key @@ -60,7 +53,6 @@ PyPI | PyPI API Token RubyGems | RubyGems API Key Samsara | Samsara API Token Samsara | Samsara OAuth Access Token -SendGrid | SendGrid API Key Shopify | Shopify App Shared Secret Shopify | Shopify Access Token Shopify | Shopify Custom App Access Token diff --git a/data/reusables/webhooks/code_scanning_alert_event_properties.md b/data/reusables/webhooks/code_scanning_alert_event_properties.md index 859809760..dfd98526d 100644 --- a/data/reusables/webhooks/code_scanning_alert_event_properties.md +++ b/data/reusables/webhooks/code_scanning_alert_event_properties.md @@ -1,6 +1,6 @@ Key | Type | Description ----|------|------------- -`action` | `string` | The action that was performed. This can be one of `created`, `reopened_by_user`, `closed_by_user`, `fixed`, `appeared_in_branch`, or `reopened`. -`alert` | `object` | The code scanning alert involved in the event. -`ref` | `string` | The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. -`commit_oid` | `string` | The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. +`action` |`string` | The action that was performed. This can be one of `created`, `reopened_by_user`, `closed_by_user`, `fixed`, `appeared_in_branch`, or `reopened`. +`alert` |`object` | The code scanning alert involved in the event. +`ref` | `string` | The Git reference of the code scanning alert. When the action is `reopened_by_user ` or `closed_by_user `, the event was triggered by the `sender` and this value will be empty. +`commit_oid` | `string` | The commit SHA of the code scanning alert. When the action is `reopened_by_user ` or `closed_by_user `, the event was triggered by the `sender` and this value will be empty. diff --git a/data/reusables/webhooks/sponsorship_short_desc.md b/data/reusables/webhooks/sponsorship_short_desc.md index bf99f9f71..2f62ffe8d 100644 --- a/data/reusables/webhooks/sponsorship_short_desc.md +++ b/data/reusables/webhooks/sponsorship_short_desc.md @@ -1 +1 @@ -Activity related to a sponsorship listing. {% data reusables.webhooks.action_type_desc %} For more information, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)". +Activity related to a sponsorship listing. {% data reusables.webhooks.action_type_desc %} For more information, see "[About GitHub Sponsors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors)". diff --git a/data/ui.yml b/data/ui.yml index 3cf1451c0..17425b656 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -143,7 +143,6 @@ product_landing: code_examples: Code examples search_code_examples: Search code examples show_more: Show more - explore_people_and_projects: Explore people and projects sorry: Sorry, there is no result for no_example: It looks like we don't have an example that fits your filter. try_another: Try another filter or add your code example. @@ -151,7 +150,6 @@ product_landing: learn: Learn how to add a code example communities_using_discussions: Communities using discussions add_your_community: Add your community - sponsor_community: GitHub Sponsors community product_sublanding: start: Start start_path: Start path diff --git a/data/variables/product.yml b/data/variables/product.yml index 59215589b..69505aedd 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -119,6 +119,7 @@ prodname_security_center: 'Security Center' # Codespaces prodname_codespaces: 'Codespaces' +prodname_vs_codespaces: 'Visual Studio Codespaces' prodname_github_codespaces: 'GitHub Codespaces' # GitHub resources: blog, jobs, Learning Lab diff --git a/data/variables/sponsors_user_examples.yml b/data/variables/sponsors_user_examples.yml deleted file mode 100644 index 6695ac0a5..000000000 --- a/data/variables/sponsors_user_examples.yml +++ /dev/null @@ -1,19 +0,0 @@ -# Images and descriptions are pulled directly from the repo - -- user: chaynHQ - description: Chayn helps women experiencing abuse find the right information and support they need to take control of their lives. - -- user: foosel - description: 👋 I'm Gina, and I'm mostly known for being the creator and main developer of OctoPrint 🐙. - -- user: dayhaysoos - description: What's up? I'm Nick. I'm an engineer who has a new-found passion for removing friction from the e-commerce developer experience. - -- user: yyx990803 - description: I'm working fulltime on Vue.js, a frontend JavaScript framework for building web applications, and Vite, a modern web build tool. - -- user: calebporzio - description: 🚶‍♂️I left my day job in Jan 2019 to pursue open-source. Since then, I've built Laravel Livewire, AlpineJS, and a bunch of other stuff. - -- user: kjaymiller - description: Hi Y'all I'm Jay! 👋 I'm a Marine Corps Veteran turned developer that's been actively coding since 2014. I'm also involved in the productivity space where I can be found helping people with automations for some of their favorite apps and tools. diff --git a/feature-flags.json b/feature-flags.json index 5a0027370..64c69f19d 100644 --- a/feature-flags.json +++ b/feature-flags.json @@ -1,5 +1,4 @@ { "FEATURE_TEST_TRUE": true, - "FEATURE_TEST_FALSE": false, - "FEATURE_NEW_SITETREE": false + "FEATURE_TEST_FALSE": false } diff --git a/includes/article-cards.html b/includes/article-cards.html index 362abacd1..de7c3eb5e 100644 --- a/includes/article-cards.html +++ b/includes/article-cards.html @@ -1,10 +1,7 @@ {% assign maxArticles = 9 %}
- - {% if page.learningTracks %}

{% data ui.product_sublanding.all_guides %}

- {% endif %}
@@ -42,11 +39,9 @@

{% data ui.product_sublanding.all_guides %}

{{ link_card | replace: "", card_display_class }} {% endfor %} - {% if page.includeGuides.length > maxArticles %} - {% endif %}

{% data ui.product_sublanding.no_result %}

diff --git a/includes/article.html b/includes/article.html index d4b408324..c561290bc 100644 --- a/includes/article.html +++ b/includes/article.html @@ -46,7 +46,7 @@

{{ page.title }}

{% endif %} {% if page.product %} -
+
{{ page.product }}
{% endif %} @@ -68,14 +68,6 @@

diff --git a/includes/breadcrumbs.html b/includes/breadcrumbs.html index 57c6ab0ca..2a08fecb2 100644 --- a/includes/breadcrumbs.html +++ b/includes/breadcrumbs.html @@ -1,16 +1,3 @@ -{% if FEATURE_NEW_SITETREE %} - -{% else %} -{% endif %} diff --git a/includes/category-articles-list.html b/includes/category-articles-list.html deleted file mode 100644 index 27e2cdd7f..000000000 --- a/includes/category-articles-list.html +++ /dev/null @@ -1,34 +0,0 @@ -{% for categoryPage in currentProductTree.childPages %} -{% if categoryPage.href == currentPath %}{% assign currentCategory = categoryPage %}{% endif %} -{% endfor %} - -{% if currentCategory.page.shortTitle and currentCategory.page.shortTitle != '' %}{% assign currentCategoryTitle = currentCategory.page.shortTitle %}{% else %}{% assign currentCategoryTitle = currentCategory.page.title %}{% endif %} - -{% assign maxArticles = 10 %} - -
-

{{ currentCategoryTitle }} docs

- -
- {% for childPage in currentCategory.childPages %} - {% unless childPage.page.hidden %} -
-

{{ childPage.page.title }}

-
    - {% for grandchildPage in childPage.childPages %} -
  • - - {{ grandchildPage.page.title }} - -
    • - {% endfor %} - {% assign numArticles = childPage.childPages | obj_size %} - {% if numArticles > maxArticles %} - - {% endif %} -
-
- {% endunless %} - {% endfor %} -
-
diff --git a/includes/generic-toc-items.html b/includes/generic-toc-items.html deleted file mode 100644 index 0c2def85b..000000000 --- a/includes/generic-toc-items.html +++ /dev/null @@ -1,12 +0,0 @@ -{% if tocItems %} - -{% for tocItem in tocItems %} - -{% assign title = tocItem.title %} -{% assign fullPath = tocItem.fullPath %} -{% assign intro = tocItem.intro %} -{% include liquid-tags/link-with-intro %} - -{% endfor %} - -{% endif %} diff --git a/includes/generic-toc-list.html b/includes/generic-toc-list.html deleted file mode 100644 index 8cdd55c9c..000000000 --- a/includes/generic-toc-list.html +++ /dev/null @@ -1,24 +0,0 @@ -{% if tocItems %} -
    -{% for tocItem in tocItems %} - -{% assign title = tocItem.title %} -{% assign fullPath = tocItem.fullPath %} -{% assign intro = tocItem.intro %} - -
  • {% include liquid-tags/link %} - {% if tocItem.childTocItems %} - {% unless page.relativePath == "github/index.md" %} -
      - {% for childItem in tocItem.childTocItems %} - {% assign title = childItem.title %} - {% assign fullPath = childItem.fullPath %} -
    • {% include liquid-tags/link %}
      • - {% endfor %} -
    - {% endunless %} - {% endif %} -
    • -{% endfor %} -
-{% endif %} diff --git a/includes/header.html b/includes/header.html index d27e2802d..56f3709c5 100644 --- a/includes/header.html +++ b/includes/header.html @@ -22,7 +22,7 @@

{% data ui.homepage.explore_by_product %}

- +
@@ -35,7 +35,7 @@

{% data ui.h {% for product in activeProducts %} + {% if product.id == currentProduct %}color-text-link-mktg text-underline active{% elsif product.id == currentProduct.id %}color-text-link-mktg text-underline active{% else %}Link--primary no-underline{% endif %}"> {{ product.name }} {% if product.external %} diff --git a/includes/product-articles-list.html b/includes/product-articles-list.html deleted file mode 100644 index de0bec335..000000000 --- a/includes/product-articles-list.html +++ /dev/null @@ -1,46 +0,0 @@ -{% assign maxArticles = 10 %} - -{% if currentProductTree.page.shortTitle and currentProductTree.page.shortTitle != '' %}{% assign productTitle = currentProductTree.page.shortTitle %}{% else %}{% assign productTitle = currentProductTree.page.title %}{% endif %} - -
-

All {{ productTitle }} docs

- -
- {% for childPage in currentProductTree.childPages %} - {% if childPage.page.documentType == "article" %}{% assign standaloneCategory = true %}{% else %}{% assign standaloneCategory = false %}{% endif %} - {% unless standaloneCategory %} -
-

{{ childPage.page.title }}

- - {% if childPage.childPages and childPage.childPages[0].page.documentType == "mapTopic" %} -
    - {% for grandchildPage in childPage.childPages %} - {% unless grandchildPage.page.hidden %} - {% assign numArticles = childPage.childPages | obj_size %} -
  • - - {{ grandchildPage.page.title }} - -
    • - {% if numArticles > maxArticles %} - - {% endif %} - {% endunless %} - {% endfor %} -
- {% else %} -
    - {% assign numArticles = childPage.childPages | obj_size %} - {% for grandchildPage in childPage.childPages %} -
  • {{ grandchildPage.page.title }}
    • - {% endfor %} -
- {% if numArticles > maxArticles %} - - {% endif %} - {% endif %} -
- {% endunless %} - {% endfor %} -
-
diff --git a/includes/sidebar-product.html b/includes/sidebar-product.html deleted file mode 100644 index 5b5b6b78c..000000000 --- a/includes/sidebar-product.html +++ /dev/null @@ -1,74 +0,0 @@ - - -{% include all-products-link %} - -{% unless currentProductTree.page.hidden %} - -{% if currentProductTree.renderedShortTitle %}{% assign productTitle = currentProductTree.renderedShortTitle %}{% else %}{% assign productTitle = currentProductTree.renderedFullTitle %}{% endif %} - -
  • - {{ productTitle }} -
    • -
  • -
      - {% for childPage in currentProductTree.childPages %} - {% if childPage.page.documentType == "article" %}{% assign standaloneCategory = true %}{% else %}{% assign standaloneCategory = false %}{% endif %} -
    • - {% if childPage.renderedShortTitle %}{% assign childTitle = childPage.renderedShortTitle %}{% else %}{% assign childTitle = childPage.renderedFullTitle %}{% endif %} - {% if standaloneCategory %} - {{ childTitle }} - {% else %} -
      - -
      - {{ childTitle }} - {% if forloop.index < 4 %} - - {% endif %} -
      -       - {% endif %} - - {% if currentPath contains childPage.href or forloop.index < 4 %} - {% if childPage.childPages[0].page.documentType == "mapTopic" %} -
        - {% for grandchildPage in childPage.childPages %} - {% if grandchildPage.renderedShortTitle %}{% assign grandchildTitle = grandchildPage.renderedShortTitle %}{% else %}{% assign grandchildTitle = grandchildPage.renderedFullTitle %}{% endif %} -
      • - {{ grandchildTitle }} -
          - {% for greatgrandchildPage in grandchildPage.childPages %} - {% if greatgrandchildPage.renderedShortTitle %}{% assign greatgrandchildTitle = greatgrandchildPage.renderedShortTitle %}{% else %}{% assign greatgrandchildTitle = greatgrandchildPage.renderedFullTitle %}{% endif %} -
        • - {{ greatgrandchildTitle }} -
          • - {% endfor %} -
        -
        • - {% endfor %} -
      - - {% elsif childPage.childPages[0].page.documentType == "article" %} -
        - {% for grandchildPage in childPage.childPages %} - {% if grandchildPage.renderedShortTitle %}{% assign grandchildTitle = grandchildPage.renderedShortTitle %}{% else %}{% assign grandchildTitle = grandchildPage.renderedFullTitle %}{% endif %} -
      • - {{ grandchildTitle }} -
        • - {% endfor %} -
      - {% endif %} - {% endif %} -
      -
      • - {% endfor %} -
    -
    • - -{% endunless %} diff --git a/includes/sidebar.html b/includes/sidebar.html index 470a26208..74f1c94cc 100644 --- a/includes/sidebar.html +++ b/includes/sidebar.html @@ -15,11 +15,7 @@ {% else %}
      - {% if FEATURE_NEW_SITETREE %} - {% include sidebar-product %} - {% else %} {% include sidebar-specific-product %} - {% endif %}
    {% endif %} diff --git a/includes/sponsor-examples.html b/includes/sponsor-examples.html deleted file mode 100644 index 06a2ba6bd..000000000 --- a/includes/sponsor-examples.html +++ /dev/null @@ -1,9 +0,0 @@ -
    -

    {% data ui.product_landing.sponsor_community %}

    - -
    - {% render sponsors-community-card for productUserExamples as example %} - -
    - {% data ui.product_landing.explore_people_and_projects %} {% octicon "arrow-right" %} -
    diff --git a/includes/sponsors-community-card.html b/includes/sponsors-community-card.html deleted file mode 100644 index db00535a5..000000000 --- a/includes/sponsors-community-card.html +++ /dev/null @@ -1,14 +0,0 @@ -
    - -
    - {{ example.user }} -
    -
    -

    {{ example.user }}

    -

    {{ example.description }}

    -
    -     -
    diff --git a/javascripts/filter-cards.js b/javascripts/filter-cards.js index e96b27900..b62c21055 100644 --- a/javascripts/filter-cards.js +++ b/javascripts/filter-cards.js @@ -19,12 +19,10 @@ export default function cardsFilter () { const showMoreButton = document.querySelector('.js-filter-card-show-more') const noResults = document.querySelector('.js-filter-card-no-results') // if jsFilterCardMax not set, assume no limit (well, at 99) - // some landing pages don't include the button because the number of - // guides is less than the max defined in includes/article-cards.html - const maxCards = showMoreButton ? parseInt(showMoreButton.dataset.jsFilterCardMax || 99) : 99 + const maxCards = showMoreButton ? parseInt(showMoreButton.dataset.jsFilterCardMax || 99) : null const noFilter = () => { - if (showMoreButton) showMoreButton.classList.remove('d-none') + showMoreButton.classList.remove('d-none') for (let index = 0; index < cards.length; index++) { const card = cards[index] // Hide all but the first n number of cards @@ -40,7 +38,7 @@ export default function cardsFilter () { const { currentTarget } = evt const value = currentTarget.value - if (showMoreButton) showMoreButton.classList.add('d-none') + showMoreButton.classList.add('d-none') // Track whether or not we had at least one match let hasMatches = false diff --git a/layouts/product-landing.html b/layouts/product-landing.html index db2027814..de9e83368 100644 --- a/layouts/product-landing.html +++ b/layouts/product-landing.html @@ -125,10 +125,6 @@

    {{ link.title }} →

    {% include community-examples %} {% endif %} - {% if productUserExamples %} - {% include sponsor-examples %} - {% endif %} - {{ renderedPage }}
    @@ -150,22 +146,11 @@

    Guides

    {% endif %}
    - {% if FEATURE_NEW_SITETREE %} - {% if page.documentType == "category" %} - {% include category-articles-list %} - {% endif %} - {% if page.documentType == "product" %} - {% include product-articles-list %} - {% endif %} - {% endif %} - - {% unless FEATURE_NEW_SITETREE %} {% if currentCategory %} {% include all-articles-category %} {% else %} {% include all-articles-product %} {% endif %} - {% endunless %}
    {% include support-section %} diff --git a/layouts/product-sublanding.html b/layouts/product-sublanding.html index ad5e89476..4c4dfe54a 100644 --- a/layouts/product-sublanding.html +++ b/layouts/product-sublanding.html @@ -22,9 +22,8 @@

    {% data ui.product_sublanding.guides %}

    - {% assign featuredTrack = page.learningTracks[0] %} - {% if featuredTrack %}
    + {% assign featuredTrack = page.learningTracks[0] %}
    • @@ -55,10 +54,7 @@

      {{ guide.title }}

      - {% endif %} - {% assign learningTracks = page.learningTracks %} - {% if learningTracks %}

      {% data ui.product_sublanding.learning_paths %}

      {% data ui.product_sublanding.learning_paths_desc %}
      @@ -104,7 +100,6 @@
      {{ guide.title }}
      {% endfor %}
    - {% endif %}
    diff --git a/lib/changelog.js b/lib/changelog.js index 2e0541605..81c83f452 100644 --- a/lib/changelog.js +++ b/lib/changelog.js @@ -32,7 +32,7 @@ async function getChangelogItems (prefix, feed) { // capitalize the first letter of the title title: title.trim().charAt(0).toUpperCase() + title.slice(1), date: item.isoDate, - href: item.link + href: item.guid } }) diff --git a/lib/create-tree.js b/lib/create-tree.js index fe89e52eb..8649b8283 100644 --- a/lib/create-tree.js +++ b/lib/create-tree.js @@ -20,7 +20,7 @@ module.exports = async function createTree (originalPath, langObj) { const localizedBasePath = path.posix.join(__dirname, '..', langObj.dir, 'content') // Initialize the Page! This is where the file reads happen. - const page = await Page.init({ + let page = await Page.init({ basePath: localizedBasePath, relativePath, languageCode: langObj.code @@ -29,10 +29,17 @@ module.exports = async function createTree (originalPath, langObj) { if (!page) { // Do not throw an error if Early Access is not available. if (relativePath.startsWith('early-access')) return - // Do not throw an error if translated page is not available. - if (langObj.code !== 'en') return - - throw Error(`Cannot initialize page for ${filepath} in ${langObj.code}`) + // If a translated path doesn't exist, fall back to the English so there is parity between + // the English tree and the translated trees. + if (langObj.code !== 'en') { + page = await Page.init({ + basePath: basePath, + relativePath, + languageCode: langObj.code + }) + } + + if (!page) throw Error(`Cannot initialize page for ${filepath}`) } // Create the root tree object on the first run, and create children recursively. diff --git a/lib/graphql/static/changelog.json b/lib/graphql/static/changelog.json index fafffa8b5..4ca9bb231 100644 --- a/lib/graphql/static/changelog.json +++ b/lib/graphql/static/changelog.json @@ -1,19 +1,4 @@ [ - { - "schemaChanges": [ - { - "title": "The GraphQL schema includes these changes:", - "changes": [ - "Type `ConvertPullRequestToDraftInput` was added", - "Type `ConvertPullRequestToDraftPayload` was added", - "Field `convertPullRequestToDraft` was added to object type `Mutation`" - ] - } - ], - "previewChanges": [], - "upcomingChanges": [], - "date": "2021-04-20" - }, { "schemaChanges": [ { diff --git a/lib/graphql/static/prerendered-input-objects.json b/lib/graphql/static/prerendered-input-objects.json index 422f2ff2a..5716230ce 100644 --- a/lib/graphql/static/prerendered-input-objects.json +++ b/lib/graphql/static/prerendered-input-objects.json @@ -1,6 +1,6 @@ { "dotcom": { - "html": "
    \n
    \n

    \n AcceptEnterpriseAdministratorInvitationInput\n

    \n

    Autogenerated input type of AcceptEnterpriseAdministratorInvitation.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationId (ID!)

    The id of the invitation being accepted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AcceptTopicSuggestionInput\n

    \n

    Autogenerated input type of AcceptTopicSuggestion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the suggested topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddAssigneesToAssignableInput\n

    \n

    Autogenerated input type of AddAssigneesToAssignable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableId (ID!)

    The id of the assignable object to add assignees to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assigneeIds ([ID!]!)

    The id of users to add as assignees.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddCommentInput\n

    \n

    Autogenerated input type of AddComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The contents of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddEnterpriseSupportEntitlementInput\n

    \n

    Autogenerated input type of AddEnterpriseSupportEntitlement.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the Enterprise which the admin belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of a member who will receive the support entitlement.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddLabelsToLabelableInput\n

    \n

    Autogenerated input type of AddLabelsToLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!]!)

    The ids of the labels to add.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the labelable object to add labels to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddProjectCardInput\n

    \n

    Autogenerated input type of AddProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentId (ID)

    The content of the card. Must be a member of the ProjectCardItem union.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The note on the card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectColumnId (ID!)

    The Node ID of the ProjectColumn.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddProjectColumnInput\n

    \n

    Autogenerated input type of AddProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Node ID of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewCommentInput\n

    \n

    Autogenerated input type of AddPullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOID (GitObjectID)

    The SHA of the commit to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inReplyTo (ID)

    The comment id to reply to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The relative path of the file to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The line index in the diff to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The node ID of the pull request reviewing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Node ID of the review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewInput\n

    \n

    Autogenerated input type of AddPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The contents of the review body comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments ([DraftPullRequestReviewComment])

    The review line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOID (GitObjectID)

    The commit OID the review pertains to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    event (PullRequestReviewEvent)

    The event to perform on the pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threads ([DraftPullRequestReviewThread])

    The review line comment threads.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewThreadInput\n

    \n

    Autogenerated input type of AddPullRequestReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the thread's first comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    The line of the blob to which the thread refers. The end of the line range for multi-line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The node ID of the pull request reviewing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Node ID of the review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    side (DiffSide)

    The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The first line of the range to which the comment refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startSide (DiffSide)

    The side of the diff on which the start line resides.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddReactionInput\n

    \n

    Autogenerated input type of AddReaction.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ReactionContent!)

    The name of the emoji to react with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddStarInput\n

    \n

    Autogenerated input type of AddStar.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starrableId (ID!)

    The Starrable ID to star.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddVerifiableDomainInput\n

    \n

    Autogenerated input type of AddVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domain (URI!)

    The URL of the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner to add the domain to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ApproveVerifiableDomainInput\n

    \n

    Autogenerated input type of ApproveVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to approve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ArchiveRepositoryInput\n

    \n

    Autogenerated input type of ArchiveRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to mark as archived.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AuditLogOrder\n

    \n

    Ordering options for Audit Log connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (AuditLogOrderField)

    The field to order Audit Logs by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CancelEnterpriseAdminInvitationInput\n

    \n

    Autogenerated input type of CancelEnterpriseAdminInvitation.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationId (ID!)

    The Node ID of the pending enterprise administrator invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ChangeUserStatusInput\n

    \n

    Autogenerated input type of ChangeUserStatus.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emoji (String)

    The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiresAt (DateTime)

    If set, the user status will not be shown after this date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limitedAvailability (Boolean)

    Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    A short description of your current status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID)

    The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationData\n

    \n

    Information from a check run analysis to specific lines of code.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotationLevel (CheckAnnotationLevel!)

    Represents an annotation's information level.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (CheckAnnotationRange!)

    The location of the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    A short description of the feedback for these lines of code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to add an annotation to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rawDetails (String)

    Details about this annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title that represents the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationRange\n

    \n

    Information from a check run analysis to specific lines of code.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    endColumn (Int)

    The ending column of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endLine (Int!)

    The ending line of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startColumn (Int)

    The starting column of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int!)

    The starting line of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunAction\n

    \n

    Possible further actions the integrator can perform.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String!)

    A short explanation of what this action would do.

    \n\n\n\n\n\n\n\n\n\n\n\n

    identifier (String!)

    A reference for the action on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (String!)

    The text to be displayed on a button in the web UI.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunFilter\n

    \n

    The filters that are available when fetching check runs.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (Int)

    Filters the check runs created by this application ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkName (String)

    Filters the check runs by this name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkType (CheckRunType)

    Filters the check runs by this type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState)

    Filters the check runs by this status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunOutput\n

    \n

    Descriptive details about the check run.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotations ([CheckAnnotationData!])

    The annotations that are made as part of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    images ([CheckRunOutputImage!])

    Images attached to the check run output displayed in the GitHub pull request UI.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String!)

    The summary of the check run (supports Commonmark).

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    The details of the check run (supports Commonmark).

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    A title to provide for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunOutputImage\n

    \n

    Images attached to the check run output displayed in the GitHub pull request UI.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    alt (String!)

    The alternative text for the image.

    \n\n\n\n\n\n\n\n\n\n\n\n

    caption (String)

    A short image description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    imageUrl (URI!)

    The full URL of the image.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteAutoTriggerPreference\n

    \n

    The auto-trigger preferences that are available for check suites.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (ID!)

    The node ID of the application that owns the check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    setting (Boolean!)

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteFilter\n

    \n

    The filters that are available when fetching check suites.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (Int)

    Filters the check suites created by this application ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkName (String)

    Filters the check suites by this name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ClearLabelsFromLabelableInput\n

    \n

    Autogenerated input type of ClearLabelsFromLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the labelable object to clear the labels from.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloneProjectInput\n

    \n

    Autogenerated input type of CloneProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includeWorkflows (Boolean!)

    Whether or not to clone the source project's workflows.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    The visibility of the project, defaults to false (private).

    \n\n\n\n\n\n\n\n\n\n\n\n

    sourceId (ID!)

    The source project to clone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetOwnerId (ID!)

    The owner ID to create the project under.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloneTemplateRepositoryInput\n

    \n

    Autogenerated input type of CloneTemplateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includeAllBranches (Boolean)

    Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner for the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the template repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepositoryVisibility!)

    Indicates the repository's visibility level.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloseIssueInput\n

    \n

    Autogenerated input type of CloseIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    ID of the issue to be closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ClosePullRequestInput\n

    \n

    Autogenerated input type of ClosePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitAuthor\n

    \n

    Specifies an author for filtering Git commits.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([String!])

    Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID)

    ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitContributionOrder\n

    \n

    Ordering options for commit contribution connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (CommitContributionOrderField!)

    The field by which to order commit contributions.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionOrder\n

    \n

    Ordering options for contribution connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertProjectCardNoteToIssueInput\n

    \n

    Autogenerated input type of ConvertProjectCardNoteToIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The body of the newly created issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCardId (ID!)

    The ProjectCard ID to convert.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to create the issue in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title of the newly created issue. Defaults to the card's note text.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertPullRequestToDraftInput\n

    \n

    Autogenerated input type of ConvertPullRequestToDraft.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to convert to draft.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateBranchProtectionRuleInput\n

    \n

    Autogenerated input type of CreateBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String!)

    The glob-like pattern used to determine matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushActorIds ([ID!])

    A list of User, Team or App IDs allowed to push to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The global relay id of the repository in which a new branch protection rule should be created in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String!])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalActorIds ([ID!])

    A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateCheckRunInput\n

    \n

    Autogenerated input type of CreateCheckRun.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actions ([CheckRunAction!])

    Possible further actions the integrator can perform, which a user may trigger.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    The time that the check run finished.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The final conclusion of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL of the integrator's site that has the full details of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headSha (GitObjectID!)

    The SHA of the head commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    output (CheckRunOutput)

    Descriptive details about the run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    The time that the check run began.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (RequestableCheckStatusState)

    The current status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateCheckSuiteInput\n

    \n

    Autogenerated input type of CreateCheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headSha (GitObjectID!)

    The SHA of the head commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateContentAttachmentInput\n

    \n

    Autogenerated input type of CreateContentAttachment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body of the content attachment, which may contain markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentReferenceId (ID!)

    The node ID of the content_reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the content attachment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateDeploymentInput\n

    \n

    Autogenerated input type of CreateDeployment.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoMerge (Boolean)

    Attempt to automatically merge the default branch into the requested ref, defaults to true.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Short description of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    Name for the target deployment environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String)

    JSON payload with extra information about the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The node ID of the ref to be deployed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredContexts ([String!])

    The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    task (String)

    Specifies a task to execute.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateDeploymentStatusInput\n

    \n

    Autogenerated input type of CreateDeploymentStatus.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoInactive (Boolean)

    Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deploymentId (ID!)

    The node ID of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the status. Maximum length of 140 characters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environmentUrl (String)

    Sets the URL for accessing your environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logUrl (String)

    The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentStatusState!)

    The state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateEnterpriseOrganizationInput\n

    \n

    Autogenerated input type of CreateEnterpriseOrganization.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    adminLogins ([String!]!)

    The logins for the administrators of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    billingEmail (String!)

    The email used for sending billing receipts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise owning the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    profileName (String!)

    The profile name of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateIpAllowListEntryInput\n

    \n

    Autogenerated input type of CreateIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    An IP address or range of addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the IP allow list entry is active when an IP allow list is enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    An optional name for the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner for which to create the new IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateIssueInput\n

    \n

    Autogenerated input type of CreateIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    The Node ID for the user assignee for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The body for the issue description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueTemplate (String)

    The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title for the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateLabelInput\n

    \n

    Autogenerated input type of CreateLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    color (String!)

    A 6 character hex code, without the leading #, identifying the color of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of the label, such as its purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateProjectInput\n

    \n

    Autogenerated input type of CreateProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The owner ID to create the project under.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryIds ([ID!])

    A list of repository IDs to create as linked repositories for the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (ProjectTemplate)

    The name of the GitHub-provided template.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatePullRequestInput\n

    \n

    Autogenerated input type of CreatePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    baseRefName (String!)

    The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The contents of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    draft (Boolean)

    Indicates whether this pull request should be a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateRefInput\n

    \n

    Autogenerated input type of CreateRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The GitObjectID that the new Ref shall target. Must point to a commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the Repository to create the Ref in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateRepositoryInput\n

    \n

    Autogenerated input type of CreateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean)

    Indicates if the repository should have the issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean)

    Indicates if the repository should have the wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The URL for a web page about this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID)

    The ID of the owner for the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamId (ID)

    When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (Boolean)

    Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepositoryVisibility!)

    Indicates the repository's visibility level.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of CreateTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The content of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussionId (ID!)

    The ID of the discussion to which the comment belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateTeamDiscussionInput\n

    \n

    Autogenerated input type of CreateTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The content of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    private (Boolean)

    If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamId (ID!)

    The ID of the team to which the discussion belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeclineTopicSuggestionInput\n

    \n

    Autogenerated input type of DeclineTopicSuggestion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the suggested topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (TopicSuggestionDeclineReason!)

    The reason why the suggested topic is declined.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteBranchProtectionRuleInput\n

    \n

    Autogenerated input type of DeleteBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branchProtectionRuleId (ID!)

    The global relay id of the branch protection rule to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteDeploymentInput\n

    \n

    Autogenerated input type of DeleteDeployment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the deployment to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIpAllowListEntryInput\n

    \n

    Autogenerated input type of DeleteIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntryId (ID!)

    The ID of the IP allow list entry to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIssueCommentInput\n

    \n

    Autogenerated input type of DeleteIssueComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIssueInput\n

    \n

    Autogenerated input type of DeleteIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteLabelInput\n

    \n

    Autogenerated input type of DeleteLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the label to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePackageVersionInput\n

    \n

    Autogenerated input type of DeletePackageVersion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageVersionId (ID!)

    The ID of the package version to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectCardInput\n

    \n

    Autogenerated input type of DeleteProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cardId (ID!)

    The id of the card to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectColumnInput\n

    \n

    Autogenerated input type of DeleteProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectInput\n

    \n

    Autogenerated input type of DeleteProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Project ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePullRequestReviewCommentInput\n

    \n

    Autogenerated input type of DeletePullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePullRequestReviewInput\n

    \n

    Autogenerated input type of DeletePullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteRefInput\n

    \n

    Autogenerated input type of DeleteRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The Node ID of the Ref to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of DeleteTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteTeamDiscussionInput\n

    \n

    Autogenerated input type of DeleteTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The discussion ID to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteVerifiableDomainInput\n

    \n

    Autogenerated input type of DeleteVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentOrder\n

    \n

    Ordering options for deployment connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (DeploymentOrderField!)

    The field to order deployments by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DisablePullRequestAutoMergeInput\n

    \n

    Autogenerated input type of DisablePullRequestAutoMerge.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to disable auto merge on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DismissPullRequestReviewInput\n

    \n

    Autogenerated input type of DismissPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    The contents of the pull request review dismissal message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DraftPullRequestReviewComment\n

    \n

    Specifies a review comment to be left with a Pull Request Review.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the comment to leave.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int!)

    Position in the file to leave a comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DraftPullRequestReviewThread\n

    \n

    Specifies a review comment thread to be left with a Pull Request Review.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the comment to leave.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    The line of the blob to which the thread refers. The end of the line range for multi-line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    side (DiffSide)

    The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The first line of the range to which the comment refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startSide (DiffSide)

    The side of the diff on which the start line resides.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnablePullRequestAutoMergeInput\n

    \n

    Autogenerated input type of EnablePullRequestAutoMerge.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod)

    The merge method to use. If omitted, defaults to 'MERGE'.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to enable auto-merge on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationOrder\n

    \n

    Ordering options for enterprise administrator invitation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseAdministratorInvitationOrderField!)

    The field to order enterprise administrator invitations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberOrder\n

    \n

    Ordering options for enterprise member connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseMemberOrderField!)

    The field to order enterprise members by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallationOrder\n

    \n

    Ordering options for Enterprise Server installation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerInstallationOrderField!)

    The field to order Enterprise Server installations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailOrder\n

    \n

    Ordering options for Enterprise Server user account email connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountEmailOrderField!)

    The field to order emails by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountOrder\n

    \n

    Ordering options for Enterprise Server user account connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountOrderField!)

    The field to order user accounts by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadOrder\n

    \n

    Ordering options for Enterprise Server user accounts upload connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountsUploadOrderField!)

    The field to order user accounts uploads by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowUserInput\n

    \n

    Autogenerated input type of FollowUser.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    ID of the user to follow.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n GistOrder\n

    \n

    Ordering options for gist connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (GistOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ImportProjectInput\n

    \n

    Autogenerated input type of ImportProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of Project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnImports ([ProjectColumnImport!]!)

    A list of columns containing issues and pull requests.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of Project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerName (String!)

    The name of the Organization or User to create the Project under.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    Whether the Project is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n InviteEnterpriseAdminInput\n

    \n

    Autogenerated input type of InviteEnterpriseAdmin.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email of the person to invite as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise to which you want to invite an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (String)

    The login of a user to invite as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole)

    The role of the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryOrder\n

    \n

    Ordering options for IP allow list entry connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IpAllowListEntryOrderField!)

    The field to order IP allow list entries by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentOrder\n

    \n

    Ways in which lists of issue comments can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order issue comments by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IssueCommentOrderField!)

    The field in which to order issue comments by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueFilters\n

    \n

    Ways in which to filter lists of issues.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignee (String)

    List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdBy (String)

    List issues created by given name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels ([String!])

    List issues where the list of label names exist on the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mentioned (String)

    List issues where the given name is mentioned in the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (String)

    List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    since (DateTime)

    List issues that have been updated at or after the given date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    states ([IssueState!])

    List issues filtered by the list of states given.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscribed (Boolean)

    List issues subscribed to by viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueOrder\n

    \n

    Ways in which lists of issues can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order issues by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IssueOrderField!)

    The field in which to order issues by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelOrder\n

    \n

    Ways in which lists of labels can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order labels by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (LabelOrderField!)

    The field in which to order labels by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageOrder\n

    \n

    Ordering options for language connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (LanguageOrderField!)

    The field to order languages by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LinkRepositoryToProjectInput\n

    \n

    Autogenerated input type of LinkRepositoryToProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The ID of the Project to link to a Repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the Repository to link to a Project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LockLockableInput\n

    \n

    Autogenerated input type of LockLockable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (LockReason)

    A reason for why the item will be locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockableId (ID!)

    ID of the item to be locked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkFileAsViewedInput\n

    \n

    Autogenerated input type of MarkFileAsViewed.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to mark as viewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkPullRequestReadyForReviewInput\n

    \n

    Autogenerated input type of MarkPullRequestReadyForReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be marked as ready for review.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MergeBranchInput\n

    \n

    Autogenerated input type of MergeBranch.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    base (String!)

    The name of the base branch that the provided head will be merged into.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitMessage (String)

    Message to use for the merge commit. If omitted, a default will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    head (String!)

    The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the Repository containing the base branch that will be modified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MergePullRequestInput\n

    \n

    Autogenerated input type of MergePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    Commit body to use for the merge commit; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    Commit headline to use for the merge commit; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expectedHeadOid (GitObjectID)

    OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod)

    The merge method to use. If omitted, defaults to 'MERGE'.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be merged.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneOrder\n

    \n

    Ordering options for milestone connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (MilestoneOrderField!)

    The field to order milestones by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MinimizeCommentInput\n

    \n

    Autogenerated input type of MinimizeComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    classifier (ReportedContentClassifiers!)

    The classification of comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MoveProjectCardInput\n

    \n

    Autogenerated input type of MoveProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterCardId (ID)

    Place the new card after the card with this id. Pass null to place it at the top.

    \n\n\n\n\n\n\n\n\n\n\n\n

    cardId (ID!)

    The id of the card to move.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to move it into.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MoveProjectColumnInput\n

    \n

    Autogenerated input type of MoveProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterColumnId (ID)

    Place the new column after the column with this id. Pass null to place it at the front.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to move.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationOrder\n

    \n

    Ordering options for organization connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (OrganizationOrderField!)

    The field to order organizations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageFileOrder\n

    \n

    Ways in which lists of package files can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The direction in which to order package files by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PackageFileOrderField)

    The field in which to order package files by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageOrder\n

    \n

    Ways in which lists of packages can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The direction in which to order packages by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PackageOrderField)

    The field in which to order packages by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersionOrder\n

    \n

    Ways in which lists of package versions can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The direction in which to order package versions by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PackageVersionOrderField)

    The field in which to order package versions by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PinIssueInput\n

    \n

    Autogenerated input type of PinIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to be pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardImport\n

    \n

    An issue or PR and its owning repository to be used in a project card.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    number (Int!)

    The issue or pull request number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (String!)

    Repository name with owner (owner/repository).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnImport\n

    \n

    A project column and a list of its issues and PRs.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    columnName (String!)

    The name of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues ([ProjectCardImport!])

    A list of issues and pull requests in the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int!)

    The position of the column, starting from 0.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectOrder\n

    \n

    Ways in which lists of projects can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order projects by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ProjectOrderField!)

    The field in which to order projects by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestOrder\n

    \n

    Ways in which lists of issues can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order pull requests by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PullRequestOrderField!)

    The field in which to order pull requests by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionOrder\n

    \n

    Ways in which lists of reactions can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order reactions by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ReactionOrderField!)

    The field in which to order reactions by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RefOrder\n

    \n

    Ways in which lists of git refs can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order refs by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RefOrderField!)

    The field in which to order refs by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RefUpdate\n

    \n

    A ref update.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterOid (GitObjectID!)

    The value this ref should be updated to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeOid (GitObjectID)

    The value this ref needs to point to before the update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    force (Boolean)

    Force a non fast-forward update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (GitRefname!)

    The fully qualified name of the ref to be update. For example refs/heads/branch-name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RegenerateEnterpriseIdentityProviderRecoveryCodesInput\n

    \n

    Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set an identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RegenerateVerifiableDomainTokenInput\n

    \n

    Autogenerated input type of RegenerateVerifiableDomainToken.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to regenerate the verification token of.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseOrder\n

    \n

    Ways in which lists of releases can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order releases by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ReleaseOrderField!)

    The field in which to order releases by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveAssigneesFromAssignableInput\n

    \n

    Autogenerated input type of RemoveAssigneesFromAssignable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableId (ID!)

    The id of the assignable object to remove assignees from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assigneeIds ([ID!]!)

    The id of users to remove as assignees.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseAdminInput\n

    \n

    Autogenerated input type of RemoveEnterpriseAdmin.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The Enterprise ID from which to remove the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user to remove as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseIdentityProviderInput\n

    \n

    Autogenerated input type of RemoveEnterpriseIdentityProvider.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise from which to remove the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseOrganizationInput\n

    \n

    Autogenerated input type of RemoveEnterpriseOrganization.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise from which the organization should be removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID!)

    The ID of the organization to remove from the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseSupportEntitlementInput\n

    \n

    Autogenerated input type of RemoveEnterpriseSupportEntitlement.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the Enterprise which the admin belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of a member who will lose the support entitlement.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveLabelsFromLabelableInput\n

    \n

    Autogenerated input type of RemoveLabelsFromLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!]!)

    The ids of labels to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the Labelable to remove labels from.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveOutsideCollaboratorInput\n

    \n

    Autogenerated input type of RemoveOutsideCollaborator.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID!)

    The ID of the organization to remove the outside collaborator from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    The ID of the outside collaborator to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveReactionInput\n

    \n

    Autogenerated input type of RemoveReaction.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ReactionContent!)

    The name of the emoji reaction to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveStarInput\n

    \n

    Autogenerated input type of RemoveStar.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starrableId (ID!)

    The Starrable ID to unstar.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenIssueInput\n

    \n

    Autogenerated input type of ReopenIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    ID of the issue to be opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenPullRequestInput\n

    \n

    Autogenerated input type of ReopenPullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be reopened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationOrder\n

    \n

    Ordering options for repository invitation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RepositoryInvitationOrderField!)

    The field to order repository invitations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryOrder\n

    \n

    Ordering options for repository connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RepositoryOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RequestReviewsInput\n

    \n

    Autogenerated input type of RequestReviews.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamIds ([ID!])

    The Node IDs of the team to request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    union (Boolean)

    Add users to the set rather than replace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userIds ([ID!])

    The Node IDs of the user to request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RerequestCheckSuiteInput\n

    \n

    Autogenerated input type of RerequestCheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    checkSuiteId (ID!)

    The Node ID of the check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ResolveReviewThreadInput\n

    \n

    Autogenerated input type of ResolveReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threadId (ID!)

    The ID of the thread to resolve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyOrder\n

    \n

    Ordering options for saved reply connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SavedReplyOrderField!)

    The field to order saved replies by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryIdentifierFilter\n

    \n

    An advisory identifier to filter results on.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    type (SecurityAdvisoryIdentifierType!)

    The identifier type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    The identifier string. Supports exact or partial matching.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryOrder\n

    \n

    Ordering options for security advisory connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SecurityAdvisoryOrderField!)

    The field to order security advisories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityOrder\n

    \n

    Ordering options for security vulnerability connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SecurityVulnerabilityOrderField!)

    The field to order security vulnerabilities by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SetEnterpriseIdentityProviderInput\n

    \n

    Autogenerated input type of SetEnterpriseIdentityProvider.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethod (SamlDigestAlgorithm!)

    The digest algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set an identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    idpCertificate (String!)

    The x509 certificate used by the identity provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (SamlSignatureAlgorithm!)

    The signature algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI!)

    The URL endpoint for the identity provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SetOrganizationInteractionLimitInput\n

    \n

    Autogenerated input type of SetOrganizationInteractionLimit.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiry (RepositoryInteractionLimitExpiry)

    When this limit should expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (RepositoryInteractionLimit!)

    The limit to set.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID!)

    The ID of the organization to set a limit for.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SetRepositoryInteractionLimitInput\n

    \n

    Autogenerated input type of SetRepositoryInteractionLimit.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiry (RepositoryInteractionLimitExpiry)

    When this limit should expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (RepositoryInteractionLimit!)

    The limit to set.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to set a limit for.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SetUserInteractionLimitInput\n

    \n

    Autogenerated input type of SetUserInteractionLimit.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiry (RepositoryInteractionLimitExpiry)

    When this limit should expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (RepositoryInteractionLimit!)

    The limit to set.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    The ID of the user to set a limit for.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorableOrder\n

    \n

    Ordering options for connections to get sponsorable entities for GitHub Sponsors.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SponsorableOrderField!)

    The field to order sponsorable entities by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTierOrder\n

    \n

    Ordering options for Sponsors tiers connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SponsorsTierOrderField!)

    The field to order tiers by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipOrder\n

    \n

    Ordering options for sponsorship connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SponsorshipOrderField!)

    The field to order sponsorship by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n StarOrder\n

    \n

    Ways in which star connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (StarOrderField!)

    The field in which to order nodes by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmitPullRequestReviewInput\n

    \n

    Autogenerated input type of SubmitPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The text field to set on the Pull Request Review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    event (PullRequestReviewEvent!)

    The event to send to the Pull Request Review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The Pull Request ID to submit any pending reviews.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Pull Request Review ID to submit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentOrder\n

    \n

    Ways in which team discussion comment connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamDiscussionCommentOrderField!)

    The field by which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionOrder\n

    \n

    Ways in which team discussion connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamDiscussionOrderField!)

    The field by which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberOrder\n

    \n

    Ordering options for team member connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamMemberOrderField!)

    The field to order team members by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamOrder\n

    \n

    Ways in which team connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamOrderField!)

    The field in which to order nodes by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryOrder\n

    \n

    Ordering options for team repository connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamRepositoryOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TransferIssueInput\n

    \n

    Autogenerated input type of TransferIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The Node ID of the issue to be transferred.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository the issue should be transferred to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnarchiveRepositoryInput\n

    \n

    Autogenerated input type of UnarchiveRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to unarchive.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnfollowUserInput\n

    \n

    Autogenerated input type of UnfollowUser.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    ID of the user to unfollow.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlinkRepositoryFromProjectInput\n

    \n

    Autogenerated input type of UnlinkRepositoryFromProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The ID of the Project linked to the Repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the Repository linked to the Project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlockLockableInput\n

    \n

    Autogenerated input type of UnlockLockable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockableId (ID!)

    ID of the item to be unlocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkFileAsViewedInput\n

    \n

    Autogenerated input type of UnmarkFileAsViewed.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to mark as unviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkIssueAsDuplicateInput\n

    \n

    Autogenerated input type of UnmarkIssueAsDuplicate.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    canonicalId (ID!)

    ID of the issue or pull request currently considered canonical/authoritative/original.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicateId (ID!)

    ID of the issue or pull request currently marked as a duplicate.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnminimizeCommentInput\n

    \n

    Autogenerated input type of UnminimizeComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnpinIssueInput\n

    \n

    Autogenerated input type of UnpinIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to be unpinned.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnresolveReviewThreadInput\n

    \n

    Autogenerated input type of UnresolveReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threadId (ID!)

    The ID of the thread to unresolve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateBranchProtectionRuleInput\n

    \n

    Autogenerated input type of UpdateBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRuleId (ID!)

    The global relay id of the branch protection rule to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String)

    The glob-like pattern used to determine matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushActorIds ([ID!])

    A list of User, Team or App IDs allowed to push to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String!])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalActorIds ([ID!])

    A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateCheckRunInput\n

    \n

    Autogenerated input type of UpdateCheckRun.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actions ([CheckRunAction!])

    Possible further actions the integrator can perform, which a user may trigger.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkRunId (ID!)

    The node of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    The time that the check run finished.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The final conclusion of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL of the integrator's site that has the full details of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    output (CheckRunOutput)

    Descriptive details about the run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    The time that the check run began.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (RequestableCheckStatusState)

    The current status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateCheckSuitePreferencesInput\n

    \n

    Autogenerated input type of UpdateCheckSuitePreferences.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

    The check suite preferences to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseAdministratorRoleInput\n

    \n

    Autogenerated input type of UpdateEnterpriseAdministratorRole.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the Enterprise which the admin belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of a administrator whose role is being changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The new role for the Enterprise administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the allow private repository forking setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the allow private repository forking setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the default repository permission setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

    The value for the default repository permission setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can change repository visibility setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can change repository visibility setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can create repositories setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateInternalRepositories (Boolean)

    Allow members to create internal repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePrivateRepositories (Boolean)

    Allow members to create private repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePublicRepositories (Boolean)

    Allow members to create public repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesPolicyEnabled (Boolean)

    When false, allow member organizations to set their own repository creation member privileges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

    Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can delete issues setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can delete issues setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can delete repositories setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can delete repositories setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can invite collaborators setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can invite collaborators setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can make purchases setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

    The value for the members can make purchases setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can update protected branches setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can update protected branches setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can view dependency insights setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can view dependency insights setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseOrganizationProjectsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the organization projects setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the organization projects setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseProfileInput\n

    \n

    Autogenerated input type of UpdateEnterpriseProfile.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The Enterprise ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The location of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (String)

    The URL of the enterprise's website.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseRepositoryProjectsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the repository projects setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the repository projects setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseTeamDiscussionsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the team discussions setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the team discussions setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the two factor authentication required setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledSettingValue!)

    The value for the two factor authentication required setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIpAllowListEnabledSettingInput\n

    \n

    Autogenerated input type of UpdateIpAllowListEnabledSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner on which to set the IP allow list enabled setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (IpAllowListEnabledSettingValue!)

    The value for the IP allow list enabled setting.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIpAllowListEntryInput\n

    \n

    Autogenerated input type of UpdateIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    An IP address or range of addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntryId (ID!)

    The ID of the IP allow list entry to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the IP allow list entry is active when an IP allow list is enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    An optional name for the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIssueCommentInput\n

    \n

    Autogenerated input type of UpdateIssueComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The updated text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the IssueComment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIssueInput\n

    \n

    Autogenerated input type of UpdateIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    An array of Node IDs of users for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The body for the issue description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the Issue to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (IssueState)

    The desired issue state.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title for the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateLabelInput\n

    \n

    Autogenerated input type of UpdateLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    color (String)

    A 6 character hex code, without the leading #, identifying the updated color of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of the label, such as its purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the label to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The updated name of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateNotificationRestrictionSettingInput\n

    \n

    Autogenerated input type of UpdateNotificationRestrictionSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner on which to set the restrict notifications setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (NotificationRestrictionSettingValue!)

    The value for the restrict notifications setting.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectCardInput\n

    \n

    Autogenerated input type of UpdateProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean)

    Whether or not the ProjectCard should be archived.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The note of ProjectCard.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCardId (ID!)

    The ProjectCard ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectColumnInput\n

    \n

    Autogenerated input type of UpdateProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of project column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectColumnId (ID!)

    The ProjectColumn ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectInput\n

    \n

    Autogenerated input type of UpdateProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Project ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    Whether the project is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectState)

    Whether the project is open or closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestInput\n

    \n

    Autogenerated input type of UpdatePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    An array of Node IDs of users for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String)

    The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The contents of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestUpdateState)

    The target state of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestReviewCommentInput\n

    \n

    Autogenerated input type of UpdatePullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewCommentId (ID!)

    The Node ID of the comment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestReviewInput\n

    \n

    Autogenerated input type of UpdatePullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The contents of the pull request review body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRefInput\n

    \n

    Autogenerated input type of UpdateRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    force (Boolean)

    Permit updates of branch Refs that are not fast-forwards?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The GitObjectID that the Ref shall be updated to target.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The Node ID of the Ref to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRefsInput\n

    \n

    Autogenerated input type of UpdateRefs.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refUpdates ([RefUpdate!]!)

    A list of ref updates.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRepositoryInput\n

    \n

    Autogenerated input type of UpdateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A new description for the repository. Pass an empty string to erase the existing description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean)

    Indicates if the repository should have the issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasProjectsEnabled (Boolean)

    Indicates if the repository should have the project boards feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean)

    Indicates if the repository should have the wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The URL for a web page about this repository. Pass an empty string to erase the existing URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The new name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (Boolean)

    Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateSubscriptionInput\n

    \n

    Autogenerated input type of UpdateSubscription.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (SubscriptionState!)

    The new state of the subscription.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribableId (ID!)

    The Node ID of the subscribable object to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of UpdateTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The updated text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String)

    The current version of the body content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamDiscussionInput\n

    \n

    Autogenerated input type of UpdateTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The updated text of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String)

    The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the discussion to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinned (Boolean)

    If provided, sets the pinned state of the updated discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The updated title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamReviewAssignmentInput\n

    \n

    Autogenerated input type of UpdateTeamReviewAssignment.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    algorithm (TeamReviewAssignmentAlgorithm)

    The algorithm to use for review assignment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabled (Boolean!)

    Turn on or off review assignment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    excludedTeamMemberIds ([ID!])

    An array of team member IDs to exclude.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the team to update review assignments of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notifyTeam (Boolean)

    Notify the entire team of the PR if it is delegated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamMemberCount (Int)

    The number of team members to assign.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTopicsInput\n

    \n

    Autogenerated input type of UpdateTopics.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicNames ([String!]!)

    An array of topic names.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusOrder\n

    \n

    Ordering options for user status connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (UserStatusOrderField!)

    The field to order user statuses by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainOrder\n

    \n

    Ordering options for verifiable domain connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (VerifiableDomainOrderField!)

    The field to order verifiable domains by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifyVerifiableDomainInput\n

    \n

    Autogenerated input type of VerifyVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to verify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n", + "html": "
    \n
    \n

    \n AcceptEnterpriseAdministratorInvitationInput\n

    \n

    Autogenerated input type of AcceptEnterpriseAdministratorInvitation.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationId (ID!)

    The id of the invitation being accepted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AcceptTopicSuggestionInput\n

    \n

    Autogenerated input type of AcceptTopicSuggestion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the suggested topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddAssigneesToAssignableInput\n

    \n

    Autogenerated input type of AddAssigneesToAssignable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableId (ID!)

    The id of the assignable object to add assignees to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assigneeIds ([ID!]!)

    The id of users to add as assignees.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddCommentInput\n

    \n

    Autogenerated input type of AddComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The contents of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddEnterpriseSupportEntitlementInput\n

    \n

    Autogenerated input type of AddEnterpriseSupportEntitlement.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the Enterprise which the admin belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of a member who will receive the support entitlement.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddLabelsToLabelableInput\n

    \n

    Autogenerated input type of AddLabelsToLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!]!)

    The ids of the labels to add.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the labelable object to add labels to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddProjectCardInput\n

    \n

    Autogenerated input type of AddProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentId (ID)

    The content of the card. Must be a member of the ProjectCardItem union.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The note on the card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectColumnId (ID!)

    The Node ID of the ProjectColumn.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddProjectColumnInput\n

    \n

    Autogenerated input type of AddProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Node ID of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewCommentInput\n

    \n

    Autogenerated input type of AddPullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOID (GitObjectID)

    The SHA of the commit to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inReplyTo (ID)

    The comment id to reply to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The relative path of the file to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The line index in the diff to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The node ID of the pull request reviewing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Node ID of the review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewInput\n

    \n

    Autogenerated input type of AddPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The contents of the review body comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments ([DraftPullRequestReviewComment])

    The review line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOID (GitObjectID)

    The commit OID the review pertains to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    event (PullRequestReviewEvent)

    The event to perform on the pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threads ([DraftPullRequestReviewThread])

    The review line comment threads.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewThreadInput\n

    \n

    Autogenerated input type of AddPullRequestReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the thread's first comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    The line of the blob to which the thread refers. The end of the line range for multi-line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The node ID of the pull request reviewing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Node ID of the review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    side (DiffSide)

    The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The first line of the range to which the comment refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startSide (DiffSide)

    The side of the diff on which the start line resides.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddReactionInput\n

    \n

    Autogenerated input type of AddReaction.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ReactionContent!)

    The name of the emoji to react with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddStarInput\n

    \n

    Autogenerated input type of AddStar.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starrableId (ID!)

    The Starrable ID to star.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddVerifiableDomainInput\n

    \n

    Autogenerated input type of AddVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domain (URI!)

    The URL of the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner to add the domain to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ApproveVerifiableDomainInput\n

    \n

    Autogenerated input type of ApproveVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to approve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ArchiveRepositoryInput\n

    \n

    Autogenerated input type of ArchiveRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to mark as archived.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AuditLogOrder\n

    \n

    Ordering options for Audit Log connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (AuditLogOrderField)

    The field to order Audit Logs by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CancelEnterpriseAdminInvitationInput\n

    \n

    Autogenerated input type of CancelEnterpriseAdminInvitation.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitationId (ID!)

    The Node ID of the pending enterprise administrator invitation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ChangeUserStatusInput\n

    \n

    Autogenerated input type of ChangeUserStatus.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emoji (String)

    The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiresAt (DateTime)

    If set, the user status will not be shown after this date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limitedAvailability (Boolean)

    Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    A short description of your current status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID)

    The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationData\n

    \n

    Information from a check run analysis to specific lines of code.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotationLevel (CheckAnnotationLevel!)

    Represents an annotation's information level.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (CheckAnnotationRange!)

    The location of the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    A short description of the feedback for these lines of code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to add an annotation to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rawDetails (String)

    Details about this annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title that represents the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationRange\n

    \n

    Information from a check run analysis to specific lines of code.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    endColumn (Int)

    The ending column of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endLine (Int!)

    The ending line of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startColumn (Int)

    The starting column of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int!)

    The starting line of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunAction\n

    \n

    Possible further actions the integrator can perform.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String!)

    A short explanation of what this action would do.

    \n\n\n\n\n\n\n\n\n\n\n\n

    identifier (String!)

    A reference for the action on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (String!)

    The text to be displayed on a button in the web UI.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunFilter\n

    \n

    The filters that are available when fetching check runs.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (Int)

    Filters the check runs created by this application ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkName (String)

    Filters the check runs by this name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkType (CheckRunType)

    Filters the check runs by this type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState)

    Filters the check runs by this status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunOutput\n

    \n

    Descriptive details about the check run.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotations ([CheckAnnotationData!])

    The annotations that are made as part of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    images ([CheckRunOutputImage!])

    Images attached to the check run output displayed in the GitHub pull request UI.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String!)

    The summary of the check run (supports Commonmark).

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    The details of the check run (supports Commonmark).

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    A title to provide for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunOutputImage\n

    \n

    Images attached to the check run output displayed in the GitHub pull request UI.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    alt (String!)

    The alternative text for the image.

    \n\n\n\n\n\n\n\n\n\n\n\n

    caption (String)

    A short image description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    imageUrl (URI!)

    The full URL of the image.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteAutoTriggerPreference\n

    \n

    The auto-trigger preferences that are available for check suites.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (ID!)

    The node ID of the application that owns the check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    setting (Boolean!)

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteFilter\n

    \n

    The filters that are available when fetching check suites.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (Int)

    Filters the check suites created by this application ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkName (String)

    Filters the check suites by this name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ClearLabelsFromLabelableInput\n

    \n

    Autogenerated input type of ClearLabelsFromLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the labelable object to clear the labels from.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloneProjectInput\n

    \n

    Autogenerated input type of CloneProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includeWorkflows (Boolean!)

    Whether or not to clone the source project's workflows.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    The visibility of the project, defaults to false (private).

    \n\n\n\n\n\n\n\n\n\n\n\n

    sourceId (ID!)

    The source project to clone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetOwnerId (ID!)

    The owner ID to create the project under.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloneTemplateRepositoryInput\n

    \n

    Autogenerated input type of CloneTemplateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includeAllBranches (Boolean)

    Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner for the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the template repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepositoryVisibility!)

    Indicates the repository's visibility level.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloseIssueInput\n

    \n

    Autogenerated input type of CloseIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    ID of the issue to be closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ClosePullRequestInput\n

    \n

    Autogenerated input type of ClosePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitAuthor\n

    \n

    Specifies an author for filtering Git commits.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([String!])

    Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID)

    ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitContributionOrder\n

    \n

    Ordering options for commit contribution connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (CommitContributionOrderField!)

    The field by which to order commit contributions.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionOrder\n

    \n

    Ordering options for contribution connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertProjectCardNoteToIssueInput\n

    \n

    Autogenerated input type of ConvertProjectCardNoteToIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The body of the newly created issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCardId (ID!)

    The ProjectCard ID to convert.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to create the issue in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title of the newly created issue. Defaults to the card's note text.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateBranchProtectionRuleInput\n

    \n

    Autogenerated input type of CreateBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String!)

    The glob-like pattern used to determine matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushActorIds ([ID!])

    A list of User, Team or App IDs allowed to push to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The global relay id of the repository in which a new branch protection rule should be created in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String!])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalActorIds ([ID!])

    A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateCheckRunInput\n

    \n

    Autogenerated input type of CreateCheckRun.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actions ([CheckRunAction!])

    Possible further actions the integrator can perform, which a user may trigger.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    The time that the check run finished.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The final conclusion of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL of the integrator's site that has the full details of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headSha (GitObjectID!)

    The SHA of the head commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    output (CheckRunOutput)

    Descriptive details about the run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    The time that the check run began.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (RequestableCheckStatusState)

    The current status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateCheckSuiteInput\n

    \n

    Autogenerated input type of CreateCheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headSha (GitObjectID!)

    The SHA of the head commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateContentAttachmentInput\n

    \n

    Autogenerated input type of CreateContentAttachment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body of the content attachment, which may contain markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentReferenceId (ID!)

    The node ID of the content_reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the content attachment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateDeploymentInput\n

    \n

    Autogenerated input type of CreateDeployment.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoMerge (Boolean)

    Attempt to automatically merge the default branch into the requested ref, defaults to true.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Short description of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    Name for the target deployment environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String)

    JSON payload with extra information about the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The node ID of the ref to be deployed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredContexts ([String!])

    The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    task (String)

    Specifies a task to execute.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateDeploymentStatusInput\n

    \n

    Autogenerated input type of CreateDeploymentStatus.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoInactive (Boolean)

    Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deploymentId (ID!)

    The node ID of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the status. Maximum length of 140 characters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environmentUrl (String)

    Sets the URL for accessing your environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logUrl (String)

    The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentStatusState!)

    The state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateEnterpriseOrganizationInput\n

    \n

    Autogenerated input type of CreateEnterpriseOrganization.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    adminLogins ([String!]!)

    The logins for the administrators of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    billingEmail (String!)

    The email used for sending billing receipts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise owning the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    profileName (String!)

    The profile name of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateIpAllowListEntryInput\n

    \n

    Autogenerated input type of CreateIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    An IP address or range of addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the IP allow list entry is active when an IP allow list is enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    An optional name for the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner for which to create the new IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateIssueInput\n

    \n

    Autogenerated input type of CreateIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    The Node ID for the user assignee for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The body for the issue description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueTemplate (String)

    The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title for the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateLabelInput\n

    \n

    Autogenerated input type of CreateLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    color (String!)

    A 6 character hex code, without the leading #, identifying the color of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of the label, such as its purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateProjectInput\n

    \n

    Autogenerated input type of CreateProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The owner ID to create the project under.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryIds ([ID!])

    A list of repository IDs to create as linked repositories for the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (ProjectTemplate)

    The name of the GitHub-provided template.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatePullRequestInput\n

    \n

    Autogenerated input type of CreatePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    baseRefName (String!)

    The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The contents of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    draft (Boolean)

    Indicates whether this pull request should be a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateRefInput\n

    \n

    Autogenerated input type of CreateRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The GitObjectID that the new Ref shall target. Must point to a commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the Repository to create the Ref in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateRepositoryInput\n

    \n

    Autogenerated input type of CreateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean)

    Indicates if the repository should have the issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean)

    Indicates if the repository should have the wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The URL for a web page about this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID)

    The ID of the owner for the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamId (ID)

    When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (Boolean)

    Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepositoryVisibility!)

    Indicates the repository's visibility level.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of CreateTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The content of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussionId (ID!)

    The ID of the discussion to which the comment belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateTeamDiscussionInput\n

    \n

    Autogenerated input type of CreateTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The content of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    private (Boolean)

    If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamId (ID!)

    The ID of the team to which the discussion belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeclineTopicSuggestionInput\n

    \n

    Autogenerated input type of DeclineTopicSuggestion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the suggested topic.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reason (TopicSuggestionDeclineReason!)

    The reason why the suggested topic is declined.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteBranchProtectionRuleInput\n

    \n

    Autogenerated input type of DeleteBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branchProtectionRuleId (ID!)

    The global relay id of the branch protection rule to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteDeploymentInput\n

    \n

    Autogenerated input type of DeleteDeployment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the deployment to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIpAllowListEntryInput\n

    \n

    Autogenerated input type of DeleteIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntryId (ID!)

    The ID of the IP allow list entry to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIssueCommentInput\n

    \n

    Autogenerated input type of DeleteIssueComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIssueInput\n

    \n

    Autogenerated input type of DeleteIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteLabelInput\n

    \n

    Autogenerated input type of DeleteLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the label to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePackageVersionInput\n

    \n

    Autogenerated input type of DeletePackageVersion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    packageVersionId (ID!)

    The ID of the package version to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectCardInput\n

    \n

    Autogenerated input type of DeleteProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cardId (ID!)

    The id of the card to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectColumnInput\n

    \n

    Autogenerated input type of DeleteProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectInput\n

    \n

    Autogenerated input type of DeleteProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Project ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePullRequestReviewCommentInput\n

    \n

    Autogenerated input type of DeletePullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePullRequestReviewInput\n

    \n

    Autogenerated input type of DeletePullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteRefInput\n

    \n

    Autogenerated input type of DeleteRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The Node ID of the Ref to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of DeleteTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteTeamDiscussionInput\n

    \n

    Autogenerated input type of DeleteTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The discussion ID to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteVerifiableDomainInput\n

    \n

    Autogenerated input type of DeleteVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentOrder\n

    \n

    Ordering options for deployment connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (DeploymentOrderField!)

    The field to order deployments by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DisablePullRequestAutoMergeInput\n

    \n

    Autogenerated input type of DisablePullRequestAutoMerge.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to disable auto merge on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DismissPullRequestReviewInput\n

    \n

    Autogenerated input type of DismissPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    The contents of the pull request review dismissal message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DraftPullRequestReviewComment\n

    \n

    Specifies a review comment to be left with a Pull Request Review.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the comment to leave.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int!)

    Position in the file to leave a comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DraftPullRequestReviewThread\n

    \n

    Specifies a review comment thread to be left with a Pull Request Review.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the comment to leave.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    The line of the blob to which the thread refers. The end of the line range for multi-line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    side (DiffSide)

    The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The first line of the range to which the comment refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startSide (DiffSide)

    The side of the diff on which the start line resides.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnablePullRequestAutoMergeInput\n

    \n

    Autogenerated input type of EnablePullRequestAutoMerge.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod)

    The merge method to use. If omitted, defaults to 'MERGE'.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to enable auto-merge on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationOrder\n

    \n

    Ordering options for enterprise administrator invitation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseAdministratorInvitationOrderField!)

    The field to order enterprise administrator invitations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberOrder\n

    \n

    Ordering options for enterprise member connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseMemberOrderField!)

    The field to order enterprise members by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerInstallationOrder\n

    \n

    Ordering options for Enterprise Server installation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerInstallationOrderField!)

    The field to order Enterprise Server installations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailOrder\n

    \n

    Ordering options for Enterprise Server user account email connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountEmailOrderField!)

    The field to order emails by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountOrder\n

    \n

    Ordering options for Enterprise Server user account connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountOrderField!)

    The field to order user accounts by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadOrder\n

    \n

    Ordering options for Enterprise Server user accounts upload connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountsUploadOrderField!)

    The field to order user accounts uploads by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowUserInput\n

    \n

    Autogenerated input type of FollowUser.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    ID of the user to follow.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n GistOrder\n

    \n

    Ordering options for gist connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (GistOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ImportProjectInput\n

    \n

    Autogenerated input type of ImportProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of Project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnImports ([ProjectColumnImport!]!)

    A list of columns containing issues and pull requests.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of Project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerName (String!)

    The name of the Organization or User to create the Project under.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    Whether the Project is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n InviteEnterpriseAdminInput\n

    \n

    Autogenerated input type of InviteEnterpriseAdmin.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    email (String)

    The email of the person to invite as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise to which you want to invite an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    invitee (String)

    The login of a user to invite as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole)

    The role of the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryOrder\n

    \n

    Ordering options for IP allow list entry connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IpAllowListEntryOrderField!)

    The field to order IP allow list entries by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentOrder\n

    \n

    Ways in which lists of issue comments can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order issue comments by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IssueCommentOrderField!)

    The field in which to order issue comments by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueFilters\n

    \n

    Ways in which to filter lists of issues.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignee (String)

    List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdBy (String)

    List issues created by given name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels ([String!])

    List issues where the list of label names exist on the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mentioned (String)

    List issues where the given name is mentioned in the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (String)

    List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    since (DateTime)

    List issues that have been updated at or after the given date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    states ([IssueState!])

    List issues filtered by the list of states given.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscribed (Boolean)

    List issues subscribed to by viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueOrder\n

    \n

    Ways in which lists of issues can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order issues by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IssueOrderField!)

    The field in which to order issues by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelOrder\n

    \n

    Ways in which lists of labels can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order labels by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (LabelOrderField!)

    The field in which to order labels by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageOrder\n

    \n

    Ordering options for language connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (LanguageOrderField!)

    The field to order languages by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LinkRepositoryToProjectInput\n

    \n

    Autogenerated input type of LinkRepositoryToProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The ID of the Project to link to a Repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the Repository to link to a Project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LockLockableInput\n

    \n

    Autogenerated input type of LockLockable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (LockReason)

    A reason for why the item will be locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockableId (ID!)

    ID of the item to be locked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkFileAsViewedInput\n

    \n

    Autogenerated input type of MarkFileAsViewed.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to mark as viewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkPullRequestReadyForReviewInput\n

    \n

    Autogenerated input type of MarkPullRequestReadyForReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be marked as ready for review.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MergeBranchInput\n

    \n

    Autogenerated input type of MergeBranch.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    base (String!)

    The name of the base branch that the provided head will be merged into.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitMessage (String)

    Message to use for the merge commit. If omitted, a default will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    head (String!)

    The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the Repository containing the base branch that will be modified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MergePullRequestInput\n

    \n

    Autogenerated input type of MergePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    Commit body to use for the merge commit; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    Commit headline to use for the merge commit; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expectedHeadOid (GitObjectID)

    OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod)

    The merge method to use. If omitted, defaults to 'MERGE'.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be merged.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneOrder\n

    \n

    Ordering options for milestone connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (MilestoneOrderField!)

    The field to order milestones by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MinimizeCommentInput\n

    \n

    Autogenerated input type of MinimizeComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    classifier (ReportedContentClassifiers!)

    The classification of comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MoveProjectCardInput\n

    \n

    Autogenerated input type of MoveProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterCardId (ID)

    Place the new card after the card with this id. Pass null to place it at the top.

    \n\n\n\n\n\n\n\n\n\n\n\n

    cardId (ID!)

    The id of the card to move.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to move it into.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MoveProjectColumnInput\n

    \n

    Autogenerated input type of MoveProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterColumnId (ID)

    Place the new column after the column with this id. Pass null to place it at the front.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to move.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationOrder\n

    \n

    Ordering options for organization connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (OrganizationOrderField!)

    The field to order organizations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageFileOrder\n

    \n

    Ways in which lists of package files can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The direction in which to order package files by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PackageFileOrderField)

    The field in which to order package files by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageOrder\n

    \n

    Ways in which lists of packages can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The direction in which to order packages by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PackageOrderField)

    The field in which to order packages by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PackageVersionOrder\n

    \n

    Ways in which lists of package versions can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The direction in which to order package versions by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PackageVersionOrderField)

    The field in which to order package versions by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PinIssueInput\n

    \n

    Autogenerated input type of PinIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to be pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardImport\n

    \n

    An issue or PR and its owning repository to be used in a project card.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    number (Int!)

    The issue or pull request number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (String!)

    Repository name with owner (owner/repository).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnImport\n

    \n

    A project column and a list of its issues and PRs.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    columnName (String!)

    The name of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues ([ProjectCardImport!])

    A list of issues and pull requests in the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int!)

    The position of the column, starting from 0.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectOrder\n

    \n

    Ways in which lists of projects can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order projects by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ProjectOrderField!)

    The field in which to order projects by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestOrder\n

    \n

    Ways in which lists of issues can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order pull requests by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PullRequestOrderField!)

    The field in which to order pull requests by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionOrder\n

    \n

    Ways in which lists of reactions can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order reactions by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ReactionOrderField!)

    The field in which to order reactions by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RefOrder\n

    \n

    Ways in which lists of git refs can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order refs by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RefOrderField!)

    The field in which to order refs by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RefUpdate\n

    \n

    A ref update.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterOid (GitObjectID!)

    The value this ref should be updated to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeOid (GitObjectID)

    The value this ref needs to point to before the update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    force (Boolean)

    Force a non fast-forward update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (GitRefname!)

    The fully qualified name of the ref to be update. For example refs/heads/branch-name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RegenerateEnterpriseIdentityProviderRecoveryCodesInput\n

    \n

    Autogenerated input type of RegenerateEnterpriseIdentityProviderRecoveryCodes.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set an identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RegenerateVerifiableDomainTokenInput\n

    \n

    Autogenerated input type of RegenerateVerifiableDomainToken.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to regenerate the verification token of.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseOrder\n

    \n

    Ways in which lists of releases can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order releases by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ReleaseOrderField!)

    The field in which to order releases by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveAssigneesFromAssignableInput\n

    \n

    Autogenerated input type of RemoveAssigneesFromAssignable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableId (ID!)

    The id of the assignable object to remove assignees from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assigneeIds ([ID!]!)

    The id of users to remove as assignees.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseAdminInput\n

    \n

    Autogenerated input type of RemoveEnterpriseAdmin.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The Enterprise ID from which to remove the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user to remove as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseIdentityProviderInput\n

    \n

    Autogenerated input type of RemoveEnterpriseIdentityProvider.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise from which to remove the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseOrganizationInput\n

    \n

    Autogenerated input type of RemoveEnterpriseOrganization.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise from which the organization should be removed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID!)

    The ID of the organization to remove from the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseSupportEntitlementInput\n

    \n

    Autogenerated input type of RemoveEnterpriseSupportEntitlement.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the Enterprise which the admin belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of a member who will lose the support entitlement.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveLabelsFromLabelableInput\n

    \n

    Autogenerated input type of RemoveLabelsFromLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!]!)

    The ids of labels to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the Labelable to remove labels from.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveOutsideCollaboratorInput\n

    \n

    Autogenerated input type of RemoveOutsideCollaborator.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID!)

    The ID of the organization to remove the outside collaborator from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    The ID of the outside collaborator to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveReactionInput\n

    \n

    Autogenerated input type of RemoveReaction.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ReactionContent!)

    The name of the emoji reaction to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveStarInput\n

    \n

    Autogenerated input type of RemoveStar.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starrableId (ID!)

    The Starrable ID to unstar.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenIssueInput\n

    \n

    Autogenerated input type of ReopenIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    ID of the issue to be opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenPullRequestInput\n

    \n

    Autogenerated input type of ReopenPullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be reopened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationOrder\n

    \n

    Ordering options for repository invitation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RepositoryInvitationOrderField!)

    The field to order repository invitations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryOrder\n

    \n

    Ordering options for repository connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RepositoryOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RequestReviewsInput\n

    \n

    Autogenerated input type of RequestReviews.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamIds ([ID!])

    The Node IDs of the team to request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    union (Boolean)

    Add users to the set rather than replace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userIds ([ID!])

    The Node IDs of the user to request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RerequestCheckSuiteInput\n

    \n

    Autogenerated input type of RerequestCheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    checkSuiteId (ID!)

    The Node ID of the check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ResolveReviewThreadInput\n

    \n

    Autogenerated input type of ResolveReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threadId (ID!)

    The ID of the thread to resolve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyOrder\n

    \n

    Ordering options for saved reply connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SavedReplyOrderField!)

    The field to order saved replies by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryIdentifierFilter\n

    \n

    An advisory identifier to filter results on.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    type (SecurityAdvisoryIdentifierType!)

    The identifier type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    value (String!)

    The identifier string. Supports exact or partial matching.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityAdvisoryOrder\n

    \n

    Ordering options for security advisory connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SecurityAdvisoryOrderField!)

    The field to order security advisories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SecurityVulnerabilityOrder\n

    \n

    Ordering options for security vulnerability connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SecurityVulnerabilityOrderField!)

    The field to order security vulnerabilities by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SetEnterpriseIdentityProviderInput\n

    \n

    Autogenerated input type of SetEnterpriseIdentityProvider.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    digestMethod (SamlDigestAlgorithm!)

    The digest algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set an identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    idpCertificate (String!)

    The x509 certificate used by the identity provider to sign assertions and responses.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issuer (String)

    The Issuer Entity ID for the SAML identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    signatureMethod (SamlSignatureAlgorithm!)

    The signature algorithm used to sign SAML requests for the identity provider.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ssoUrl (URI!)

    The URL endpoint for the identity provider's SAML SSO.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SetOrganizationInteractionLimitInput\n

    \n

    Autogenerated input type of SetOrganizationInteractionLimit.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiry (RepositoryInteractionLimitExpiry)

    When this limit should expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (RepositoryInteractionLimit!)

    The limit to set.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID!)

    The ID of the organization to set a limit for.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SetRepositoryInteractionLimitInput\n

    \n

    Autogenerated input type of SetRepositoryInteractionLimit.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiry (RepositoryInteractionLimitExpiry)

    When this limit should expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (RepositoryInteractionLimit!)

    The limit to set.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to set a limit for.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SetUserInteractionLimitInput\n

    \n

    Autogenerated input type of SetUserInteractionLimit.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiry (RepositoryInteractionLimitExpiry)

    When this limit should expire.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limit (RepositoryInteractionLimit!)

    The limit to set.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    The ID of the user to set a limit for.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorableOrder\n

    \n

    Ordering options for connections to get sponsorable entities for GitHub Sponsors.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SponsorableOrderField!)

    The field to order sponsorable entities by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorsTierOrder\n

    \n

    Ordering options for Sponsors tiers connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SponsorsTierOrderField!)

    The field to order tiers by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipOrder\n

    \n

    Ordering options for sponsorship connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SponsorshipOrderField!)

    The field to order sponsorship by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n StarOrder\n

    \n

    Ways in which star connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (StarOrderField!)

    The field in which to order nodes by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmitPullRequestReviewInput\n

    \n

    Autogenerated input type of SubmitPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The text field to set on the Pull Request Review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    event (PullRequestReviewEvent!)

    The event to send to the Pull Request Review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The Pull Request ID to submit any pending reviews.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Pull Request Review ID to submit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentOrder\n

    \n

    Ways in which team discussion comment connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamDiscussionCommentOrderField!)

    The field by which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionOrder\n

    \n

    Ways in which team discussion connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamDiscussionOrderField!)

    The field by which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberOrder\n

    \n

    Ordering options for team member connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamMemberOrderField!)

    The field to order team members by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamOrder\n

    \n

    Ways in which team connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamOrderField!)

    The field in which to order nodes by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryOrder\n

    \n

    Ordering options for team repository connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamRepositoryOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TransferIssueInput\n

    \n

    Autogenerated input type of TransferIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The Node ID of the issue to be transferred.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository the issue should be transferred to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnarchiveRepositoryInput\n

    \n

    Autogenerated input type of UnarchiveRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to unarchive.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnfollowUserInput\n

    \n

    Autogenerated input type of UnfollowUser.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    ID of the user to unfollow.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlinkRepositoryFromProjectInput\n

    \n

    Autogenerated input type of UnlinkRepositoryFromProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The ID of the Project linked to the Repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the Repository linked to the Project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlockLockableInput\n

    \n

    Autogenerated input type of UnlockLockable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockableId (ID!)

    ID of the item to be unlocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkFileAsViewedInput\n

    \n

    Autogenerated input type of UnmarkFileAsViewed.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to mark as unviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkIssueAsDuplicateInput\n

    \n

    Autogenerated input type of UnmarkIssueAsDuplicate.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    canonicalId (ID!)

    ID of the issue or pull request currently considered canonical/authoritative/original.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicateId (ID!)

    ID of the issue or pull request currently marked as a duplicate.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnminimizeCommentInput\n

    \n

    Autogenerated input type of UnminimizeComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnpinIssueInput\n

    \n

    Autogenerated input type of UnpinIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to be unpinned.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnresolveReviewThreadInput\n

    \n

    Autogenerated input type of UnresolveReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threadId (ID!)

    The ID of the thread to unresolve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateBranchProtectionRuleInput\n

    \n

    Autogenerated input type of UpdateBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRuleId (ID!)

    The global relay id of the branch protection rule to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String)

    The glob-like pattern used to determine matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushActorIds ([ID!])

    A list of User, Team or App IDs allowed to push to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String!])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalActorIds ([ID!])

    A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateCheckRunInput\n

    \n

    Autogenerated input type of UpdateCheckRun.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actions ([CheckRunAction!])

    Possible further actions the integrator can perform, which a user may trigger.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkRunId (ID!)

    The node of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    The time that the check run finished.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The final conclusion of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL of the integrator's site that has the full details of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    output (CheckRunOutput)

    Descriptive details about the run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    The time that the check run began.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (RequestableCheckStatusState)

    The current status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateCheckSuitePreferencesInput\n

    \n

    Autogenerated input type of UpdateCheckSuitePreferences.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

    The check suite preferences to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseAdministratorRoleInput\n

    \n

    Autogenerated input type of UpdateEnterpriseAdministratorRole.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the Enterprise which the admin belongs to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of a administrator whose role is being changed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    role (EnterpriseAdministratorRole!)

    The new role for the Enterprise administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the allow private repository forking setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the allow private repository forking setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the default repository permission setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

    The value for the default repository permission setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can change repository visibility setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can change repository visibility setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can create repositories setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateInternalRepositories (Boolean)

    Allow members to create internal repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePrivateRepositories (Boolean)

    Allow members to create private repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePublicRepositories (Boolean)

    Allow members to create public repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesPolicyEnabled (Boolean)

    When false, allow member organizations to set their own repository creation member privileges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

    Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can delete issues setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can delete issues setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can delete repositories setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can delete repositories setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can invite collaborators setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can invite collaborators setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can make purchases setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

    The value for the members can make purchases setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can update protected branches setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can update protected branches setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can view dependency insights setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can view dependency insights setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseOrganizationProjectsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the organization projects setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the organization projects setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseProfileInput\n

    \n

    Autogenerated input type of UpdateEnterpriseProfile.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The Enterprise ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The location of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (String)

    The URL of the enterprise's website.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseRepositoryProjectsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the repository projects setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the repository projects setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseTeamDiscussionsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the team discussions setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the team discussions setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the two factor authentication required setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledSettingValue!)

    The value for the two factor authentication required setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIpAllowListEnabledSettingInput\n

    \n

    Autogenerated input type of UpdateIpAllowListEnabledSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner on which to set the IP allow list enabled setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (IpAllowListEnabledSettingValue!)

    The value for the IP allow list enabled setting.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIpAllowListEntryInput\n

    \n

    Autogenerated input type of UpdateIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    An IP address or range of addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntryId (ID!)

    The ID of the IP allow list entry to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the IP allow list entry is active when an IP allow list is enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    An optional name for the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIssueCommentInput\n

    \n

    Autogenerated input type of UpdateIssueComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The updated text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the IssueComment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIssueInput\n

    \n

    Autogenerated input type of UpdateIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    An array of Node IDs of users for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The body for the issue description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the Issue to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (IssueState)

    The desired issue state.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title for the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateLabelInput\n

    \n

    Autogenerated input type of UpdateLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    color (String)

    A 6 character hex code, without the leading #, identifying the updated color of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of the label, such as its purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the label to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The updated name of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateNotificationRestrictionSettingInput\n

    \n

    Autogenerated input type of UpdateNotificationRestrictionSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner on which to set the restrict notifications setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (NotificationRestrictionSettingValue!)

    The value for the restrict notifications setting.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectCardInput\n

    \n

    Autogenerated input type of UpdateProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean)

    Whether or not the ProjectCard should be archived.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The note of ProjectCard.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCardId (ID!)

    The ProjectCard ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectColumnInput\n

    \n

    Autogenerated input type of UpdateProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of project column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectColumnId (ID!)

    The ProjectColumn ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectInput\n

    \n

    Autogenerated input type of UpdateProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Project ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    Whether the project is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectState)

    Whether the project is open or closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestInput\n

    \n

    Autogenerated input type of UpdatePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    An array of Node IDs of users for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String)

    The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The contents of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestUpdateState)

    The target state of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestReviewCommentInput\n

    \n

    Autogenerated input type of UpdatePullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewCommentId (ID!)

    The Node ID of the comment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestReviewInput\n

    \n

    Autogenerated input type of UpdatePullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The contents of the pull request review body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRefInput\n

    \n

    Autogenerated input type of UpdateRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    force (Boolean)

    Permit updates of branch Refs that are not fast-forwards?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The GitObjectID that the Ref shall be updated to target.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The Node ID of the Ref to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRefsInput\n

    \n

    Autogenerated input type of UpdateRefs.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refUpdates ([RefUpdate!]!)

    A list of ref updates.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRepositoryInput\n

    \n

    Autogenerated input type of UpdateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A new description for the repository. Pass an empty string to erase the existing description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean)

    Indicates if the repository should have the issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasProjectsEnabled (Boolean)

    Indicates if the repository should have the project boards feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean)

    Indicates if the repository should have the wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The URL for a web page about this repository. Pass an empty string to erase the existing URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The new name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (Boolean)

    Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateSubscriptionInput\n

    \n

    Autogenerated input type of UpdateSubscription.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (SubscriptionState!)

    The new state of the subscription.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribableId (ID!)

    The Node ID of the subscribable object to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of UpdateTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The updated text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String)

    The current version of the body content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamDiscussionInput\n

    \n

    Autogenerated input type of UpdateTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The updated text of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String)

    The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the discussion to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinned (Boolean)

    If provided, sets the pinned state of the updated discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The updated title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamReviewAssignmentInput\n

    \n

    Autogenerated input type of UpdateTeamReviewAssignment.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    algorithm (TeamReviewAssignmentAlgorithm)

    The algorithm to use for review assignment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabled (Boolean!)

    Turn on or off review assignment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    excludedTeamMemberIds ([ID!])

    An array of team member IDs to exclude.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the team to update review assignments of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notifyTeam (Boolean)

    Notify the entire team of the PR if it is delegated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamMemberCount (Int)

    The number of team members to assign.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTopicsInput\n

    \n

    Autogenerated input type of UpdateTopics.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicNames ([String!]!)

    An array of topic names.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusOrder\n

    \n

    Ordering options for user status connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (UserStatusOrderField!)

    The field to order user statuses by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainOrder\n

    \n

    Ordering options for verifiable domain connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (VerifiableDomainOrderField!)

    The field to order verifiable domains by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifyVerifiableDomainInput\n

    \n

    Autogenerated input type of VerifyVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to verify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n", "miniToc": [ { "contents": "\n AcceptEnterpriseAdministratorInvitationInput\n ", @@ -182,11 +182,6 @@ "headingLevel": 3, "indentationLevel": 0 }, - { - "contents": "\n ConvertPullRequestToDraftInput\n ", - "headingLevel": 3, - "indentationLevel": 0 - }, { "contents": "\n CreateBranchProtectionRuleInput\n ", "headingLevel": 3, @@ -3595,7 +3590,7 @@ ] }, "ghae": { - "html": "
    \n
    \n

    \n AddAssigneesToAssignableInput\n

    \n

    Autogenerated input type of AddAssigneesToAssignable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableId (ID!)

    The id of the assignable object to add assignees to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assigneeIds ([ID!]!)

    The id of users to add as assignees.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddCommentInput\n

    \n

    Autogenerated input type of AddComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The contents of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddEnterpriseAdminInput\n

    \n

    Autogenerated input type of AddEnterpriseAdmin.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise account to which the administrator should be added.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user to add as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddLabelsToLabelableInput\n

    \n

    Autogenerated input type of AddLabelsToLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!]!)

    The ids of the labels to add.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the labelable object to add labels to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddProjectCardInput\n

    \n

    Autogenerated input type of AddProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentId (ID)

    The content of the card. Must be a member of the ProjectCardItem union.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The note on the card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectColumnId (ID!)

    The Node ID of the ProjectColumn.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddProjectColumnInput\n

    \n

    Autogenerated input type of AddProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Node ID of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewCommentInput\n

    \n

    Autogenerated input type of AddPullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOID (GitObjectID)

    The SHA of the commit to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inReplyTo (ID)

    The comment id to reply to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The relative path of the file to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The line index in the diff to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The node ID of the pull request reviewing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Node ID of the review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewInput\n

    \n

    Autogenerated input type of AddPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The contents of the review body comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments ([DraftPullRequestReviewComment])

    The review line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOID (GitObjectID)

    The commit OID the review pertains to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    event (PullRequestReviewEvent)

    The event to perform on the pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threads ([DraftPullRequestReviewThread])

    The review line comment threads.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewThreadInput\n

    \n

    Autogenerated input type of AddPullRequestReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the thread's first comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    The line of the blob to which the thread refers. The end of the line range for multi-line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The node ID of the pull request reviewing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Node ID of the review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    side (DiffSide)

    The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The first line of the range to which the comment refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startSide (DiffSide)

    The side of the diff on which the start line resides.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddReactionInput\n

    \n

    Autogenerated input type of AddReaction.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ReactionContent!)

    The name of the emoji to react with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddStarInput\n

    \n

    Autogenerated input type of AddStar.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starrableId (ID!)

    The Starrable ID to star.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddVerifiableDomainInput\n

    \n

    Autogenerated input type of AddVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domain (URI!)

    The URL of the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner to add the domain to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ApproveVerifiableDomainInput\n

    \n

    Autogenerated input type of ApproveVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to approve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ArchiveRepositoryInput\n

    \n

    Autogenerated input type of ArchiveRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to mark as archived.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AuditLogOrder\n

    \n

    Ordering options for Audit Log connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (AuditLogOrderField)

    The field to order Audit Logs by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ChangeUserStatusInput\n

    \n

    Autogenerated input type of ChangeUserStatus.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emoji (String)

    The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiresAt (DateTime)

    If set, the user status will not be shown after this date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limitedAvailability (Boolean)

    Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    A short description of your current status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID)

    The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationData\n

    \n

    Information from a check run analysis to specific lines of code.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotationLevel (CheckAnnotationLevel!)

    Represents an annotation's information level.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (CheckAnnotationRange!)

    The location of the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    A short description of the feedback for these lines of code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to add an annotation to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rawDetails (String)

    Details about this annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title that represents the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationRange\n

    \n

    Information from a check run analysis to specific lines of code.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    endColumn (Int)

    The ending column of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endLine (Int!)

    The ending line of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startColumn (Int)

    The starting column of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int!)

    The starting line of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunAction\n

    \n

    Possible further actions the integrator can perform.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String!)

    A short explanation of what this action would do.

    \n\n\n\n\n\n\n\n\n\n\n\n

    identifier (String!)

    A reference for the action on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (String!)

    The text to be displayed on a button in the web UI.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunFilter\n

    \n

    The filters that are available when fetching check runs.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (Int)

    Filters the check runs created by this application ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkName (String)

    Filters the check runs by this name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkType (CheckRunType)

    Filters the check runs by this type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState)

    Filters the check runs by this status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunOutput\n

    \n

    Descriptive details about the check run.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotations ([CheckAnnotationData!])

    The annotations that are made as part of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    images ([CheckRunOutputImage!])

    Images attached to the check run output displayed in the GitHub pull request UI.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String!)

    The summary of the check run (supports Commonmark).

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    The details of the check run (supports Commonmark).

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    A title to provide for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunOutputImage\n

    \n

    Images attached to the check run output displayed in the GitHub pull request UI.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    alt (String!)

    The alternative text for the image.

    \n\n\n\n\n\n\n\n\n\n\n\n

    caption (String)

    A short image description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    imageUrl (URI!)

    The full URL of the image.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteAutoTriggerPreference\n

    \n

    The auto-trigger preferences that are available for check suites.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (ID!)

    The node ID of the application that owns the check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    setting (Boolean!)

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteFilter\n

    \n

    The filters that are available when fetching check suites.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (Int)

    Filters the check suites created by this application ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkName (String)

    Filters the check suites by this name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ClearLabelsFromLabelableInput\n

    \n

    Autogenerated input type of ClearLabelsFromLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the labelable object to clear the labels from.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloneProjectInput\n

    \n

    Autogenerated input type of CloneProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includeWorkflows (Boolean!)

    Whether or not to clone the source project's workflows.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    The visibility of the project, defaults to false (private).

    \n\n\n\n\n\n\n\n\n\n\n\n

    sourceId (ID!)

    The source project to clone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetOwnerId (ID!)

    The owner ID to create the project under.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloneTemplateRepositoryInput\n

    \n

    Autogenerated input type of CloneTemplateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includeAllBranches (Boolean)

    Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner for the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the template repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepositoryVisibility!)

    Indicates the repository's visibility level.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloseIssueInput\n

    \n

    Autogenerated input type of CloseIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    ID of the issue to be closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ClosePullRequestInput\n

    \n

    Autogenerated input type of ClosePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitAuthor\n

    \n

    Specifies an author for filtering Git commits.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([String!])

    Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID)

    ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitContributionOrder\n

    \n

    Ordering options for commit contribution connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (CommitContributionOrderField!)

    The field by which to order commit contributions.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionOrder\n

    \n

    Ordering options for contribution connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertProjectCardNoteToIssueInput\n

    \n

    Autogenerated input type of ConvertProjectCardNoteToIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The body of the newly created issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCardId (ID!)

    The ProjectCard ID to convert.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to create the issue in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title of the newly created issue. Defaults to the card's note text.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertPullRequestToDraftInput\n

    \n

    Autogenerated input type of ConvertPullRequestToDraft.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to convert to draft.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateBranchProtectionRuleInput\n

    \n

    Autogenerated input type of CreateBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String!)

    The glob-like pattern used to determine matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushActorIds ([ID!])

    A list of User, Team or App IDs allowed to push to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The global relay id of the repository in which a new branch protection rule should be created in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String!])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalActorIds ([ID!])

    A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateCheckRunInput\n

    \n

    Autogenerated input type of CreateCheckRun.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actions ([CheckRunAction!])

    Possible further actions the integrator can perform, which a user may trigger.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    The time that the check run finished.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The final conclusion of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL of the integrator's site that has the full details of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headSha (GitObjectID!)

    The SHA of the head commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    output (CheckRunOutput)

    Descriptive details about the run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    The time that the check run began.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (RequestableCheckStatusState)

    The current status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateCheckSuiteInput\n

    \n

    Autogenerated input type of CreateCheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headSha (GitObjectID!)

    The SHA of the head commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateContentAttachmentInput\n

    \n

    Autogenerated input type of CreateContentAttachment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body of the content attachment, which may contain markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentReferenceId (ID!)

    The node ID of the content_reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the content attachment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateDeploymentInput\n

    \n

    Autogenerated input type of CreateDeployment.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoMerge (Boolean)

    Attempt to automatically merge the default branch into the requested ref, defaults to true.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Short description of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    Name for the target deployment environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String)

    JSON payload with extra information about the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The node ID of the ref to be deployed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredContexts ([String!])

    The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    task (String)

    Specifies a task to execute.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateDeploymentStatusInput\n

    \n

    Autogenerated input type of CreateDeploymentStatus.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoInactive (Boolean)

    Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deploymentId (ID!)

    The node ID of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the status. Maximum length of 140 characters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environmentUrl (String)

    Sets the URL for accessing your environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logUrl (String)

    The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentStatusState!)

    The state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateEnterpriseOrganizationInput\n

    \n

    Autogenerated input type of CreateEnterpriseOrganization.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    adminLogins ([String!]!)

    The logins for the administrators of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    billingEmail (String!)

    The email used for sending billing receipts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise owning the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    profileName (String!)

    The profile name of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateIpAllowListEntryInput\n

    \n

    Autogenerated input type of CreateIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    An IP address or range of addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the IP allow list entry is active when an IP allow list is enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    An optional name for the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner for which to create the new IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateIssueInput\n

    \n

    Autogenerated input type of CreateIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    The Node ID for the user assignee for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The body for the issue description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueTemplate (String)

    The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title for the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateLabelInput\n

    \n

    Autogenerated input type of CreateLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    color (String!)

    A 6 character hex code, without the leading #, identifying the color of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of the label, such as its purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateProjectInput\n

    \n

    Autogenerated input type of CreateProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The owner ID to create the project under.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryIds ([ID!])

    A list of repository IDs to create as linked repositories for the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (ProjectTemplate)

    The name of the GitHub-provided template.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatePullRequestInput\n

    \n

    Autogenerated input type of CreatePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    baseRefName (String!)

    The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The contents of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    draft (Boolean)

    Indicates whether this pull request should be a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateRefInput\n

    \n

    Autogenerated input type of CreateRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The GitObjectID that the new Ref shall target. Must point to a commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the Repository to create the Ref in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateRepositoryInput\n

    \n

    Autogenerated input type of CreateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean)

    Indicates if the repository should have the issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean)

    Indicates if the repository should have the wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The URL for a web page about this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID)

    The ID of the owner for the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamId (ID)

    When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (Boolean)

    Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepositoryVisibility!)

    Indicates the repository's visibility level.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of CreateTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The content of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussionId (ID!)

    The ID of the discussion to which the comment belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateTeamDiscussionInput\n

    \n

    Autogenerated input type of CreateTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The content of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    private (Boolean)

    If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamId (ID!)

    The ID of the team to which the discussion belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteBranchProtectionRuleInput\n

    \n

    Autogenerated input type of DeleteBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branchProtectionRuleId (ID!)

    The global relay id of the branch protection rule to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteDeploymentInput\n

    \n

    Autogenerated input type of DeleteDeployment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the deployment to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIpAllowListEntryInput\n

    \n

    Autogenerated input type of DeleteIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntryId (ID!)

    The ID of the IP allow list entry to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIssueCommentInput\n

    \n

    Autogenerated input type of DeleteIssueComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIssueInput\n

    \n

    Autogenerated input type of DeleteIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteLabelInput\n

    \n

    Autogenerated input type of DeleteLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the label to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectCardInput\n

    \n

    Autogenerated input type of DeleteProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cardId (ID!)

    The id of the card to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectColumnInput\n

    \n

    Autogenerated input type of DeleteProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectInput\n

    \n

    Autogenerated input type of DeleteProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Project ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePullRequestReviewCommentInput\n

    \n

    Autogenerated input type of DeletePullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePullRequestReviewInput\n

    \n

    Autogenerated input type of DeletePullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteRefInput\n

    \n

    Autogenerated input type of DeleteRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The Node ID of the Ref to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of DeleteTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteTeamDiscussionInput\n

    \n

    Autogenerated input type of DeleteTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The discussion ID to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteVerifiableDomainInput\n

    \n

    Autogenerated input type of DeleteVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentOrder\n

    \n

    Ordering options for deployment connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (DeploymentOrderField!)

    The field to order deployments by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DisablePullRequestAutoMergeInput\n

    \n

    Autogenerated input type of DisablePullRequestAutoMerge.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to disable auto merge on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DismissPullRequestReviewInput\n

    \n

    Autogenerated input type of DismissPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    The contents of the pull request review dismissal message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DraftPullRequestReviewComment\n

    \n

    Specifies a review comment to be left with a Pull Request Review.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the comment to leave.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int!)

    Position in the file to leave a comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DraftPullRequestReviewThread\n

    \n

    Specifies a review comment thread to be left with a Pull Request Review.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the comment to leave.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    The line of the blob to which the thread refers. The end of the line range for multi-line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    side (DiffSide)

    The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The first line of the range to which the comment refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startSide (DiffSide)

    The side of the diff on which the start line resides.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnablePullRequestAutoMergeInput\n

    \n

    Autogenerated input type of EnablePullRequestAutoMerge.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod)

    The merge method to use. If omitted, defaults to 'MERGE'.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to enable auto-merge on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationOrder\n

    \n

    Ordering options for enterprise administrator invitation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseAdministratorInvitationOrderField!)

    The field to order enterprise administrator invitations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberOrder\n

    \n

    Ordering options for enterprise member connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseMemberOrderField!)

    The field to order enterprise members by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailOrder\n

    \n

    Ordering options for Enterprise Server user account email connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountEmailOrderField!)

    The field to order emails by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountOrder\n

    \n

    Ordering options for Enterprise Server user account connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountOrderField!)

    The field to order user accounts by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadOrder\n

    \n

    Ordering options for Enterprise Server user accounts upload connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountsUploadOrderField!)

    The field to order user accounts uploads by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowUserInput\n

    \n

    Autogenerated input type of FollowUser.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    ID of the user to follow.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n GistOrder\n

    \n

    Ordering options for gist connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (GistOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ImportProjectInput\n

    \n

    Autogenerated input type of ImportProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of Project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnImports ([ProjectColumnImport!]!)

    A list of columns containing issues and pull requests.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of Project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerName (String!)

    The name of the Organization or User to create the Project under.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    Whether the Project is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryOrder\n

    \n

    Ordering options for IP allow list entry connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IpAllowListEntryOrderField!)

    The field to order IP allow list entries by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentOrder\n

    \n

    Ways in which lists of issue comments can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order issue comments by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IssueCommentOrderField!)

    The field in which to order issue comments by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueFilters\n

    \n

    Ways in which to filter lists of issues.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignee (String)

    List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdBy (String)

    List issues created by given name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels ([String!])

    List issues where the list of label names exist on the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mentioned (String)

    List issues where the given name is mentioned in the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (String)

    List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    since (DateTime)

    List issues that have been updated at or after the given date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    states ([IssueState!])

    List issues filtered by the list of states given.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscribed (Boolean)

    List issues subscribed to by viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueOrder\n

    \n

    Ways in which lists of issues can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order issues by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IssueOrderField!)

    The field in which to order issues by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelOrder\n

    \n

    Ways in which lists of labels can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order labels by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (LabelOrderField!)

    The field in which to order labels by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageOrder\n

    \n

    Ordering options for language connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (LanguageOrderField!)

    The field to order languages by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LinkRepositoryToProjectInput\n

    \n

    Autogenerated input type of LinkRepositoryToProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The ID of the Project to link to a Repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the Repository to link to a Project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LockLockableInput\n

    \n

    Autogenerated input type of LockLockable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (LockReason)

    A reason for why the item will be locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockableId (ID!)

    ID of the item to be locked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkFileAsViewedInput\n

    \n

    Autogenerated input type of MarkFileAsViewed.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to mark as viewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkPullRequestReadyForReviewInput\n

    \n

    Autogenerated input type of MarkPullRequestReadyForReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be marked as ready for review.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MergeBranchInput\n

    \n

    Autogenerated input type of MergeBranch.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    base (String!)

    The name of the base branch that the provided head will be merged into.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitMessage (String)

    Message to use for the merge commit. If omitted, a default will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    head (String!)

    The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the Repository containing the base branch that will be modified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MergePullRequestInput\n

    \n

    Autogenerated input type of MergePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    Commit body to use for the merge commit; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    Commit headline to use for the merge commit; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expectedHeadOid (GitObjectID)

    OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod)

    The merge method to use. If omitted, defaults to 'MERGE'.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be merged.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneOrder\n

    \n

    Ordering options for milestone connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (MilestoneOrderField!)

    The field to order milestones by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MinimizeCommentInput\n

    \n

    Autogenerated input type of MinimizeComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    classifier (ReportedContentClassifiers!)

    The classification of comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MoveProjectCardInput\n

    \n

    Autogenerated input type of MoveProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterCardId (ID)

    Place the new card after the card with this id. Pass null to place it at the top.

    \n\n\n\n\n\n\n\n\n\n\n\n

    cardId (ID!)

    The id of the card to move.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to move it into.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MoveProjectColumnInput\n

    \n

    Autogenerated input type of MoveProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterColumnId (ID)

    Place the new column after the column with this id. Pass null to place it at the front.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to move.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationOrder\n

    \n

    Ordering options for organization connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (OrganizationOrderField!)

    The field to order organizations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PinIssueInput\n

    \n

    Autogenerated input type of PinIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to be pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardImport\n

    \n

    An issue or PR and its owning repository to be used in a project card.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    number (Int!)

    The issue or pull request number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (String!)

    Repository name with owner (owner/repository).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnImport\n

    \n

    A project column and a list of its issues and PRs.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    columnName (String!)

    The name of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues ([ProjectCardImport!])

    A list of issues and pull requests in the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int!)

    The position of the column, starting from 0.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectOrder\n

    \n

    Ways in which lists of projects can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order projects by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ProjectOrderField!)

    The field in which to order projects by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestOrder\n

    \n

    Ways in which lists of issues can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order pull requests by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PullRequestOrderField!)

    The field in which to order pull requests by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionOrder\n

    \n

    Ways in which lists of reactions can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order reactions by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ReactionOrderField!)

    The field in which to order reactions by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RefOrder\n

    \n

    Ways in which lists of git refs can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order refs by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RefOrderField!)

    The field in which to order refs by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RefUpdate\n

    \n

    A ref update.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterOid (GitObjectID!)

    The value this ref should be updated to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeOid (GitObjectID)

    The value this ref needs to point to before the update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    force (Boolean)

    Force a non fast-forward update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (GitRefname!)

    The fully qualified name of the ref to be update. For example refs/heads/branch-name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RegenerateVerifiableDomainTokenInput\n

    \n

    Autogenerated input type of RegenerateVerifiableDomainToken.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to regenerate the verification token of.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseOrder\n

    \n

    Ways in which lists of releases can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order releases by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ReleaseOrderField!)

    The field in which to order releases by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveAssigneesFromAssignableInput\n

    \n

    Autogenerated input type of RemoveAssigneesFromAssignable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableId (ID!)

    The id of the assignable object to remove assignees from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assigneeIds ([ID!]!)

    The id of users to remove as assignees.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseAdminInput\n

    \n

    Autogenerated input type of RemoveEnterpriseAdmin.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The Enterprise ID from which to remove the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user to remove as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveLabelsFromLabelableInput\n

    \n

    Autogenerated input type of RemoveLabelsFromLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!]!)

    The ids of labels to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the Labelable to remove labels from.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveOutsideCollaboratorInput\n

    \n

    Autogenerated input type of RemoveOutsideCollaborator.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID!)

    The ID of the organization to remove the outside collaborator from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    The ID of the outside collaborator to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveReactionInput\n

    \n

    Autogenerated input type of RemoveReaction.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ReactionContent!)

    The name of the emoji reaction to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveStarInput\n

    \n

    Autogenerated input type of RemoveStar.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starrableId (ID!)

    The Starrable ID to unstar.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenIssueInput\n

    \n

    Autogenerated input type of ReopenIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    ID of the issue to be opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenPullRequestInput\n

    \n

    Autogenerated input type of ReopenPullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be reopened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationOrder\n

    \n

    Ordering options for repository invitation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RepositoryInvitationOrderField!)

    The field to order repository invitations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryOrder\n

    \n

    Ordering options for repository connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RepositoryOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RequestReviewsInput\n

    \n

    Autogenerated input type of RequestReviews.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamIds ([ID!])

    The Node IDs of the team to request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    union (Boolean)

    Add users to the set rather than replace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userIds ([ID!])

    The Node IDs of the user to request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RerequestCheckSuiteInput\n

    \n

    Autogenerated input type of RerequestCheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    checkSuiteId (ID!)

    The Node ID of the check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ResolveReviewThreadInput\n

    \n

    Autogenerated input type of ResolveReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threadId (ID!)

    The ID of the thread to resolve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyOrder\n

    \n

    Ordering options for saved reply connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SavedReplyOrderField!)

    The field to order saved replies by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipOrder\n

    \n

    Ordering options for sponsorship connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n StarOrder\n

    \n

    Ways in which star connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (StarOrderField!)

    The field in which to order nodes by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmitPullRequestReviewInput\n

    \n

    Autogenerated input type of SubmitPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The text field to set on the Pull Request Review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    event (PullRequestReviewEvent!)

    The event to send to the Pull Request Review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The Pull Request ID to submit any pending reviews.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Pull Request Review ID to submit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentOrder\n

    \n

    Ways in which team discussion comment connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamDiscussionCommentOrderField!)

    The field by which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionOrder\n

    \n

    Ways in which team discussion connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamDiscussionOrderField!)

    The field by which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberOrder\n

    \n

    Ordering options for team member connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamMemberOrderField!)

    The field to order team members by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamOrder\n

    \n

    Ways in which team connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamOrderField!)

    The field in which to order nodes by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryOrder\n

    \n

    Ordering options for team repository connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamRepositoryOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TransferIssueInput\n

    \n

    Autogenerated input type of TransferIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The Node ID of the issue to be transferred.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository the issue should be transferred to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnarchiveRepositoryInput\n

    \n

    Autogenerated input type of UnarchiveRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to unarchive.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnfollowUserInput\n

    \n

    Autogenerated input type of UnfollowUser.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    ID of the user to unfollow.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlinkRepositoryFromProjectInput\n

    \n

    Autogenerated input type of UnlinkRepositoryFromProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The ID of the Project linked to the Repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the Repository linked to the Project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlockLockableInput\n

    \n

    Autogenerated input type of UnlockLockable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockableId (ID!)

    ID of the item to be unlocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkFileAsViewedInput\n

    \n

    Autogenerated input type of UnmarkFileAsViewed.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to mark as unviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkIssueAsDuplicateInput\n

    \n

    Autogenerated input type of UnmarkIssueAsDuplicate.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    canonicalId (ID!)

    ID of the issue or pull request currently considered canonical/authoritative/original.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicateId (ID!)

    ID of the issue or pull request currently marked as a duplicate.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnminimizeCommentInput\n

    \n

    Autogenerated input type of UnminimizeComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnpinIssueInput\n

    \n

    Autogenerated input type of UnpinIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to be unpinned.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnresolveReviewThreadInput\n

    \n

    Autogenerated input type of UnresolveReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threadId (ID!)

    The ID of the thread to unresolve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateBranchProtectionRuleInput\n

    \n

    Autogenerated input type of UpdateBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRuleId (ID!)

    The global relay id of the branch protection rule to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String)

    The glob-like pattern used to determine matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushActorIds ([ID!])

    A list of User, Team or App IDs allowed to push to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String!])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalActorIds ([ID!])

    A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateCheckRunInput\n

    \n

    Autogenerated input type of UpdateCheckRun.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actions ([CheckRunAction!])

    Possible further actions the integrator can perform, which a user may trigger.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkRunId (ID!)

    The node of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    The time that the check run finished.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The final conclusion of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL of the integrator's site that has the full details of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    output (CheckRunOutput)

    Descriptive details about the run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    The time that the check run began.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (RequestableCheckStatusState)

    The current status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateCheckSuitePreferencesInput\n

    \n

    Autogenerated input type of UpdateCheckSuitePreferences.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

    The check suite preferences to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the allow private repository forking setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the allow private repository forking setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the default repository permission setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

    The value for the default repository permission setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can change repository visibility setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can change repository visibility setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can create repositories setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateInternalRepositories (Boolean)

    Allow members to create internal repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePrivateRepositories (Boolean)

    Allow members to create private repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePublicRepositories (Boolean)

    Allow members to create public repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesPolicyEnabled (Boolean)

    When false, allow member organizations to set their own repository creation member privileges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

    Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can delete issues setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can delete issues setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can delete repositories setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can delete repositories setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can invite collaborators setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can invite collaborators setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can make purchases setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

    The value for the members can make purchases setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can update protected branches setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can update protected branches setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can view dependency insights setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can view dependency insights setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseOrganizationProjectsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the organization projects setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the organization projects setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseProfileInput\n

    \n

    Autogenerated input type of UpdateEnterpriseProfile.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The Enterprise ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The location of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (String)

    The URL of the enterprise's website.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseRepositoryProjectsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the repository projects setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the repository projects setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseTeamDiscussionsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the team discussions setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the team discussions setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the two factor authentication required setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledSettingValue!)

    The value for the two factor authentication required setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIpAllowListEnabledSettingInput\n

    \n

    Autogenerated input type of UpdateIpAllowListEnabledSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner on which to set the IP allow list enabled setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (IpAllowListEnabledSettingValue!)

    The value for the IP allow list enabled setting.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIpAllowListEntryInput\n

    \n

    Autogenerated input type of UpdateIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    An IP address or range of addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntryId (ID!)

    The ID of the IP allow list entry to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the IP allow list entry is active when an IP allow list is enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    An optional name for the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIssueCommentInput\n

    \n

    Autogenerated input type of UpdateIssueComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The updated text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the IssueComment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIssueInput\n

    \n

    Autogenerated input type of UpdateIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    An array of Node IDs of users for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The body for the issue description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the Issue to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (IssueState)

    The desired issue state.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title for the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateLabelInput\n

    \n

    Autogenerated input type of UpdateLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    color (String)

    A 6 character hex code, without the leading #, identifying the updated color of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of the label, such as its purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the label to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The updated name of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateNotificationRestrictionSettingInput\n

    \n

    Autogenerated input type of UpdateNotificationRestrictionSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner on which to set the restrict notifications setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (NotificationRestrictionSettingValue!)

    The value for the restrict notifications setting.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectCardInput\n

    \n

    Autogenerated input type of UpdateProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean)

    Whether or not the ProjectCard should be archived.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The note of ProjectCard.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCardId (ID!)

    The ProjectCard ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectColumnInput\n

    \n

    Autogenerated input type of UpdateProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of project column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectColumnId (ID!)

    The ProjectColumn ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectInput\n

    \n

    Autogenerated input type of UpdateProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Project ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    Whether the project is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectState)

    Whether the project is open or closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestInput\n

    \n

    Autogenerated input type of UpdatePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    An array of Node IDs of users for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String)

    The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The contents of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestUpdateState)

    The target state of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestReviewCommentInput\n

    \n

    Autogenerated input type of UpdatePullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewCommentId (ID!)

    The Node ID of the comment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestReviewInput\n

    \n

    Autogenerated input type of UpdatePullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The contents of the pull request review body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRefInput\n

    \n

    Autogenerated input type of UpdateRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    force (Boolean)

    Permit updates of branch Refs that are not fast-forwards?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The GitObjectID that the Ref shall be updated to target.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The Node ID of the Ref to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRefsInput\n

    \n

    Autogenerated input type of UpdateRefs.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refUpdates ([RefUpdate!]!)

    A list of ref updates.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRepositoryInput\n

    \n

    Autogenerated input type of UpdateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A new description for the repository. Pass an empty string to erase the existing description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean)

    Indicates if the repository should have the issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasProjectsEnabled (Boolean)

    Indicates if the repository should have the project boards feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean)

    Indicates if the repository should have the wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The URL for a web page about this repository. Pass an empty string to erase the existing URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The new name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (Boolean)

    Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateSubscriptionInput\n

    \n

    Autogenerated input type of UpdateSubscription.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (SubscriptionState!)

    The new state of the subscription.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribableId (ID!)

    The Node ID of the subscribable object to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of UpdateTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The updated text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String)

    The current version of the body content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamDiscussionInput\n

    \n

    Autogenerated input type of UpdateTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The updated text of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String)

    The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the discussion to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinned (Boolean)

    If provided, sets the pinned state of the updated discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The updated title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamReviewAssignmentInput\n

    \n

    Autogenerated input type of UpdateTeamReviewAssignment.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    algorithm (TeamReviewAssignmentAlgorithm)

    The algorithm to use for review assignment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabled (Boolean!)

    Turn on or off review assignment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    excludedTeamMemberIds ([ID!])

    An array of team member IDs to exclude.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the team to update review assignments of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notifyTeam (Boolean)

    Notify the entire team of the PR if it is delegated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamMemberCount (Int)

    The number of team members to assign.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTopicsInput\n

    \n

    Autogenerated input type of UpdateTopics.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicNames ([String!]!)

    An array of topic names.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusOrder\n

    \n

    Ordering options for user status connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (UserStatusOrderField!)

    The field to order user statuses by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainOrder\n

    \n

    Ordering options for verifiable domain connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (VerifiableDomainOrderField!)

    The field to order verifiable domains by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifyVerifiableDomainInput\n

    \n

    Autogenerated input type of VerifyVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to verify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n", + "html": "
    \n
    \n

    \n AddAssigneesToAssignableInput\n

    \n

    Autogenerated input type of AddAssigneesToAssignable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableId (ID!)

    The id of the assignable object to add assignees to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assigneeIds ([ID!]!)

    The id of users to add as assignees.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddCommentInput\n

    \n

    Autogenerated input type of AddComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The contents of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddEnterpriseAdminInput\n

    \n

    Autogenerated input type of AddEnterpriseAdmin.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise account to which the administrator should be added.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user to add as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddLabelsToLabelableInput\n

    \n

    Autogenerated input type of AddLabelsToLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!]!)

    The ids of the labels to add.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the labelable object to add labels to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddProjectCardInput\n

    \n

    Autogenerated input type of AddProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentId (ID)

    The content of the card. Must be a member of the ProjectCardItem union.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The note on the card.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectColumnId (ID!)

    The Node ID of the ProjectColumn.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddProjectColumnInput\n

    \n

    Autogenerated input type of AddProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Node ID of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewCommentInput\n

    \n

    Autogenerated input type of AddPullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOID (GitObjectID)

    The SHA of the commit to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    inReplyTo (ID)

    The comment id to reply to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String)

    The relative path of the file to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int)

    The line index in the diff to comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The node ID of the pull request reviewing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Node ID of the review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewInput\n

    \n

    Autogenerated input type of AddPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The contents of the review body comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    comments ([DraftPullRequestReviewComment])

    The review line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitOID (GitObjectID)

    The commit OID the review pertains to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    event (PullRequestReviewEvent)

    The event to perform on the pull request review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threads ([DraftPullRequestReviewThread])

    The review line comment threads.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddPullRequestReviewThreadInput\n

    \n

    Autogenerated input type of AddPullRequestReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the thread's first comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    The line of the blob to which the thread refers. The end of the line range for multi-line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The node ID of the pull request reviewing.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Node ID of the review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    side (DiffSide)

    The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The first line of the range to which the comment refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startSide (DiffSide)

    The side of the diff on which the start line resides.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddReactionInput\n

    \n

    Autogenerated input type of AddReaction.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ReactionContent!)

    The name of the emoji to react with.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddStarInput\n

    \n

    Autogenerated input type of AddStar.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starrableId (ID!)

    The Starrable ID to star.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AddVerifiableDomainInput\n

    \n

    Autogenerated input type of AddVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    domain (URI!)

    The URL of the domain.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner to add the domain to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ApproveVerifiableDomainInput\n

    \n

    Autogenerated input type of ApproveVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to approve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ArchiveRepositoryInput\n

    \n

    Autogenerated input type of ArchiveRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to mark as archived.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n AuditLogOrder\n

    \n

    Ordering options for Audit Log connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (AuditLogOrderField)

    The field to order Audit Logs by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ChangeUserStatusInput\n

    \n

    Autogenerated input type of ChangeUserStatus.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    emoji (String)

    The emoji to represent your status. Can either be a native Unicode emoji or an emoji name with colons, e.g., 😀.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expiresAt (DateTime)

    If set, the user status will not be shown after this date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    limitedAvailability (Boolean)

    Whether this status should indicate you are not fully available on GitHub, e.g., you are away.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String)

    A short description of your current status.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID)

    The ID of the organization whose members will be allowed to see the status. If\nomitted, the status will be publicly visible.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationData\n

    \n

    Information from a check run analysis to specific lines of code.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotationLevel (CheckAnnotationLevel!)

    Represents an annotation's information level.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (CheckAnnotationRange!)

    The location of the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    A short description of the feedback for these lines of code.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to add an annotation to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    rawDetails (String)

    Details about this annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title that represents the annotation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckAnnotationRange\n

    \n

    Information from a check run analysis to specific lines of code.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    endColumn (Int)

    The ending column of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    endLine (Int!)

    The ending line of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startColumn (Int)

    The starting column of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int!)

    The starting line of the range.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunAction\n

    \n

    Possible further actions the integrator can perform.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    description (String!)

    A short explanation of what this action would do.

    \n\n\n\n\n\n\n\n\n\n\n\n

    identifier (String!)

    A reference for the action on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    label (String!)

    The text to be displayed on a button in the web UI.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunFilter\n

    \n

    The filters that are available when fetching check runs.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (Int)

    Filters the check runs created by this application ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkName (String)

    Filters the check runs by this name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkType (CheckRunType)

    Filters the check runs by this type.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (CheckStatusState)

    Filters the check runs by this status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunOutput\n

    \n

    Descriptive details about the check run.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    annotations ([CheckAnnotationData!])

    The annotations that are made as part of the check run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    images ([CheckRunOutputImage!])

    Images attached to the check run output displayed in the GitHub pull request UI.

    \n\n\n\n\n\n\n\n\n\n\n\n

    summary (String!)

    The summary of the check run (supports Commonmark).

    \n\n\n\n\n\n\n\n\n\n\n\n

    text (String)

    The details of the check run (supports Commonmark).

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    A title to provide for this check run.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckRunOutputImage\n

    \n

    Images attached to the check run output displayed in the GitHub pull request UI.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    alt (String!)

    The alternative text for the image.

    \n\n\n\n\n\n\n\n\n\n\n\n

    caption (String)

    A short image description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    imageUrl (URI!)

    The full URL of the image.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteAutoTriggerPreference\n

    \n

    The auto-trigger preferences that are available for check suites.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (ID!)

    The node ID of the application that owns the check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    setting (Boolean!)

    Set to true to enable automatic creation of CheckSuite events upon pushes to the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CheckSuiteFilter\n

    \n

    The filters that are available when fetching check suites.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    appId (Int)

    Filters the check suites created by this application ID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkName (String)

    Filters the check suites by this name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ClearLabelsFromLabelableInput\n

    \n

    Autogenerated input type of ClearLabelsFromLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the labelable object to clear the labels from.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloneProjectInput\n

    \n

    Autogenerated input type of CloneProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includeWorkflows (Boolean!)

    Whether or not to clone the source project's workflows.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    The visibility of the project, defaults to false (private).

    \n\n\n\n\n\n\n\n\n\n\n\n

    sourceId (ID!)

    The source project to clone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    targetOwnerId (ID!)

    The owner ID to create the project under.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloneTemplateRepositoryInput\n

    \n

    Autogenerated input type of CloneTemplateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    includeAllBranches (Boolean)

    Whether to copy all branches from the template to the new repository. Defaults\nto copying only the default branch of the template.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner for the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the template repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepositoryVisibility!)

    Indicates the repository's visibility level.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CloseIssueInput\n

    \n

    Autogenerated input type of CloseIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    ID of the issue to be closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ClosePullRequestInput\n

    \n

    Autogenerated input type of ClosePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitAuthor\n

    \n

    Specifies an author for filtering Git commits.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    emails ([String!])

    Email addresses to filter by. Commits authored by any of the specified email addresses will be returned.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID)

    ID of a User to filter by. If non-null, only commits authored by this user\nwill be returned. This field takes precedence over emails.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CommitContributionOrder\n

    \n

    Ordering options for commit contribution connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (CommitContributionOrderField!)

    The field by which to order commit contributions.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ContributionOrder\n

    \n

    Ordering options for contribution connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ConvertProjectCardNoteToIssueInput\n

    \n

    Autogenerated input type of ConvertProjectCardNoteToIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The body of the newly created issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCardId (ID!)

    The ProjectCard ID to convert.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to create the issue in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title of the newly created issue. Defaults to the card's note text.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateBranchProtectionRuleInput\n

    \n

    Autogenerated input type of CreateBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String!)

    The glob-like pattern used to determine matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushActorIds ([ID!])

    A list of User, Team or App IDs allowed to push to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The global relay id of the repository in which a new branch protection rule should be created in.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String!])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalActorIds ([ID!])

    A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateCheckRunInput\n

    \n

    Autogenerated input type of CreateCheckRun.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actions ([CheckRunAction!])

    Possible further actions the integrator can perform, which a user may trigger.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    The time that the check run finished.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The final conclusion of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL of the integrator's site that has the full details of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headSha (GitObjectID!)

    The SHA of the head commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    output (CheckRunOutput)

    Descriptive details about the run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    The time that the check run began.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (RequestableCheckStatusState)

    The current status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateCheckSuiteInput\n

    \n

    Autogenerated input type of CreateCheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headSha (GitObjectID!)

    The SHA of the head commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateContentAttachmentInput\n

    \n

    Autogenerated input type of CreateContentAttachment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The body of the content attachment, which may contain markdown.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    contentReferenceId (ID!)

    The node ID of the content_reference.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the content attachment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateDeploymentInput\n

    \n

    Autogenerated input type of CreateDeployment.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateDeploymentInput is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoMerge (Boolean)

    Attempt to automatically merge the default branch into the requested ref, defaults to true.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    Short description of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    Name for the target deployment environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    payload (String)

    JSON payload with extra information about the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The node ID of the ref to be deployed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredContexts ([String!])

    The status contexts to verify against commit status checks. To bypass required\ncontexts, pass an empty array. Defaults to all unique contexts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    task (String)

    Specifies a task to execute.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateDeploymentStatusInput\n

    \n

    Autogenerated input type of CreateDeploymentStatus.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateDeploymentStatusInput is available under the Deployments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoInactive (Boolean)

    Adds a new inactive status to all non-transient, non-production environment\ndeployments with the same repository and environment name as the created\nstatus's deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    deploymentId (ID!)

    The node ID of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the status. Maximum length of 140 characters.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environment (String)

    If provided, updates the environment of the deploy. Otherwise, does not modify the environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    environmentUrl (String)

    Sets the URL for accessing your environment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    logUrl (String)

    The log URL to associate with this status. This URL should contain\noutput to keep the user updated while the task is running or serve as\nhistorical information for what happened in the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (DeploymentStatusState!)

    The state of the deployment.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateEnterpriseOrganizationInput\n

    \n

    Autogenerated input type of CreateEnterpriseOrganization.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    adminLogins ([String!]!)

    The logins for the administrators of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    billingEmail (String!)

    The email used for sending billing receipts.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise owning the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n

    profileName (String!)

    The profile name of the new organization.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateIpAllowListEntryInput\n

    \n

    Autogenerated input type of CreateIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    An IP address or range of addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the IP allow list entry is active when an IP allow list is enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    An optional name for the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner for which to create the new IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateIssueInput\n

    \n

    Autogenerated input type of CreateIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    The Node ID for the user assignee for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The body for the issue description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueTemplate (String)

    The name of an issue template in the repository, assigns labels and assignees from the template to the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title for the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateLabelInput\n

    \n

    Autogenerated input type of CreateLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    CreateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    color (String!)

    A 6 character hex code, without the leading #, identifying the color of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of the label, such as its purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateProjectInput\n

    \n

    Autogenerated input type of CreateProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The owner ID to create the project under.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryIds ([ID!])

    A list of repository IDs to create as linked repositories for the project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (ProjectTemplate)

    The name of the GitHub-provided template.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreatePullRequestInput\n

    \n

    Autogenerated input type of CreatePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    baseRefName (String!)

    The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository. You cannot update the base branch on a pull request to point\nto another repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The contents of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    draft (Boolean)

    Indicates whether this pull request should be a draft.

    \n\n\n\n\n\n\n\n\n\n\n\n

    headRefName (String!)

    The name of the branch where your changes are implemented. For cross-repository pull requests\nin the same network, namespace head_ref_name with a user like this: username:branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateRefInput\n

    \n

    Autogenerated input type of CreateRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The fully qualified name of the new Ref (ie: refs/heads/my_new_branch).

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The GitObjectID that the new Ref shall target. Must point to a commit.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the Repository to create the Ref in.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateRepositoryInput\n

    \n

    Autogenerated input type of CreateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A short description of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean)

    Indicates if the repository should have the issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean)

    Indicates if the repository should have the wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The URL for a web page about this repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID)

    The ID of the owner for the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamId (ID)

    When an organization is specified as the owner, this ID identifies the team\nthat should be granted access to the new repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (Boolean)

    Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

    \n\n\n\n\n\n\n\n\n\n\n\n

    visibility (RepositoryVisibility!)

    Indicates the repository's visibility level.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of CreateTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The content of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    discussionId (ID!)

    The ID of the discussion to which the comment belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n CreateTeamDiscussionInput\n

    \n

    Autogenerated input type of CreateTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The content of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    private (Boolean)

    If true, restricts the visibility of this discussion to team members and\norganization admins. If false or not specified, allows any organization member\nto view this discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamId (ID!)

    The ID of the team to which the discussion belongs.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String!)

    The title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteBranchProtectionRuleInput\n

    \n

    Autogenerated input type of DeleteBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    branchProtectionRuleId (ID!)

    The global relay id of the branch protection rule to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteDeploymentInput\n

    \n

    Autogenerated input type of DeleteDeployment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the deployment to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIpAllowListEntryInput\n

    \n

    Autogenerated input type of DeleteIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntryId (ID!)

    The ID of the IP allow list entry to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIssueCommentInput\n

    \n

    Autogenerated input type of DeleteIssueComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteIssueInput\n

    \n

    Autogenerated input type of DeleteIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteLabelInput\n

    \n

    Autogenerated input type of DeleteLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    DeleteLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the label to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectCardInput\n

    \n

    Autogenerated input type of DeleteProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    cardId (ID!)

    The id of the card to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectColumnInput\n

    \n

    Autogenerated input type of DeleteProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteProjectInput\n

    \n

    Autogenerated input type of DeleteProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Project ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePullRequestReviewCommentInput\n

    \n

    Autogenerated input type of DeletePullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeletePullRequestReviewInput\n

    \n

    Autogenerated input type of DeletePullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteRefInput\n

    \n

    Autogenerated input type of DeleteRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The Node ID of the Ref to be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of DeleteTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteTeamDiscussionInput\n

    \n

    Autogenerated input type of DeleteTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The discussion ID to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeleteVerifiableDomainInput\n

    \n

    Autogenerated input type of DeleteVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to delete.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DeploymentOrder\n

    \n

    Ordering options for deployment connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (DeploymentOrderField!)

    The field to order deployments by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DisablePullRequestAutoMergeInput\n

    \n

    Autogenerated input type of DisablePullRequestAutoMerge.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to disable auto merge on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DismissPullRequestReviewInput\n

    \n

    Autogenerated input type of DismissPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    message (String!)

    The contents of the pull request review dismissal message.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DraftPullRequestReviewComment\n

    \n

    Specifies a review comment to be left with a Pull Request Review.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the comment to leave.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int!)

    Position in the file to leave a comment on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n DraftPullRequestReviewThread\n

    \n

    Specifies a review comment thread to be left with a Pull Request Review.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    Body of the comment to leave.

    \n\n\n\n\n\n\n\n\n\n\n\n

    line (Int!)

    The line of the blob to which the thread refers. The end of the line range for multi-line comments.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    Path to the file being commented on.

    \n\n\n\n\n\n\n\n\n\n\n\n

    side (DiffSide)

    The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startLine (Int)

    The first line of the range to which the comment refers.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startSide (DiffSide)

    The side of the diff on which the start line resides.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnablePullRequestAutoMergeInput\n

    \n

    Autogenerated input type of EnablePullRequestAutoMerge.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    Commit body to use for the commit when the PR is mergable; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    Commit headline to use for the commit when the PR is mergable; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod)

    The merge method to use. If omitted, defaults to 'MERGE'.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to enable auto-merge on.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseAdministratorInvitationOrder\n

    \n

    Ordering options for enterprise administrator invitation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseAdministratorInvitationOrderField!)

    The field to order enterprise administrator invitations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseMemberOrder\n

    \n

    Ordering options for enterprise member connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseMemberOrderField!)

    The field to order enterprise members by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountEmailOrder\n

    \n

    Ordering options for Enterprise Server user account email connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountEmailOrderField!)

    The field to order emails by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountOrder\n

    \n

    Ordering options for Enterprise Server user account connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountOrderField!)

    The field to order user accounts by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n EnterpriseServerUserAccountsUploadOrder\n

    \n

    Ordering options for Enterprise Server user accounts upload connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (EnterpriseServerUserAccountsUploadOrderField!)

    The field to order user accounts uploads by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n FollowUserInput\n

    \n

    Autogenerated input type of FollowUser.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    ID of the user to follow.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n GistOrder\n

    \n

    Ordering options for gist connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (GistOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ImportProjectInput\n

    \n

    Autogenerated input type of ImportProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of Project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnImports ([ProjectColumnImport!]!)

    A list of columns containing issues and pull requests.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of Project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerName (String!)

    The name of the Organization or User to create the Project under.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    Whether the Project is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IpAllowListEntryOrder\n

    \n

    Ordering options for IP allow list entry connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IpAllowListEntryOrderField!)

    The field to order IP allow list entries by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueCommentOrder\n

    \n

    Ways in which lists of issue comments can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order issue comments by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IssueCommentOrderField!)

    The field in which to order issue comments by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueFilters\n

    \n

    Ways in which to filter lists of issues.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignee (String)

    List issues assigned to given name. Pass in null for issues with no assigned\nuser, and * for issues assigned to any user.

    \n\n\n\n\n\n\n\n\n\n\n\n

    createdBy (String)

    List issues created by given name.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labels ([String!])

    List issues where the list of label names exist on the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mentioned (String)

    List issues where the given name is mentioned in the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestone (String)

    List issues by given milestone argument. If an string representation of an\ninteger is passed, it should refer to a milestone by its number field. Pass in\nnull for issues with no milestone, and * for issues that are assigned to any milestone.

    \n\n\n\n\n\n\n\n\n\n\n\n

    since (DateTime)

    List issues that have been updated at or after the given date.

    \n\n\n\n\n\n\n\n\n\n\n\n

    states ([IssueState!])

    List issues filtered by the list of states given.

    \n\n\n\n\n\n\n\n\n\n\n\n

    viewerSubscribed (Boolean)

    List issues subscribed to by viewer.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n IssueOrder\n

    \n

    Ways in which lists of issues can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order issues by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (IssueOrderField!)

    The field in which to order issues by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LabelOrder\n

    \n

    Ways in which lists of labels can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order labels by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (LabelOrderField!)

    The field in which to order labels by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LanguageOrder\n

    \n

    Ordering options for language connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (LanguageOrderField!)

    The field to order languages by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LinkRepositoryToProjectInput\n

    \n

    Autogenerated input type of LinkRepositoryToProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The ID of the Project to link to a Repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the Repository to link to a Project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n LockLockableInput\n

    \n

    Autogenerated input type of LockLockable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockReason (LockReason)

    A reason for why the item will be locked.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockableId (ID!)

    ID of the item to be locked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkFileAsViewedInput\n

    \n

    Autogenerated input type of MarkFileAsViewed.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to mark as viewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MarkPullRequestReadyForReviewInput\n

    \n

    Autogenerated input type of MarkPullRequestReadyForReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be marked as ready for review.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MergeBranchInput\n

    \n

    Autogenerated input type of MergeBranch.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    base (String!)

    The name of the base branch that the provided head will be merged into.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitMessage (String)

    Message to use for the merge commit. If omitted, a default will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    head (String!)

    The head to merge into the base branch. This can be a branch name or a commit GitObjectID.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the Repository containing the base branch that will be modified.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MergePullRequestInput\n

    \n

    Autogenerated input type of MergePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    authorEmail (String)

    The email address to associate with this merge.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitBody (String)

    Commit body to use for the merge commit; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    commitHeadline (String)

    Commit headline to use for the merge commit; if omitted, a default message will be used.

    \n\n\n\n\n\n\n\n\n\n\n\n

    expectedHeadOid (GitObjectID)

    OID that the pull request head ref must match to allow merge; if omitted, no check is performed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    mergeMethod (PullRequestMergeMethod)

    The merge method to use. If omitted, defaults to 'MERGE'.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be merged.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MilestoneOrder\n

    \n

    Ordering options for milestone connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (MilestoneOrderField!)

    The field to order milestones by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MinimizeCommentInput\n

    \n

    Autogenerated input type of MinimizeComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    classifier (ReportedContentClassifiers!)

    The classification of comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MoveProjectCardInput\n

    \n

    Autogenerated input type of MoveProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterCardId (ID)

    Place the new card after the card with this id. Pass null to place it at the top.

    \n\n\n\n\n\n\n\n\n\n\n\n

    cardId (ID!)

    The id of the card to move.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to move it into.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n MoveProjectColumnInput\n

    \n

    Autogenerated input type of MoveProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterColumnId (ID)

    Place the new column after the column with this id. Pass null to place it at the front.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    columnId (ID!)

    The id of the column to move.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n OrganizationOrder\n

    \n

    Ordering options for organization connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (OrganizationOrderField!)

    The field to order organizations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PinIssueInput\n

    \n

    Autogenerated input type of PinIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to be pinned.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectCardImport\n

    \n

    An issue or PR and its owning repository to be used in a project card.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    number (Int!)

    The issue or pull request number.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repository (String!)

    Repository name with owner (owner/repository).

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectColumnImport\n

    \n

    A project column and a list of its issues and PRs.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    columnName (String!)

    The name of the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issues ([ProjectCardImport!])

    A list of issues and pull requests in the column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    position (Int!)

    The position of the column, starting from 0.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ProjectOrder\n

    \n

    Ways in which lists of projects can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order projects by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ProjectOrderField!)

    The field in which to order projects by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n PullRequestOrder\n

    \n

    Ways in which lists of issues can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order pull requests by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (PullRequestOrderField!)

    The field in which to order pull requests by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReactionOrder\n

    \n

    Ways in which lists of reactions can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order reactions by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ReactionOrderField!)

    The field in which to order reactions by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RefOrder\n

    \n

    Ways in which lists of git refs can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order refs by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RefOrderField!)

    The field in which to order refs by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RefUpdate\n

    \n

    A ref update.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    RefUpdate is available under the Update refs preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    afterOid (GitObjectID!)

    The value this ref should be updated to.

    \n\n\n\n\n\n\n\n\n\n\n\n

    beforeOid (GitObjectID)

    The value this ref needs to point to before the update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    force (Boolean)

    Force a non fast-forward update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (GitRefname!)

    The fully qualified name of the ref to be update. For example refs/heads/branch-name.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RegenerateVerifiableDomainTokenInput\n

    \n

    Autogenerated input type of RegenerateVerifiableDomainToken.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to regenerate the verification token of.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReleaseOrder\n

    \n

    Ways in which lists of releases can be ordered upon return.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order releases by the specified field.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (ReleaseOrderField!)

    The field in which to order releases by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveAssigneesFromAssignableInput\n

    \n

    Autogenerated input type of RemoveAssigneesFromAssignable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assignableId (ID!)

    The id of the assignable object to remove assignees from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    assigneeIds ([ID!]!)

    The id of users to remove as assignees.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveEnterpriseAdminInput\n

    \n

    Autogenerated input type of RemoveEnterpriseAdmin.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The Enterprise ID from which to remove the administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n

    login (String!)

    The login of the user to remove as an administrator.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveLabelsFromLabelableInput\n

    \n

    Autogenerated input type of RemoveLabelsFromLabelable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!]!)

    The ids of labels to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelableId (ID!)

    The id of the Labelable to remove labels from.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveOutsideCollaboratorInput\n

    \n

    Autogenerated input type of RemoveOutsideCollaborator.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    organizationId (ID!)

    The ID of the organization to remove the outside collaborator from.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    The ID of the outside collaborator to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveReactionInput\n

    \n

    Autogenerated input type of RemoveReaction.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    content (ReactionContent!)

    The name of the emoji reaction to remove.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RemoveStarInput\n

    \n

    Autogenerated input type of RemoveStar.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    starrableId (ID!)

    The Starrable ID to unstar.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenIssueInput\n

    \n

    Autogenerated input type of ReopenIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    ID of the issue to be opened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ReopenPullRequestInput\n

    \n

    Autogenerated input type of ReopenPullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    ID of the pull request to be reopened.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryInvitationOrder\n

    \n

    Ordering options for repository invitation connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RepositoryInvitationOrderField!)

    The field to order repository invitations by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RepositoryOrder\n

    \n

    Ordering options for repository connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (RepositoryOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RequestReviewsInput\n

    \n

    Autogenerated input type of RequestReviews.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamIds ([ID!])

    The Node IDs of the team to request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    union (Boolean)

    Add users to the set rather than replace.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userIds ([ID!])

    The Node IDs of the user to request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n RerequestCheckSuiteInput\n

    \n

    Autogenerated input type of RerequestCheckSuite.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    checkSuiteId (ID!)

    The Node ID of the check suite.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n ResolveReviewThreadInput\n

    \n

    Autogenerated input type of ResolveReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threadId (ID!)

    The ID of the thread to resolve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SavedReplyOrder\n

    \n

    Ordering options for saved reply connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (SavedReplyOrderField!)

    The field to order saved replies by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SponsorshipOrder\n

    \n

    Ordering options for sponsorship connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n StarOrder\n

    \n

    Ways in which star connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (StarOrderField!)

    The field in which to order nodes by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n SubmitPullRequestReviewInput\n

    \n

    Autogenerated input type of SubmitPullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The text field to set on the Pull Request Review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    event (PullRequestReviewEvent!)

    The event to send to the Pull Request Review.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID)

    The Pull Request ID to submit any pending reviews.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID)

    The Pull Request Review ID to submit.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionCommentOrder\n

    \n

    Ways in which team discussion comment connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamDiscussionCommentOrderField!)

    The field by which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamDiscussionOrder\n

    \n

    Ways in which team discussion connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamDiscussionOrderField!)

    The field by which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamMemberOrder\n

    \n

    Ordering options for team member connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamMemberOrderField!)

    The field to order team members by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamOrder\n

    \n

    Ways in which team connections can be ordered.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The direction in which to order nodes.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamOrderField!)

    The field in which to order nodes by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TeamRepositoryOrder\n

    \n

    Ordering options for team repository connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (TeamRepositoryOrderField!)

    The field to order repositories by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n TransferIssueInput\n

    \n

    Autogenerated input type of TransferIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The Node ID of the issue to be transferred.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository the issue should be transferred to.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnarchiveRepositoryInput\n

    \n

    Autogenerated input type of UnarchiveRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to unarchive.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnfollowUserInput\n

    \n

    Autogenerated input type of UnfollowUser.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    userId (ID!)

    ID of the user to unfollow.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlinkRepositoryFromProjectInput\n

    \n

    Autogenerated input type of UnlinkRepositoryFromProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The ID of the Project linked to the Repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the Repository linked to the Project.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnlockLockableInput\n

    \n

    Autogenerated input type of UnlockLockable.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    lockableId (ID!)

    ID of the item to be unlocked.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkFileAsViewedInput\n

    \n

    Autogenerated input type of UnmarkFileAsViewed.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    path (String!)

    The path of the file to mark as unviewed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnmarkIssueAsDuplicateInput\n

    \n

    Autogenerated input type of UnmarkIssueAsDuplicate.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    canonicalId (ID!)

    ID of the issue or pull request currently considered canonical/authoritative/original.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    duplicateId (ID!)

    ID of the issue or pull request currently marked as a duplicate.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnminimizeCommentInput\n

    \n

    Autogenerated input type of UnminimizeComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subjectId (ID!)

    The Node ID of the subject to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnpinIssueInput\n

    \n

    Autogenerated input type of UnpinIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    issueId (ID!)

    The ID of the issue to be unpinned.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UnresolveReviewThreadInput\n

    \n

    Autogenerated input type of UnresolveReviewThread.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    threadId (ID!)

    The ID of the thread to unresolve.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateBranchProtectionRuleInput\n

    \n

    Autogenerated input type of UpdateBranchProtectionRule.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowsDeletions (Boolean)

    Can this branch be deleted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    allowsForcePushes (Boolean)

    Are force pushes allowed on this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    branchProtectionRuleId (ID!)

    The global relay id of the branch protection rule to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    dismissesStaleReviews (Boolean)

    Will new commits pushed to matching branches dismiss pull request review approvals.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isAdminEnforced (Boolean)

    Can admins overwrite branch protection.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pattern (String)

    The glob-like pattern used to determine matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pushActorIds ([ID!])

    A list of User, Team or App IDs allowed to push to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredApprovingReviewCount (Int)

    Number of approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiredStatusCheckContexts ([String!])

    List of required status check contexts that must pass for commits to be accepted to matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresApprovingReviews (Boolean)

    Are approving reviews required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCodeOwnerReviews (Boolean)

    Are reviews from code owners required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresCommitSignatures (Boolean)

    Are commits required to be signed.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresLinearHistory (Boolean)

    Are merge commits prohibited from being pushed to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStatusChecks (Boolean)

    Are status checks required to update matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n

    requiresStrictStatusChecks (Boolean)

    Are branches required to be up to date before merging.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsPushes (Boolean)

    Is pushing to matching branches restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    restrictsReviewDismissals (Boolean)

    Is dismissal of pull request reviews restricted.

    \n\n\n\n\n\n\n\n\n\n\n\n

    reviewDismissalActorIds ([ID!])

    A list of User or Team IDs allowed to dismiss reviews on pull requests targeting matching branches.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateCheckRunInput\n

    \n

    Autogenerated input type of UpdateCheckRun.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    actions ([CheckRunAction!])

    Possible further actions the integrator can perform, which a user may trigger.

    \n\n\n\n\n\n\n\n\n\n\n\n

    checkRunId (ID!)

    The node of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    completedAt (DateTime)

    The time that the check run finished.

    \n\n\n\n\n\n\n\n\n\n\n\n

    conclusion (CheckConclusionState)

    The final conclusion of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    detailsUrl (URI)

    The URL of the integrator's site that has the full details of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    externalId (String)

    A reference for the run on the integrator's system.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the check.

    \n\n\n\n\n\n\n\n\n\n\n\n

    output (CheckRunOutput)

    Descriptive details about the run.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    startedAt (DateTime)

    The time that the check run began.

    \n\n\n\n\n\n\n\n\n\n\n\n

    status (RequestableCheckStatusState)

    The current status.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateCheckSuitePreferencesInput\n

    \n

    Autogenerated input type of UpdateCheckSuitePreferences.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    autoTriggerPreferences ([CheckSuiteAutoTriggerPreference!]!)

    The check suite preferences to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseAllowPrivateRepositoryForkingSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the allow private repository forking setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the allow private repository forking setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseDefaultRepositoryPermissionSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseDefaultRepositoryPermissionSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the default repository permission setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseDefaultRepositoryPermissionSettingValue!)

    The value for the default repository permission setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can change repository visibility setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can change repository visibility setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanCreateRepositoriesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanCreateRepositoriesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can create repositories setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateInternalRepositories (Boolean)

    Allow members to create internal repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePrivateRepositories (Boolean)

    Allow members to create private repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreatePublicRepositories (Boolean)

    Allow members to create public repositories. Defaults to current value.

    \n\n\n\n\n\n\n\n\n\n\n\n

    membersCanCreateRepositoriesPolicyEnabled (Boolean)

    When false, allow member organizations to set their own repository creation member privileges.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseMembersCanCreateRepositoriesSettingValue)

    Value for the members can create repositories setting on the enterprise. This\nor the granular public/private/internal allowed fields (but not both) must be provided.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanDeleteIssuesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanDeleteIssuesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can delete issues setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can delete issues setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanDeleteRepositoriesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can delete repositories setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can delete repositories setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanInviteCollaboratorsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can invite collaborators setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can invite collaborators setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanMakePurchasesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanMakePurchasesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can make purchases setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseMembersCanMakePurchasesSettingValue!)

    The value for the members can make purchases setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can update protected branches setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can update protected branches setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseMembersCanViewDependencyInsightsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the members can view dependency insights setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the members can view dependency insights setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseOrganizationProjectsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseOrganizationProjectsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the organization projects setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the organization projects setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseProfileInput\n

    \n

    Autogenerated input type of UpdateEnterpriseProfile.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    The description of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The Enterprise ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    location (String)

    The location of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n

    websiteUrl (String)

    The URL of the enterprise's website.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseRepositoryProjectsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseRepositoryProjectsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the repository projects setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the repository projects setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseTeamDiscussionsSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseTeamDiscussionsSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the team discussions setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledDisabledSettingValue!)

    The value for the team discussions setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput\n

    \n

    Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enterpriseId (ID!)

    The ID of the enterprise on which to set the two factor authentication required setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (EnterpriseEnabledSettingValue!)

    The value for the two factor authentication required setting on the enterprise.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIpAllowListEnabledSettingInput\n

    \n

    Autogenerated input type of UpdateIpAllowListEnabledSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner on which to set the IP allow list enabled setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (IpAllowListEnabledSettingValue!)

    The value for the IP allow list enabled setting.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIpAllowListEntryInput\n

    \n

    Autogenerated input type of UpdateIpAllowListEntry.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    allowListValue (String!)

    An IP address or range of addresses in CIDR notation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ipAllowListEntryId (ID!)

    The ID of the IP allow list entry to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isActive (Boolean!)

    Whether the IP allow list entry is active when an IP allow list is enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    An optional name for the IP allow list entry.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIssueCommentInput\n

    \n

    Autogenerated input type of UpdateIssueComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The updated text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the IssueComment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateIssueInput\n

    \n

    Autogenerated input type of UpdateIssue.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    An array of Node IDs of users for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The body for the issue description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the Issue to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this issue.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (IssueState)

    The desired issue state.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title for the issue.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateLabelInput\n

    \n

    Autogenerated input type of UpdateLabel.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateLabelInput is available under the Labels preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    color (String)

    A 6 character hex code, without the leading #, identifying the updated color of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A brief description of the label, such as its purpose.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the label to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The updated name of the label.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateNotificationRestrictionSettingInput\n

    \n

    Autogenerated input type of UpdateNotificationRestrictionSetting.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    ownerId (ID!)

    The ID of the owner on which to set the restrict notifications setting.

    \n\n\n\n\n\n\n\n\n\n\n\n

    settingValue (NotificationRestrictionSettingValue!)

    The value for the restrict notifications setting.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectCardInput\n

    \n

    Autogenerated input type of UpdateProjectCard.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    isArchived (Boolean)

    Whether or not the ProjectCard should be archived.

    \n\n\n\n\n\n\n\n\n\n\n\n

    note (String)

    The note of ProjectCard.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectCardId (ID!)

    The ProjectCard ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectColumnInput\n

    \n

    Autogenerated input type of UpdateProjectColumn.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String!)

    The name of project column.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectColumnId (ID!)

    The ProjectColumn ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateProjectInput\n

    \n

    Autogenerated input type of UpdateProject.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The description of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The name of project.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectId (ID!)

    The Project ID to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    public (Boolean)

    Whether the project is public or not.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (ProjectState)

    Whether the project is open or closed.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestInput\n

    \n

    Autogenerated input type of UpdatePullRequest.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    assigneeIds ([ID!])

    An array of Node IDs of users for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    baseRefName (String)

    The name of the branch you want your changes pulled into. This should be an existing branch\non the current repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    body (String)

    The contents of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    labelIds ([ID!])

    An array of Node IDs of labels for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    maintainerCanModify (Boolean)

    Indicates whether maintainers can modify the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    milestoneId (ID)

    The Node ID of the milestone for this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    projectIds ([ID!])

    An array of Node IDs for projects associated with this pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestId (ID!)

    The Node ID of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (PullRequestUpdateState)

    The target state of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The title of the pull request.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestReviewCommentInput\n

    \n

    Autogenerated input type of UpdatePullRequestReviewComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewCommentId (ID!)

    The Node ID of the comment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdatePullRequestReviewInput\n

    \n

    Autogenerated input type of UpdatePullRequestReview.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The contents of the pull request review body.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pullRequestReviewId (ID!)

    The Node ID of the pull request review to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRefInput\n

    \n

    Autogenerated input type of UpdateRef.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    force (Boolean)

    Permit updates of branch Refs that are not fast-forwards?.

    \n\n\n\n\n\n\n\n\n\n\n\n

    oid (GitObjectID!)

    The GitObjectID that the Ref shall be updated to target.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refId (ID!)

    The Node ID of the Ref to be updated.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRefsInput\n

    \n

    Autogenerated input type of UpdateRefs.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateRefsInput is available under the Update refs preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    refUpdates ([RefUpdate!]!)

    A list of ref updates.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateRepositoryInput\n

    \n

    Autogenerated input type of UpdateRepository.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    description (String)

    A new description for the repository. Pass an empty string to erase the existing description.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasIssuesEnabled (Boolean)

    Indicates if the repository should have the issues feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasProjectsEnabled (Boolean)

    Indicates if the repository should have the project boards feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    hasWikiEnabled (Boolean)

    Indicates if the repository should have the wiki feature enabled.

    \n\n\n\n\n\n\n\n\n\n\n\n

    homepageUrl (URI)

    The URL for a web page about this repository. Pass an empty string to erase the existing URL.

    \n\n\n\n\n\n\n\n\n\n\n\n

    name (String)

    The new name of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The ID of the repository to update.

    \n\n\n\n\n\n\n\n\n\n\n\n

    template (Boolean)

    Whether this repository should be marked as a template such that anyone who\ncan access it can create new repositories with the same files and directory structure.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateSubscriptionInput\n

    \n

    Autogenerated input type of UpdateSubscription.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    state (SubscriptionState!)

    The new state of the subscription.

    \n\n\n\n\n\n\n\n\n\n\n\n

    subscribableId (ID!)

    The Node ID of the subscribable object to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamDiscussionCommentInput\n

    \n

    Autogenerated input type of UpdateTeamDiscussionComment.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String!)

    The updated text of the comment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String)

    The current version of the body content.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the comment to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamDiscussionInput\n

    \n

    Autogenerated input type of UpdateTeamDiscussion.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    body (String)

    The updated text of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    bodyVersion (String)

    The current version of the body content. If provided, this update operation\nwill be rejected if the given version does not match the latest version on the server.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the discussion to modify.

    \n\n\n\n\n\n\n\n\n\n\n\n

    pinned (Boolean)

    If provided, sets the pinned state of the updated discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n

    title (String)

    The updated title of the discussion.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTeamReviewAssignmentInput\n

    \n

    Autogenerated input type of UpdateTeamReviewAssignment.

    \n
    \n\n
    \n \n
    \n

    Preview notice

    \n

    UpdateTeamReviewAssignmentInput is available under the Team review assignments preview. During the preview period, the API may change without notice.

    \n
    \n\n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    algorithm (TeamReviewAssignmentAlgorithm)

    The algorithm to use for review assignment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    enabled (Boolean!)

    Turn on or off review assignment.

    \n\n\n\n\n\n\n\n\n\n\n\n

    excludedTeamMemberIds ([ID!])

    An array of team member IDs to exclude.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The Node ID of the team to update review assignments of.

    \n\n\n\n\n\n\n\n\n\n\n\n

    notifyTeam (Boolean)

    Notify the entire team of the PR if it is delegated.

    \n\n\n\n\n\n\n\n\n\n\n\n

    teamMemberCount (Int)

    The number of team members to assign.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UpdateTopicsInput\n

    \n

    Autogenerated input type of UpdateTopics.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    repositoryId (ID!)

    The Node ID of the repository.

    \n\n\n\n\n\n\n\n\n\n\n\n

    topicNames ([String!]!)

    An array of topic names.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n UserStatusOrder\n

    \n

    Ordering options for user status connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (UserStatusOrderField!)

    The field to order user statuses by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifiableDomainOrder\n

    \n

    Ordering options for verifiable domain connections.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    direction (OrderDirection!)

    The ordering direction.

    \n\n\n\n\n\n\n\n\n\n\n\n

    field (VerifiableDomainOrderField!)

    The field to order verifiable domains by.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n\n
    \n
    \n

    \n VerifyVerifiableDomainInput\n

    \n

    Autogenerated input type of VerifyVerifiableDomain.

    \n
    \n\n
    \n \n\n \n\n\n

    Input fields

    \n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    NameDescription

    clientMutationId (String)

    A unique identifier for the client performing the mutation.

    \n\n\n\n\n\n\n\n\n\n\n\n

    id (ID!)

    The ID of the verifiable domain to verify.

    \n\n\n\n\n\n\n\n\n\n\n\n
    \n\n
    \n
    \n
    \n", "miniToc": [ { "contents": "\n AddAssigneesToAssignableInput\n ", @@ -3762,11 +3757,6 @@ "headingLevel": 3, "indentationLevel": 0 }, - { - "contents": "\n ConvertPullRequestToDraftInput\n ", - "headingLevel": 3, - "indentationLevel": 0 - }, { "contents": "\n CreateBranchProtectionRuleInput\n ", "headingLevel": 3, diff --git a/lib/graphql/static/schema-dotcom.json b/lib/graphql/static/schema-dotcom.json index 58c4fb259..6eb17e935 100644 --- a/lib/graphql/static/schema-dotcom.json +++ b/lib/graphql/static/schema-dotcom.json @@ -1745,40 +1745,6 @@ } ] }, - { - "name": "convertPullRequestToDraft", - "kind": "mutations", - "id": "convertpullrequesttodraft", - "href": "/graphql/reference/mutations#convertpullrequesttodraft", - "description": "

    Converts a pull request to draft.

    ", - "inputFields": [ - { - "name": "input", - "type": "ConvertPullRequestToDraftInput!", - "id": "convertpullrequesttodraftinput", - "kind": "input-objects", - "href": "/graphql/reference/input-objects#convertpullrequesttodraftinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "kind": "scalars", - "href": "/graphql/reference/scalars#string", - "description": "

    A unique identifier for the client performing the mutation.

    " - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "kind": "objects", - "href": "/graphql/reference/objects#pullrequest", - "description": "

    The pull request that is now a draft.

    " - } - ] - }, { "name": "createBranchProtectionRule", "kind": "mutations", @@ -65170,32 +65136,6 @@ } ] }, - { - "name": "ConvertPullRequestToDraftInput", - "kind": "inputObjects", - "id": "convertpullrequesttodraftinput", - "href": "/graphql/reference/input-objects#convertpullrequesttodraftinput", - "description": "

    Autogenerated input type of ConvertPullRequestToDraft.

    ", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

    A unique identifier for the client performing the mutation.

    ", - "type": "String", - "id": "string", - "kind": "scalars", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

    ID of the pull request to convert to draft.

    ", - "type": "ID!", - "id": "id", - "kind": "scalars", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, { "name": "CreateBranchProtectionRuleInput", "kind": "inputObjects", diff --git a/lib/graphql/static/schema-ghae.json b/lib/graphql/static/schema-ghae.json index 6e2523da1..44dc5c0ba 100644 --- a/lib/graphql/static/schema-ghae.json +++ b/lib/graphql/static/schema-ghae.json @@ -1370,40 +1370,6 @@ } ] }, - { - "name": "convertPullRequestToDraft", - "kind": "mutations", - "id": "convertpullrequesttodraft", - "href": "/graphql/reference/mutations#convertpullrequesttodraft", - "description": "

    Converts a pull request to draft.

    ", - "inputFields": [ - { - "name": "input", - "type": "ConvertPullRequestToDraftInput!", - "id": "convertpullrequesttodraftinput", - "kind": "input-objects", - "href": "/graphql/reference/input-objects#convertpullrequesttodraftinput" - } - ], - "returnFields": [ - { - "name": "clientMutationId", - "type": "String", - "id": "string", - "kind": "scalars", - "href": "/graphql/reference/scalars#string", - "description": "

    A unique identifier for the client performing the mutation.

    " - }, - { - "name": "pullRequest", - "type": "PullRequest", - "id": "pullrequest", - "kind": "objects", - "href": "/graphql/reference/objects#pullrequest", - "description": "

    The pull request that is now a draft.

    " - } - ] - }, { "name": "createBranchProtectionRule", "kind": "mutations", @@ -60715,32 +60681,6 @@ } ] }, - { - "name": "ConvertPullRequestToDraftInput", - "kind": "inputObjects", - "id": "convertpullrequesttodraftinput", - "href": "/graphql/reference/input-objects#convertpullrequesttodraftinput", - "description": "

    Autogenerated input type of ConvertPullRequestToDraft.

    ", - "inputFields": [ - { - "name": "clientMutationId", - "description": "

    A unique identifier for the client performing the mutation.

    ", - "type": "String", - "id": "string", - "kind": "scalars", - "href": "/graphql/reference/scalars#string" - }, - { - "name": "pullRequestId", - "description": "

    ID of the pull request to convert to draft.

    ", - "type": "ID!", - "id": "id", - "kind": "scalars", - "href": "/graphql/reference/scalars#id", - "isDeprecated": false - } - ] - }, { "name": "CreateBranchProtectionRuleInput", "kind": "inputObjects", diff --git a/lib/liquid-tags/README.md b/lib/liquid-tags/README.md index fe4dfc30d..acd7a9575 100644 --- a/lib/liquid-tags/README.md +++ b/lib/liquid-tags/README.md @@ -63,7 +63,7 @@ Note that link tags will only render links that are available in the current pag | `{% homepage_link_with_intro /href %}` | The linked page's title and intro, with homepage-specific styling. | `{% link_in_list /href %}` | The linked page's title in a list item. | `{% topic_link_in_list /href %}` | The linked map topic's title in a list item (used in category TOCs). -| `{% indented_data_reference foo.bar spaces=NUMBER %}` | A data reference with the specified number of spaces prepended to each line. Defaults to 2 spaces if no spaces included. For example: `{% indented_data_reference reusables.enterprise_management_console.enable-disable-security-features %}` +| `{% indented_data_reference site.data.foo.bar spaces=NUMBER %}` | The data reference with the specified number of spaces prepended to each line. ## Creating tags diff --git a/lib/liquid-tags/indented-data-reference.js b/lib/liquid-tags/indented-data-reference.js index 03dfeb15c..06e38a964 100644 --- a/lib/liquid-tags/indented-data-reference.js +++ b/lib/liquid-tags/indented-data-reference.js @@ -14,7 +14,7 @@ module.exports = { this.markup = tagToken.args.trim() }, - async render (scope) { + async render (context) { // obfuscate first legit space, remove all other spaces, then restore legit space // this way we can support spaces=NUMBER as well as spaces = NUMBER const input = this.markup @@ -30,7 +30,7 @@ module.exports = { assert(parseInt(numSpaces) || numSpaces === '0', '"spaces=NUMBER" must include a number') // Get the referenced value from the context - const value = await this.liquid.evalValue(`site.data.${dataReference}`, scope) + const value = await this.liquid.evalValue(dataReference, context) // If nothing is found in the context, exit with nothing; this may // feel weird and that we should throw an error, but this is "The Liquid Way TM" @@ -39,6 +39,6 @@ module.exports = { // add spaces to each line const renderedReferenceWithIndent = value.replace(/^/mg, ' '.repeat(numSpaces)) - return this.liquid.parseAndRender(renderedReferenceWithIndent, scope.environments) + return this.liquid.parseAndRender(renderedReferenceWithIndent, context) } } diff --git a/lib/redirects/add-redirect-to-frontmatter.js b/lib/redirects/add-redirect-to-frontmatter.js index d392eed5e..3e2d26a4c 100644 --- a/lib/redirects/add-redirect-to-frontmatter.js +++ b/lib/redirects/add-redirect-to-frontmatter.js @@ -1,7 +1,7 @@ // add a new redirect string to redirect_from frontmatter module.exports = function addRedirectToFrontmatter (redirectFromData, newRedirectString) { - if (Array.isArray(redirectFromData) && !redirectFromData.includes(newRedirectString)) { + if (Array.isArray(redirectFromData)) { redirectFromData.push(newRedirectString) } else if (typeof redirectFromData === 'string') { redirectFromData = [redirectFromData] diff --git a/lib/render-content/create-processor.js b/lib/render-content/create-processor.js index 3320d027d..bb4a2d18e 100644 --- a/lib/render-content/create-processor.js +++ b/lib/render-content/create-processor.js @@ -27,7 +27,7 @@ module.exports = function createProcessor (context) { .use(highlight, { languages: { graphql }, subset: false }) .use(raw) .use(rewriteLegacyAssetPaths, context) - .use(wrapInElement, { selector: 'ol > li img', wrapper: 'span.procedural-image-wrapper' }) + .use(wrapInElement, { selector: 'ol > li img', wrapper: 'div.procedural-image-wrapper' }) .use(rewriteLocalLinks, { languageCode: context.currentLanguage, version: context.currentVersion }) .use(html) } diff --git a/lib/render-content/plugins/wrap-in-element.js b/lib/render-content/plugins/wrap-in-element.js index c24ad442f..16b4d6ef8 100644 --- a/lib/render-content/plugins/wrap-in-element.js +++ b/lib/render-content/plugins/wrap-in-element.js @@ -22,11 +22,11 @@ module.exports = options => { throw new TypeError('Expected a `string` as selector') } - for (const match of selectAll(selector, tree)) { + for (const match of selectAll(options.selector, tree)) { visit(tree, match, (node, i, parent) => { - const parsedWrapper = parseSelector(wrapper) - parsedWrapper.children = [node] - parent.children[i] = parsedWrapper + const wrapper = parseSelector('div') + wrapper.children = [node] + parent.children[i] = wrapper }) } } diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 1259f8093..a294821e0 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -298,8 +298,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -327,14 +326,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

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

    \n

    You must use a JWT to access this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -380,10 +371,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -5494,7 +5492,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -5580,7 +5578,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -5733,7 +5731,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -5813,7 +5811,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -5956,7 +5954,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6027,7 +6025,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6206,7 +6204,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6296,7 +6294,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -9892,8 +9890,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -10003,8 +10000,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -14263,7 +14259,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -14487,7 +14483,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -18670,8 +18666,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -18680,7 +18675,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -18689,7 +18684,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -18750,8 +18745,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -18760,7 +18754,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -18769,7 +18763,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -18912,8 +18906,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -18922,7 +18915,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -18931,7 +18924,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -18992,8 +18985,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -19002,7 +18994,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -19011,7 +19003,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -19220,8 +19212,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -19282,8 +19273,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -19321,7 +19311,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -19416,8 +19406,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -19478,8 +19467,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -19517,7 +19505,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -19762,8 +19750,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -19792,14 +19779,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "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

    Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -19845,10 +19824,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -21698,7 +21684,7 @@ "name": "exclude", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -21773,7 +21759,7 @@ "name": "exclude", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -25165,7 +25151,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -25244,7 +25230,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -29076,7 +29062,7 @@ "note": { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -29124,7 +29110,7 @@ { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -29873,35 +29859,10 @@ "type": "object", "properties": { "note": { - "description": "

    Required. The project card's note

    ", + "description": "The project card's note", "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "nullable": true } }, "required": [ @@ -29912,24 +29873,14 @@ "type": "object", "properties": { "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", + "description": "The unique identifier of the content associated with the card", "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] + "type": "integer" }, "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", + "description": "The piece of content associated with the card", "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "type": "string" } }, "required": [ @@ -29962,40 +29913,8 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    \n

    Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

    ", - "bodyParameters": [ - { - "description": "

    Required. The project card's note

    ", - "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -30291,7 +30210,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -30372,7 +30291,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -36545,7 +36464,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -36611,7 +36530,7 @@ ] }, "enforce_admins": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -36621,7 +36540,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -36860,7 +36779,7 @@ ] }, "restrictions": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -36965,7 +36884,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -37080,7 +36999,7 @@ "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

    Protecting a branch requires admin or owner permissions to the repository.

    \n

    Note: Passing new arrays of users and teams replaces their previous values.

    \n

    Note: The list of users, apps, and teams in total is limited to 100 items.

    ", "bodyParameters": [ { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -37146,7 +37065,7 @@ ] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -37156,7 +37075,7 @@ "childParamsGroups": [] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -37395,7 +37314,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -37500,7 +37419,7 @@ "childParamsGroups": [] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -39078,16 +38997,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39125,21 +39039,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39230,16 +39131,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39277,21 +39173,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39377,16 +39260,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39424,21 +39302,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39776,16 +39641,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39822,21 +39682,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39917,16 +39764,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39963,21 +39805,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -40058,16 +39887,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -40104,21 +39928,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -40285,16 +40096,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -40332,21 +40138,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -40427,16 +40220,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -40474,21 +40262,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -40569,16 +40344,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -40616,21 +40386,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a team to push to this branch. You can also remove push access for child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayTeams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -40797,16 +40554,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -40843,21 +40595,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified people push access for this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -40938,16 +40677,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -40984,21 +40718,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -41079,16 +40800,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -41125,21 +40841,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a user to push to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -46529,7 +46232,7 @@ "childParamsGroups": [] }, "dismissed_reason": { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", "nullable": true, "oneOf": [ @@ -46575,29 +46278,6 @@ "categoryLabel": "Code scanning", "notes": [], "descriptionHTML": "

    Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "description": "

    Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

    ", @@ -46613,7 +46293,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", "nullable": true, "oneOf": [ @@ -46636,6 +46316,29 @@ "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -46895,7 +46598,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
    " + "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true\n  }\n]\n
    " }, { "httpStatusCode": "403", @@ -46987,7 +46690,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true,\n  \"warning\": \"\"\n}\n
    " + "payload": "
    {\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true\n}\n
    " }, { "httpStatusCode": "403", @@ -47151,7 +46854,7 @@ } ], "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -47246,7 +46949,7 @@ "category": "code-scanning", "categoryLabel": "Code scanning", "notes": [], - "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64 -w0\n
    \n

    SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", + "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", "bodyParameters": [ { "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", @@ -47718,7 +47421,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -47765,7 +47468,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -50503,7 +50206,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50545,7 +50248,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50580,7 +50283,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50622,7 +50325,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50771,7 +50474,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50813,7 +50516,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50848,7 +50551,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50890,7 +50593,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -51660,8 +51363,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, "environment": { @@ -51675,7 +51377,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -51710,7 +51412,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -51765,30 +51467,6 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

    Deployments offer a few configurable parameters with certain defaults.

    \n

    The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.

    \n

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

    \n

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

    \n

    By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

    \n

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

    \n

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

    \n

    Users with repo or repo_deployment scopes can create a deployment for a given ref.

    \n

    Merged branch response

    \n

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

    \n
      \n
    • Auto-merge option is enabled in the repository
      • \n
    • Topic branch does not include the latest changes on the base branch, which is master in the response example
      • \n
    • There are no merge conflicts
      • \n
    \n

    If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

    \n

    Merge conflict response

    \n

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    \n

    Failed commit status checks

    \n

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], "bodyParameters": [ { "type": "string", @@ -51845,8 +51523,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -51860,7 +51537,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -51895,9 +51572,33 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } ] }, { @@ -52954,7 +52655,7 @@ "childParamsGroups": [] }, "reviewers": { - "type": "array of objects or nullable", + "type": "array of objects or null", "nullable": true, "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "items": { @@ -53025,7 +52726,7 @@ ] }, "deployment_branch_policy": { - "type": "object or nullable", + "type": "object or null", "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "properties": { "protected_branches": { @@ -53129,7 +52830,7 @@ "childParamsGroups": [] }, { - "type": "array of objects or nullable", + "type": "array of objects or null", "nullable": true, "description": "

    The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

    ", "items": { @@ -53200,7 +52901,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

    ", "properties": { "protected_branches": { @@ -54739,7 +54440,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -54794,7 +54495,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -55562,7 +55263,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -55632,7 +55333,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -55766,7 +55467,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -55836,7 +55537,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -56180,8 +55881,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -56190,7 +55890,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -56199,7 +55899,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -56257,8 +55957,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -56267,7 +55966,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -56276,7 +55975,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -56422,8 +56121,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -56432,7 +56130,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -56441,7 +56139,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -56499,8 +56197,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -56509,7 +56206,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -56518,7 +56215,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -56745,8 +56442,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -56755,7 +56451,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -56764,7 +56460,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -56825,8 +56521,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -56835,7 +56530,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -56844,7 +56539,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -56992,8 +56687,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -57002,7 +56696,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -57011,7 +56705,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -57072,8 +56766,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -57082,7 +56775,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -57091,7 +56784,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -57417,8 +57110,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -57446,14 +57138,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

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

    \n

    Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -57499,10 +57183,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -58025,7 +57716,7 @@ "name": "vcs", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "tfvc_project": { @@ -58034,7 +57725,7 @@ "name": "tfvc_project", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -58091,7 +57782,7 @@ "name": "vcs", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -58100,7 +57791,7 @@ "name": "tfvc_project", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -59563,7 +59254,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -59576,7 +59266,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -59598,12 +59288,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -59681,39 +59371,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    \n

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -59728,7 +59385,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, { @@ -59741,7 +59397,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -59763,12 +59419,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -59814,6 +59470,39 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -61023,11 +60712,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -61037,7 +60726,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -61072,12 +60761,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -61152,44 +60841,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -61205,11 +60856,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -61219,7 +60870,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -61254,12 +60905,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -61305,6 +60956,44 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -62097,17 +61786,12 @@ "type": "object", "properties": { "labels": { - "type": "array of strings", + "type": "array", "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] + } } } }, @@ -62180,22 +61864,8 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], + "bodyParameters": [], "descriptionHTML": "", - "bodyParameters": [ - { - "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", - "items": { - "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -65965,7 +65635,7 @@ "type": "object", "properties": { "cname": { - "type": "string or nullable", + "type": "string or null", "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "nullable": true, "name": "cname", @@ -66028,8 +65698,7 @@ ], "name": "source", "in": "body", - "type": "", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -66099,7 +65768,7 @@ "descriptionHTML": "

    Updates information for a GitHub Pages site. For more information, see \"About GitHub Pages.

    ", "bodyParameters": [ { - "type": "string or nullable", + "type": "string or null", "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "nullable": true, "name": "cname", @@ -66162,8 +65831,7 @@ ], "name": "source", "in": "body", - "type": "", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -67136,7 +66804,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -67228,7 +66896,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -68676,7 +68344,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -68821,7 +68489,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -70118,7 +69786,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -70127,7 +69795,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -70136,7 +69804,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -70145,7 +69813,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -70197,7 +69865,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -70206,7 +69874,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -70215,7 +69883,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -70224,7 +69892,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -70353,7 +70021,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -70362,7 +70030,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -70371,7 +70039,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -70380,7 +70048,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -70432,7 +70100,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -70441,7 +70109,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -70450,7 +70118,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -70459,7 +70127,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -70991,7 +70659,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -71032,7 +70700,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -72054,7 +71722,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -72105,7 +71773,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -73247,7 +72915,7 @@ "childParamsGroups": [] }, "resolution": { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is resolved. The reason for resolving the alert. Can be one of false_positive, wont_fix, revoked, or used_in_tests.

    ", "nullable": true, "oneOf": [ @@ -73294,29 +72962,6 @@ "categoryLabel": "Secret scanning", "notes": [], "descriptionHTML": "

    Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

    \n

    GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-11-06T18:18:30Z\",\n  \"url\": \"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/owner/private-repo/security/secret-scanning/42\",\n  \"state\": \"resolved\",\n  \"resolution\": \"used_in_tests\",\n  \"resolved_at\": \"2020-11-16T22:42:07Z\",\n  \"resolved_by\": {\n    \"login\": \"monalisa\",\n    \"id\": 2,\n    \"node_id\": \"MDQ6VXNlcjI=\",\n    \"avatar_url\": \"https://alambic.github.com/avatars/u/2?\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/monalisa\",\n    \"html_url\": \"https://github.com/monalisa\",\n    \"followers_url\": \"https://api.github.com/users/monalisa/followers\",\n    \"following_url\": \"https://api.github.com/users/monalisa/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/monalisa/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/monalisa/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/monalisa/orgs\",\n    \"repos_url\": \"https://api.github.com/users/monalisa/repos\",\n    \"events_url\": \"https://api.github.com/users/monalisa/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/monalisa/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": true\n  },\n  \"secret_type\": \"mailchimp_api_key\",\n  \"secret\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"\n}\n
    " - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "State does not match the resolution" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "description": "

    Required. Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.

    ", @@ -73332,7 +72977,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is resolved. The reason for resolving the alert. Can be one of false_positive, wont_fix, revoked, or used_in_tests.

    ", "nullable": true, "oneOf": [ @@ -73356,6 +73001,29 @@ "rawDescription": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-11-06T18:18:30Z\",\n  \"url\": \"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/owner/private-repo/security/secret-scanning/42\",\n  \"state\": \"resolved\",\n  \"resolution\": \"used_in_tests\",\n  \"resolved_at\": \"2020-11-16T22:42:07Z\",\n  \"resolved_by\": {\n    \"login\": \"monalisa\",\n    \"id\": 2,\n    \"node_id\": \"MDQ6VXNlcjI=\",\n    \"avatar_url\": \"https://alambic.github.com/avatars/u/2?\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/monalisa\",\n    \"html_url\": \"https://github.com/monalisa\",\n    \"followers_url\": \"https://api.github.com/users/monalisa/followers\",\n    \"following_url\": \"https://api.github.com/users/monalisa/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/monalisa/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/monalisa/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/monalisa/orgs\",\n    \"repos_url\": \"https://api.github.com/users/monalisa/repos\",\n    \"events_url\": \"https://api.github.com/users/monalisa/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/monalisa/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": true\n  },\n  \"secret_type\": \"mailchimp_api_key\",\n  \"secret\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"\n}\n
    " + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "State does not match the resolution" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -76570,7 +76238,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [ { "parentName": "members", @@ -76679,7 +76347,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [ { "parentName": "members", @@ -76880,7 +76548,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [ { "parentName": "members", @@ -76989,7 +76657,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [ { "parentName": "members", @@ -77097,7 +76765,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "path": { @@ -77105,7 +76773,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "value": { @@ -77122,8 +76790,7 @@ ], "name": "value", "in": "body", - "type": "string or object or array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -77154,7 +76821,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -77162,7 +76829,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -77179,8 +76846,7 @@ ], "name": "value", "in": "body", - "type": "string or object or array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -77267,7 +76933,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "path": { @@ -77275,7 +76941,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "value": { @@ -77292,8 +76958,7 @@ ], "name": "value", "in": "body", - "type": "string or object or array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -77324,7 +76989,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -77332,7 +76997,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -77349,8 +77014,7 @@ ], "name": "value", "in": "body", - "type": "string or object or array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -77616,7 +77280,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [ { "parentName": "name", @@ -77737,7 +77401,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -77757,7 +77421,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -77870,7 +77534,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [ { "parentName": "name", @@ -77991,7 +77655,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -78011,7 +77675,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -78196,7 +77860,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [ { "parentName": "name", @@ -78317,7 +77981,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -78337,7 +78001,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -78450,7 +78114,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [ { "parentName": "name", @@ -78571,7 +78235,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -78591,7 +78255,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -79008,7 +78672,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "familyName": { @@ -79016,7 +78680,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "formatted": { @@ -79024,7 +78688,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -79039,7 +78703,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [ { "parentName": "name", @@ -79051,7 +78715,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79059,7 +78723,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79067,7 +78731,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -79096,7 +78760,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "primary": { @@ -79104,7 +78768,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "type": { @@ -79112,7 +78776,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -79135,7 +78799,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79143,7 +78807,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79151,7 +78815,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -79166,7 +78830,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "externalId": { @@ -79174,7 +78838,7 @@ "name": "externalId", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "groups": { @@ -79185,7 +78849,7 @@ "name": "groups", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "active": { @@ -79193,7 +78857,7 @@ "name": "active", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -79284,7 +78948,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "familyName": { @@ -79292,7 +78956,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "formatted": { @@ -79300,7 +78964,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -79315,7 +78979,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [ { "parentName": "name", @@ -79327,7 +78991,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79335,7 +78999,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79343,7 +79007,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -79372,7 +79036,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "primary": { @@ -79380,7 +79044,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "type": { @@ -79388,7 +79052,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -79411,7 +79075,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79419,7 +79083,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79427,7 +79091,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -79442,7 +79106,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79450,7 +79114,7 @@ "name": "externalId", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79461,7 +79125,7 @@ "name": "groups", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79469,7 +79133,7 @@ "name": "active", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -79618,7 +79282,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "displayName": { @@ -79636,7 +79300,7 @@ "name": "externalId", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "groups": { @@ -79647,7 +79311,7 @@ "name": "groups", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "active": { @@ -79655,7 +79319,7 @@ "name": "active", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "userName": { @@ -79676,7 +79340,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "familyName": { @@ -79684,7 +79348,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "formatted": { @@ -79692,7 +79356,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -79707,7 +79371,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [ { "parentName": "name", @@ -79719,7 +79383,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79727,7 +79391,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79735,7 +79399,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -79764,7 +79428,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "value": { @@ -79772,7 +79436,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "primary": { @@ -79780,7 +79444,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -79803,7 +79467,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79811,7 +79475,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79819,7 +79483,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -79879,7 +79543,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79897,7 +79561,7 @@ "name": "externalId", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79908,7 +79572,7 @@ "name": "groups", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79916,7 +79580,7 @@ "name": "active", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -79937,7 +79601,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "familyName": { @@ -79945,7 +79609,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "formatted": { @@ -79953,7 +79617,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -79968,7 +79632,7 @@ "name": "name", "in": "body", "rawType": "object", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [ { "parentName": "name", @@ -79980,7 +79644,7 @@ "name": "givenName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79988,7 +79652,7 @@ "name": "familyName", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -79996,7 +79660,7 @@ "name": "formatted", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -80025,7 +79689,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "value": { @@ -80033,7 +79697,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "primary": { @@ -80041,7 +79705,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -80064,7 +79728,7 @@ "name": "type", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -80072,7 +79736,7 @@ "name": "value", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -80080,7 +79744,7 @@ "name": "primary", "in": "body", "rawType": "boolean", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -80149,7 +79813,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "Operations": { @@ -80177,7 +79841,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "path": { @@ -80185,7 +79849,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "value": { @@ -80235,8 +79899,7 @@ ], "name": "value", "in": "body", - "type": "object or array or string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -80264,7 +79927,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -80272,7 +79935,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -80322,8 +79985,7 @@ ], "name": "value", "in": "body", - "type": "object or array or string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -80392,7 +80054,7 @@ "name": "schemas", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -80420,7 +80082,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "path": { @@ -80428,7 +80090,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "value": { @@ -80478,8 +80140,7 @@ ], "name": "value", "in": "body", - "type": "object or array or string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -80507,7 +80168,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -80515,7 +80176,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -80565,8 +80226,7 @@ ], "name": "value", "in": "body", - "type": "object or array or string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -81661,7 +81321,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -81746,7 +81406,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -85107,7 +84767,7 @@ "name": "id", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "name": { @@ -85116,7 +84776,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "description": { @@ -85125,7 +84785,7 @@ "name": "description", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -85178,7 +84838,7 @@ "name": "id", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -85187,7 +84847,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -85196,7 +84856,7 @@ "name": "description", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -85209,7 +84869,7 @@ "name": "synced_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -85305,7 +84965,7 @@ "name": "id", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "name": { @@ -85314,7 +84974,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "description": { @@ -85323,7 +84983,7 @@ "name": "description", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -85376,7 +85036,7 @@ "name": "id", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -85385,7 +85045,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -85394,7 +85054,7 @@ "name": "description", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -85407,7 +85067,7 @@ "name": "synced_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -85644,7 +85304,7 @@ }, "twitter_username": { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -85741,7 +85401,7 @@ }, { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -86409,19 +86069,14 @@ "type": "object", "properties": { "emails": { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] + "example": [] } }, "required": [ @@ -86463,24 +86118,8 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -86552,18 +86191,13 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", + "description": "Email addresses associated with the GitHub user account.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] + } } }, "example": { @@ -86637,23 +86271,8 @@ "description": "Validation failed" } ], - "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

    This endpoint is accessible with the user scope.

    " }, { "verb": "get", @@ -89249,7 +88868,7 @@ "name": "repositories", "in": "body", "rawType": "array", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] } }, @@ -89329,7 +88948,7 @@ "name": "repositories", "in": "body", "rawType": "array", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] } ], @@ -90648,7 +90267,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -90698,7 +90317,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json index 2037566ff..1ec355d4b 100644 --- a/lib/rest/static/decorated/ghes-2.18.json +++ b/lib/rest/static/decorated/ghes-2.18.json @@ -6513,7 +6513,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6599,7 +6599,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6752,7 +6752,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6832,7 +6832,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6975,7 +6975,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7046,7 +7046,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7225,7 +7225,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7315,7 +7315,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -8260,8 +8260,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -8371,8 +8370,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -12022,7 +12020,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -12216,7 +12214,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -12510,8 +12508,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -12520,7 +12517,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -12529,7 +12526,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -12590,8 +12587,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -12600,7 +12596,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -12609,7 +12605,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -12752,8 +12748,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -12762,7 +12757,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -12771,7 +12766,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -12832,8 +12827,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -12842,7 +12836,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -12851,7 +12845,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13060,8 +13054,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13122,8 +13115,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13161,7 +13153,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -13256,8 +13248,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13318,8 +13309,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13357,7 +13347,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -16652,7 +16642,7 @@ "note": { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -16700,7 +16690,7 @@ { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -17449,35 +17439,10 @@ "type": "object", "properties": { "note": { - "description": "

    Required. The project card's note

    ", + "description": "The project card's note", "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "nullable": true } }, "required": [ @@ -17488,24 +17453,14 @@ "type": "object", "properties": { "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", + "description": "The unique identifier of the content associated with the card", "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] + "type": "integer" }, "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", + "description": "The piece of content associated with the card", "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "type": "string" } }, "required": [ @@ -17538,40 +17493,8 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    \n

    Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

    ", - "bodyParameters": [ - { - "description": "

    Required. The project card's note

    ", - "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -17867,7 +17790,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -17948,7 +17871,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -20119,7 +20042,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20185,7 +20108,7 @@ ] }, "enforce_admins": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -20195,7 +20118,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20434,7 +20357,7 @@ ] }, "restrictions": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20539,7 +20462,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -20654,7 +20577,7 @@ "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

    Protecting a branch requires admin or owner permissions to the repository.

    \n

    Note: Passing new arrays of users and teams replaces their previous values.

    \n

    Note: The list of users, apps, and teams in total is limited to 100 items.

    ", "bodyParameters": [ { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20720,7 +20643,7 @@ ] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -20730,7 +20653,7 @@ "childParamsGroups": [] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20969,7 +20892,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -21074,7 +20997,7 @@ "childParamsGroups": [] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -22652,16 +22575,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -22699,21 +22617,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -22804,16 +22709,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -22851,21 +22751,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -22951,16 +22838,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -22998,21 +22880,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23350,16 +23219,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23397,21 +23261,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23492,16 +23343,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23539,21 +23385,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23634,16 +23467,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23681,21 +23509,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a team to push to this branch. You can also remove push access for child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayTeams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23862,16 +23677,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23908,21 +23718,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified people push access for this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -24003,16 +23800,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24049,21 +23841,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -24144,16 +23923,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24190,21 +23964,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a user to push to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -29474,7 +29235,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -29521,7 +29282,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -32016,7 +31777,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -32058,7 +31819,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -32093,7 +31854,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -32135,7 +31896,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -32284,7 +32045,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -32326,7 +32087,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -32361,7 +32122,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -32403,7 +32164,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -33173,8 +32934,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, "environment": { @@ -33188,7 +32948,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -33223,7 +32983,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -33278,30 +33038,6 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

    Deployments offer a few configurable parameters with certain defaults.

    \n

    The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

    \n

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

    \n

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

    \n

    By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

    \n

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

    \n

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

    \n

    Users with repo or repo_deployment scopes can create a deployment for a given ref.

    \n

    Merged branch response

    \n

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

    \n
      \n
    • Auto-merge option is enabled in the repository
      • \n
    • Topic branch does not include the latest changes on the base branch, which is master in the response example
      • \n
    • There are no merge conflicts
      • \n
    \n

    If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

    \n

    Merge conflict response

    \n

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    \n

    Failed commit status checks

    \n

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], "bodyParameters": [ { "type": "string", @@ -33358,8 +33094,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -33373,7 +33108,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -33408,9 +33143,33 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } ] }, { @@ -35240,7 +34999,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -35295,7 +35054,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -36152,7 +35911,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -36222,7 +35981,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -36356,7 +36115,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -36426,7 +36185,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -36770,8 +36529,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -36780,7 +36538,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -36789,7 +36547,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -36847,8 +36605,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -36857,7 +36614,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -36866,7 +36623,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -37012,8 +36769,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -37022,7 +36778,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -37031,7 +36787,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -37089,8 +36845,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37099,7 +36854,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37108,7 +36863,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -37335,8 +37090,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -37345,7 +37099,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -37354,7 +37108,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -37415,8 +37169,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37425,7 +37178,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37434,7 +37187,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -37582,8 +37335,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -37592,7 +37344,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -37601,7 +37353,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -37662,8 +37414,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37672,7 +37423,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37681,7 +37432,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -38657,7 +38408,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -38670,7 +38420,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -38692,12 +38442,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -38775,39 +38525,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    \n

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -38822,7 +38539,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, { @@ -38835,7 +38551,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -38857,12 +38573,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -38908,6 +38624,39 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -40042,11 +39791,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -40056,7 +39805,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -40091,12 +39840,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -40171,44 +39920,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -40224,11 +39935,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -40238,7 +39949,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -40273,12 +39984,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -40324,6 +40035,44 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -41122,17 +40871,12 @@ "type": "object", "properties": { "labels": { - "type": "array of strings", + "type": "array", "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] + } } } }, @@ -41205,22 +40949,8 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], + "bodyParameters": [], "descriptionHTML": "", - "bodyParameters": [ - { - "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", - "items": { - "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -46383,7 +46113,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -46487,7 +46217,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -49112,7 +48842,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -49121,7 +48851,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -49130,7 +48860,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -49139,7 +48869,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49191,7 +48921,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49200,7 +48930,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49209,7 +48939,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49218,7 +48948,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -49347,7 +49077,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -49356,7 +49086,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -49365,7 +49095,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -49374,7 +49104,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49426,7 +49156,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49435,7 +49165,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49444,7 +49174,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49453,7 +49183,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -49985,7 +49715,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50026,7 +49756,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -51025,7 +50755,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -51076,7 +50806,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -55869,7 +55599,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

    ", "nullable": true, "name": "parent_team_id", @@ -55955,7 +55685,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

    ", "nullable": true, "name": "parent_team_id", @@ -59433,7 +59163,7 @@ }, "twitter_username": { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -59530,7 +59260,7 @@ }, { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -59740,19 +59470,14 @@ "type": "object", "properties": { "emails": { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] + "example": [] } }, "required": [ @@ -59794,24 +59519,8 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -59883,18 +59592,13 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", + "description": "Email addresses associated with the GitHub user account.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] + } } }, "example": { @@ -59968,23 +59672,8 @@ "description": "Validation failed" } ], - "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

    This endpoint is accessible with the user scope.

    " }, { "verb": "get", @@ -62167,7 +61856,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -62217,7 +61906,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json index 1d2828058..c423bd03a 100644 --- a/lib/rest/static/decorated/ghes-2.19.json +++ b/lib/rest/static/decorated/ghes-2.19.json @@ -6513,7 +6513,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6599,7 +6599,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6752,7 +6752,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6832,7 +6832,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -6975,7 +6975,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7046,7 +7046,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7225,7 +7225,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7315,7 +7315,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -8260,8 +8260,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -8371,8 +8370,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -12022,7 +12020,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -12216,7 +12214,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -12510,8 +12508,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -12520,7 +12517,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -12529,7 +12526,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -12590,8 +12587,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -12600,7 +12596,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -12609,7 +12605,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -12752,8 +12748,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -12762,7 +12757,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -12771,7 +12766,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -12832,8 +12827,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -12842,7 +12836,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -12851,7 +12845,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13060,8 +13054,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13122,8 +13115,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13161,7 +13153,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -13256,8 +13248,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13318,8 +13309,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13357,7 +13347,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -16748,7 +16738,7 @@ "note": { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -16796,7 +16786,7 @@ { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -17545,35 +17535,10 @@ "type": "object", "properties": { "note": { - "description": "

    Required. The project card's note

    ", + "description": "The project card's note", "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "nullable": true } }, "required": [ @@ -17584,24 +17549,14 @@ "type": "object", "properties": { "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", + "description": "The unique identifier of the content associated with the card", "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] + "type": "integer" }, "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", + "description": "The piece of content associated with the card", "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "type": "string" } }, "required": [ @@ -17634,40 +17589,8 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    \n

    Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

    ", - "bodyParameters": [ - { - "description": "

    Required. The project card's note

    ", - "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -17963,7 +17886,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -18044,7 +17967,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -20207,7 +20130,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20273,7 +20196,7 @@ ] }, "enforce_admins": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -20283,7 +20206,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20522,7 +20445,7 @@ ] }, "restrictions": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20627,7 +20550,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -20742,7 +20665,7 @@ "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

    Protecting a branch requires admin or owner permissions to the repository.

    \n

    Note: Passing new arrays of users and teams replaces their previous values.

    \n

    Note: The list of users, apps, and teams in total is limited to 100 items.

    ", "bodyParameters": [ { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20808,7 +20731,7 @@ ] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -20818,7 +20741,7 @@ "childParamsGroups": [] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -21057,7 +20980,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -21162,7 +21085,7 @@ "childParamsGroups": [] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -22740,16 +22663,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -22787,21 +22705,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -22892,16 +22797,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -22939,21 +22839,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23039,16 +22926,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23086,21 +22968,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23438,16 +23307,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23484,21 +23348,131 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ + "responses": [ { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    [\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
    " + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The name of the branch.

    " } ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + } + ], + "summary": "Set app access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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 installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": [ + "repos" + ], + "operationId": "repos/set-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-app-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "apps parameter", + "items": { + "type": "string" + } + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "apps", + "category": "repos", + "subcategory": "branches" + }, + "slug": "set-app-access-restrictions", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "branches", + "subcategoryLabel": "Branches", + "notes": [], + "bodyParameters": [], + "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -23514,7 +23488,7 @@ ] }, { - "verb": "put", + "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -23551,24 +23525,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Set app access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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 installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Remove app access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/set-app-access-restrictions", + "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-app-access-restrictions" }, "requestBody": { "content": { @@ -23579,16 +23553,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23619,27 +23588,14 @@ "category": "repos", "subcategory": "branches" }, - "slug": "set-app-access-restrictions", + "slug": "remove-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -23655,8 +23611,8 @@ ] }, { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { @@ -23692,111 +23648,56 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Remove app access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Get teams with access to the protected branch", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], - "operationId": "repos/remove-app-access-restrictions", + "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-app-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-teams-with-access-to-the-protected-branch" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "requestBodyParameterName": "apps", "category": "repos", "subcategory": "branches" }, - "slug": "remove-app-access-restrictions", + "slug": "get-teams-with-access-to-the-protected-branch", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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 the teams who have push access to this branch. The list includes child teams.

    ", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
    [\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
    " + "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "get", + "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -23833,40 +23734,78 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Get teams with access to the protected branch", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "summary": "Add team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/get-teams-with-access-to-protected-branch", + "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-team-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], + "requestBodyParameterName": "teams", "category": "repos", "subcategory": "branches" }, - "slug": "get-teams-with-access-to-the-protected-branch", + "slug": "add-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], "bodyParameters": [], - "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 the teams who have push access to this branch. The list includes child teams.

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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -23875,14 +23814,14 @@ "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -23919,24 +23858,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Add team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Set team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/add-team-access-restrictions", + "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-team-access-restrictions" }, "requestBody": { "content": { @@ -23947,16 +23886,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23988,27 +23922,14 @@ "category": "repos", "subcategory": "branches" }, - "slug": "add-team-access-restrictions", + "slug": "set-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -24024,7 +23945,7 @@ ] }, { - "verb": "put", + "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -24061,24 +23982,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Set team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Remove team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/set-team-access-restrictions", + "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-team-access-restrictions" }, "requestBody": { "content": { @@ -24089,158 +24010,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - }, - "required": [ - "teams" - ], - "example": { - "teams": [ - "my-team" - ] - } - }, - { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - ] - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" - }, - "slug": "set-team-access-restrictions", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "branches", - "subcategoryLabel": "Branches", - "notes": [], - "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true, - "descriptionHTML": "

    The name of the branch.

    " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " - } - ], - "summary": "Remove team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "tags": [ - "repos" - ], - "operationId": "repos/remove-team-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#remove-team-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24278,21 +24052,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a team to push to this branch. You can also remove push access for child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayTeams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -24459,16 +24220,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24505,21 +24261,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified people push access for this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -24600,16 +24343,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24646,21 +24384,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -24741,16 +24466,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24787,21 +24507,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a user to push to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -30071,7 +29778,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -30118,7 +29825,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -32613,7 +32320,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -32655,7 +32362,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -32690,7 +32397,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -32732,7 +32439,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -32881,7 +32588,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -32923,7 +32630,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -32958,7 +32665,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -33000,7 +32707,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -33770,8 +33477,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, "environment": { @@ -33785,7 +33491,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -33820,7 +33526,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -33875,30 +33581,6 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

    Deployments offer a few configurable parameters with certain defaults.

    \n

    The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

    \n

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

    \n

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

    \n

    By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

    \n

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

    \n

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

    \n

    Users with repo or repo_deployment scopes can create a deployment for a given ref.

    \n

    Merged branch response

    \n

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

    \n
      \n
    • Auto-merge option is enabled in the repository
      • \n
    • Topic branch does not include the latest changes on the base branch, which is master in the response example
      • \n
    • There are no merge conflicts
      • \n
    \n

    If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

    \n

    Merge conflict response

    \n

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    \n

    Failed commit status checks

    \n

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], "bodyParameters": [ { "type": "string", @@ -33955,8 +33637,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -33970,7 +33651,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -34005,9 +33686,33 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } ] }, { @@ -36024,7 +35729,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -36079,7 +35784,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -36847,7 +36552,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -36917,7 +36622,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -37051,7 +36756,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -37121,7 +36826,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -37465,8 +37170,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -37475,7 +37179,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -37484,7 +37188,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -37542,8 +37246,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37552,7 +37255,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37561,7 +37264,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -37707,8 +37410,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -37717,7 +37419,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -37726,7 +37428,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -37784,8 +37486,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37794,7 +37495,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -37803,7 +37504,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -38030,8 +37731,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -38040,7 +37740,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -38049,7 +37749,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -38110,8 +37810,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38120,7 +37819,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38129,7 +37828,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -38277,8 +37976,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -38287,7 +37985,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -38296,7 +37994,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -38357,8 +38055,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38367,7 +38064,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38376,7 +38073,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -39352,7 +39049,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -39365,7 +39061,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -39387,12 +39083,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -39470,39 +39166,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    \n

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -39517,7 +39180,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, { @@ -39530,7 +39192,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -39552,12 +39214,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -39603,6 +39265,39 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -40737,11 +40432,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -40751,7 +40446,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -40786,12 +40481,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -40866,44 +40561,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -40919,11 +40576,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -40933,7 +40590,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -40968,12 +40625,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -41019,6 +40676,44 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -41817,17 +41512,12 @@ "type": "object", "properties": { "labels": { - "type": "array of strings", + "type": "array", "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] + } } } }, @@ -41900,22 +41590,8 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], + "bodyParameters": [], "descriptionHTML": "", - "bodyParameters": [ - { - "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", - "items": { - "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -47215,7 +46891,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -47319,7 +46995,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -49944,7 +49620,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -49953,7 +49629,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -49962,7 +49638,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -49971,7 +49647,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50023,7 +49699,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50032,7 +49708,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50041,7 +49717,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50050,7 +49726,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50179,7 +49855,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -50188,7 +49864,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -50197,7 +49873,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -50206,7 +49882,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50258,7 +49934,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50267,7 +49943,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50276,7 +49952,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50285,7 +49961,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50817,7 +50493,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50858,7 +50534,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -51857,7 +51533,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -51908,7 +51584,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -56701,7 +56377,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

    ", "nullable": true, "name": "parent_team_id", @@ -56787,7 +56463,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team. Note: You must pass the hellcat-preview media type to use this parameter.

    ", "nullable": true, "name": "parent_team_id", @@ -60053,7 +59729,7 @@ }, "twitter_username": { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -60150,7 +59826,7 @@ }, { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -60360,19 +60036,14 @@ "type": "object", "properties": { "emails": { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] + "example": [] } }, "required": [ @@ -60414,24 +60085,8 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -60503,18 +60158,13 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", + "description": "Email addresses associated with the GitHub user account.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] + } } }, "example": { @@ -60588,23 +60238,8 @@ "description": "Validation failed" } ], - "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

    This endpoint is accessible with the user scope.

    " }, { "verb": "get", @@ -62787,7 +62422,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -62837,7 +62472,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index d25e193ad..2fed8b5bf 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -6937,7 +6937,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7023,7 +7023,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7176,7 +7176,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7256,7 +7256,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7399,7 +7399,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7470,7 +7470,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7649,7 +7649,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7739,7 +7739,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -8684,8 +8684,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -8795,8 +8794,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -12496,7 +12494,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -12690,7 +12688,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -12984,8 +12982,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -12994,7 +12991,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -13003,7 +13000,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13064,8 +13061,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -13074,7 +13070,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -13083,7 +13079,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13226,8 +13222,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -13236,7 +13231,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -13245,7 +13240,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13306,8 +13301,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -13316,7 +13310,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -13325,7 +13319,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13534,8 +13528,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13596,8 +13589,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13635,7 +13627,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -13730,8 +13722,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13792,8 +13783,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13831,7 +13821,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -17222,7 +17212,7 @@ "note": { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -17270,7 +17260,7 @@ { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -18019,35 +18009,10 @@ "type": "object", "properties": { "note": { - "description": "

    Required. The project card's note

    ", + "description": "The project card's note", "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "nullable": true } }, "required": [ @@ -18058,24 +18023,14 @@ "type": "object", "properties": { "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", + "description": "The unique identifier of the content associated with the card", "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] + "type": "integer" }, "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", + "description": "The piece of content associated with the card", "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "type": "string" } }, "required": [ @@ -18108,40 +18063,8 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    \n

    Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

    ", - "bodyParameters": [ - { - "description": "

    Required. The project card's note

    ", - "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -18437,7 +18360,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -18518,7 +18441,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -20681,7 +20604,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20747,7 +20670,7 @@ ] }, "enforce_admins": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -20757,7 +20680,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -20996,7 +20919,7 @@ ] }, "restrictions": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -21101,7 +21024,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -21216,7 +21139,7 @@ "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

    Protecting a branch requires admin or owner permissions to the repository.

    \n

    Note: Passing new arrays of users and teams replaces their previous values.

    \n

    Note: The list of users, apps, and teams in total is limited to 100 items.

    ", "bodyParameters": [ { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -21282,7 +21205,7 @@ ] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -21292,7 +21215,7 @@ "childParamsGroups": [] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -21531,7 +21454,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -21636,7 +21559,7 @@ "childParamsGroups": [] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -23214,16 +23137,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23261,21 +23179,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23366,16 +23271,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23413,21 +23313,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23513,16 +23400,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23560,21 +23442,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -23912,16 +23781,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -23958,21 +23822,131 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ + "responses": [ { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    [\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
    " + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The name of the branch.

    " } ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + } + ], + "summary": "Set app access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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 installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": [ + "repos" + ], + "operationId": "repos/set-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#set-app-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "apps parameter", + "items": { + "type": "string" + } + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "apps", + "category": "repos", + "subcategory": "branches" + }, + "slug": "set-app-access-restrictions", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "branches", + "subcategoryLabel": "Branches", + "notes": [], + "bodyParameters": [], + "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -23988,7 +23962,7 @@ ] }, { - "verb": "put", + "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -24025,24 +23999,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Set app access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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 installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Remove app access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/set-app-access-restrictions", + "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#remove-app-access-restrictions" }, "requestBody": { "content": { @@ -24053,16 +24027,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24093,27 +24062,14 @@ "category": "repos", "subcategory": "branches" }, - "slug": "set-app-access-restrictions", + "slug": "remove-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -24129,8 +24085,8 @@ ] }, { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { @@ -24166,111 +24122,56 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Remove app access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Get teams with access to the protected branch", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], - "operationId": "repos/remove-app-access-restrictions", + "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#remove-app-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#list-teams-with-access-to-the-protected-branch" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "requestBodyParameterName": "apps", "category": "repos", "subcategory": "branches" }, - "slug": "remove-app-access-restrictions", + "slug": "get-teams-with-access-to-the-protected-branch", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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 the teams who have push access to this branch. The list includes child teams.

    ", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
    [\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
    " + "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "get", + "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -24307,40 +24208,78 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Get teams with access to the protected branch", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "summary": "Add team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/get-teams-with-access-to-protected-branch", + "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#add-team-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], + "requestBodyParameterName": "teams", "category": "repos", "subcategory": "branches" }, - "slug": "get-teams-with-access-to-the-protected-branch", + "slug": "add-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], "bodyParameters": [], - "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 the teams who have push access to this branch. The list includes child teams.

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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -24349,14 +24288,14 @@ "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -24393,24 +24332,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Add team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Set team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/add-team-access-restrictions", + "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#set-team-access-restrictions" }, "requestBody": { "content": { @@ -24421,16 +24360,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24462,27 +24396,14 @@ "category": "repos", "subcategory": "branches" }, - "slug": "add-team-access-restrictions", + "slug": "set-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -24498,7 +24419,7 @@ ] }, { - "verb": "put", + "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -24535,24 +24456,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Set team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Remove team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/set-team-access-restrictions", + "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#remove-team-access-restrictions" }, "requestBody": { "content": { @@ -24563,158 +24484,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - }, - "required": [ - "teams" - ], - "example": { - "teams": [ - "my-team" - ] - } - }, - { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - ] - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" - }, - "slug": "set-team-access-restrictions", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "branches", - "subcategoryLabel": "Branches", - "notes": [], - "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true, - "descriptionHTML": "

    The name of the branch.

    " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " - } - ], - "summary": "Remove team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "tags": [ - "repos" - ], - "operationId": "repos/remove-team-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#remove-team-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24752,21 +24526,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a team to push to this branch. You can also remove push access for child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayTeams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -24933,16 +24694,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -24979,21 +24735,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified people push access for this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -25074,16 +24817,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -25120,21 +24858,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -25215,16 +24940,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -25261,21 +24981,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a user to push to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -30545,7 +30252,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -30592,7 +30299,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -33087,7 +32794,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -33129,7 +32836,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -33164,7 +32871,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -33206,7 +32913,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -33355,7 +33062,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -33397,7 +33104,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -33432,7 +33139,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -33474,7 +33181,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -34244,8 +33951,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, "environment": { @@ -34259,7 +33965,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -34294,7 +34000,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -34349,30 +34055,6 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

    Deployments offer a few configurable parameters with certain defaults.

    \n

    The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

    \n

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

    \n

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

    \n

    By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

    \n

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

    \n

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

    \n

    Users with repo or repo_deployment scopes can create a deployment for a given ref.

    \n

    Merged branch response

    \n

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

    \n
      \n
    • Auto-merge option is enabled in the repository
      • \n
    • Topic branch does not include the latest changes on the base branch, which is master in the response example
      • \n
    • There are no merge conflicts
      • \n
    \n

    If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

    \n

    Merge conflict response

    \n

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    \n

    Failed commit status checks

    \n

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], "bodyParameters": [ { "type": "string", @@ -34429,8 +34111,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -34444,7 +34125,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -34479,9 +34160,33 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } ] }, { @@ -36498,7 +36203,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -36553,7 +36258,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -37321,7 +37026,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -37391,7 +37096,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -37525,7 +37230,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -37595,7 +37300,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -37939,8 +37644,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -37949,7 +37653,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -37958,7 +37662,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -38016,8 +37720,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38026,7 +37729,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38035,7 +37738,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -38181,8 +37884,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -38191,7 +37893,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -38200,7 +37902,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -38258,8 +37960,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38268,7 +37969,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38277,7 +37978,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -38504,8 +38205,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -38514,7 +38214,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -38523,7 +38223,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -38584,8 +38284,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38594,7 +38293,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38603,7 +38302,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -38751,8 +38450,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -38761,7 +38459,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -38770,7 +38468,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -38831,8 +38529,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38841,7 +38538,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38850,7 +38547,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -39826,7 +39523,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -39839,7 +39535,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -39861,12 +39557,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -39944,39 +39640,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    \n

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -39991,7 +39654,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, { @@ -40004,7 +39666,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -40026,12 +39688,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -40077,6 +39739,39 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -41211,11 +40906,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -41225,7 +40920,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -41260,12 +40955,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -41340,44 +41035,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -41393,11 +41050,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -41407,7 +41064,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -41442,12 +41099,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -41493,6 +41150,44 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -42291,17 +41986,12 @@ "type": "object", "properties": { "labels": { - "type": "array of strings", + "type": "array", "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] + } } } }, @@ -42374,22 +42064,8 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], + "bodyParameters": [], "descriptionHTML": "", - "bodyParameters": [ - { - "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", - "items": { - "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -47689,7 +47365,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -47793,7 +47469,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -49160,7 +48836,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49305,7 +48981,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -50600,7 +50276,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -50609,7 +50285,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -50618,7 +50294,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -50627,7 +50303,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50679,7 +50355,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50688,7 +50364,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50697,7 +50373,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50706,7 +50382,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50835,7 +50511,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -50844,7 +50520,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -50853,7 +50529,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -50862,7 +50538,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50914,7 +50590,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50923,7 +50599,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50932,7 +50608,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50941,7 +50617,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -51473,7 +51149,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -51514,7 +51190,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -52513,7 +52189,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -52564,7 +52240,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -57349,7 +57025,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -57427,7 +57103,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -60615,7 +60291,7 @@ }, "twitter_username": { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -60712,7 +60388,7 @@ }, { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -60922,19 +60598,14 @@ "type": "object", "properties": { "emails": { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] + "example": [] } }, "required": [ @@ -60976,24 +60647,8 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -61065,18 +60720,13 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", + "description": "Email addresses associated with the GitHub user account.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] + } } }, "example": { @@ -61150,23 +60800,8 @@ "description": "Validation failed" } ], - "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

    This endpoint is accessible with the user scope.

    " }, { "verb": "get", @@ -63349,7 +62984,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -63399,7 +63034,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 585cab7c2..0d16d4839 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -6931,7 +6931,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7017,7 +7017,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7170,7 +7170,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7250,7 +7250,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7393,7 +7393,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7464,7 +7464,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7643,7 +7643,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7733,7 +7733,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -8678,8 +8678,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -8789,8 +8788,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -12490,7 +12488,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -12684,7 +12682,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -12978,8 +12976,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -12988,7 +12985,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -12997,7 +12994,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13058,8 +13055,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -13068,7 +13064,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -13077,7 +13073,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13220,8 +13216,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -13230,7 +13225,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -13239,7 +13234,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13300,8 +13295,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -13310,7 +13304,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -13319,7 +13313,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13528,8 +13522,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13590,8 +13583,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13629,7 +13621,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -13724,8 +13716,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13786,8 +13777,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -13825,7 +13815,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -17180,7 +17170,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -17259,7 +17249,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -20674,7 +20664,7 @@ "note": { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -20722,7 +20712,7 @@ { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -21471,35 +21461,10 @@ "type": "object", "properties": { "note": { - "description": "

    Required. The project card's note

    ", + "description": "The project card's note", "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "nullable": true } }, "required": [ @@ -21510,24 +21475,14 @@ "type": "object", "properties": { "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", + "description": "The unique identifier of the content associated with the card", "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] + "type": "integer" }, "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", + "description": "The piece of content associated with the card", "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "type": "string" } }, "required": [ @@ -21560,40 +21515,8 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    \n

    Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

    ", - "bodyParameters": [ - { - "description": "

    Required. The project card's note

    ", - "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -21889,7 +21812,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -21970,7 +21893,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -24152,7 +24075,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -24218,7 +24141,7 @@ ] }, "enforce_admins": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -24228,7 +24151,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -24467,7 +24390,7 @@ ] }, "restrictions": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -24572,7 +24495,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -24687,7 +24610,7 @@ "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

    Protecting a branch requires admin or owner permissions to the repository.

    \n

    Note: Passing new arrays of users and teams replaces their previous values.

    \n

    Note: The list of users, apps, and teams in total is limited to 100 items.

    ", "bodyParameters": [ { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -24753,7 +24676,7 @@ ] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -24763,7 +24686,7 @@ "childParamsGroups": [] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -25002,7 +24925,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -25107,7 +25030,7 @@ "childParamsGroups": [] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -26685,16 +26608,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -26732,21 +26650,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -26837,16 +26742,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -26884,21 +26784,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -26984,16 +26871,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -27031,21 +26913,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -27383,16 +27252,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -27429,21 +27293,131 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ + "responses": [ { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    [\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
    " + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The name of the branch.

    " } ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + } + ], + "summary": "Set app access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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 installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": [ + "repos" + ], + "operationId": "repos/set-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#set-app-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "apps parameter", + "items": { + "type": "string" + } + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "apps", + "category": "repos", + "subcategory": "branches" + }, + "slug": "set-app-access-restrictions", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "branches", + "subcategoryLabel": "Branches", + "notes": [], + "bodyParameters": [], + "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -27459,7 +27433,7 @@ ] }, { - "verb": "put", + "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -27496,24 +27470,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Set app access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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 installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Remove app access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/set-app-access-restrictions", + "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#remove-app-access-restrictions" }, "requestBody": { "content": { @@ -27524,16 +27498,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -27564,27 +27533,14 @@ "category": "repos", "subcategory": "branches" }, - "slug": "set-app-access-restrictions", + "slug": "remove-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -27600,8 +27556,8 @@ ] }, { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { @@ -27637,111 +27593,56 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Remove app access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Get teams with access to the protected branch", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], - "operationId": "repos/remove-app-access-restrictions", + "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#remove-app-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#list-teams-with-access-to-the-protected-branch" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "requestBodyParameterName": "apps", "category": "repos", "subcategory": "branches" }, - "slug": "remove-app-access-restrictions", + "slug": "get-teams-with-access-to-the-protected-branch", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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 the teams who have push access to this branch. The list includes child teams.

    ", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
    [\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
    " + "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "get", + "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -27778,40 +27679,78 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Get teams with access to the protected branch", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "summary": "Add team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/get-teams-with-access-to-protected-branch", + "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#add-team-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], + "requestBodyParameterName": "teams", "category": "repos", "subcategory": "branches" }, - "slug": "get-teams-with-access-to-the-protected-branch", + "slug": "add-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], "bodyParameters": [], - "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 the teams who have push access to this branch. The list includes child teams.

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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -27820,14 +27759,14 @@ "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -27864,24 +27803,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Add team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Set team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/add-team-access-restrictions", + "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#set-team-access-restrictions" }, "requestBody": { "content": { @@ -27892,16 +27831,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -27933,27 +27867,14 @@ "category": "repos", "subcategory": "branches" }, - "slug": "add-team-access-restrictions", + "slug": "set-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -27969,7 +27890,7 @@ ] }, { - "verb": "put", + "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -28006,24 +27927,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Set team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Remove team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/set-team-access-restrictions", + "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#remove-team-access-restrictions" }, "requestBody": { "content": { @@ -28034,158 +27955,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - }, - "required": [ - "teams" - ], - "example": { - "teams": [ - "my-team" - ] - } - }, - { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - ] - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" - }, - "slug": "set-team-access-restrictions", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "branches", - "subcategoryLabel": "Branches", - "notes": [], - "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true, - "descriptionHTML": "

    The name of the branch.

    " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " - } - ], - "summary": "Remove team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "tags": [ - "repos" - ], - "operationId": "repos/remove-team-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#remove-team-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -28223,21 +27997,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a team to push to this branch. You can also remove push access for child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayTeams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -28404,16 +28165,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -28450,21 +28206,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified people push access for this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -28545,16 +28288,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -28591,21 +28329,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -28686,16 +28411,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -28732,21 +28452,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a user to push to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -34016,7 +33723,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -34063,7 +33770,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -36651,7 +36358,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -36693,7 +36400,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -36728,7 +36435,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -36770,7 +36477,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -36919,7 +36626,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -36961,7 +36668,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -36996,7 +36703,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -37038,7 +36745,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -37808,8 +37515,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, "environment": { @@ -37823,7 +37529,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -37858,7 +37564,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -37913,30 +37619,6 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

    Deployments offer a few configurable parameters with certain defaults.

    \n

    The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

    \n

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

    \n

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

    \n

    By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

    \n

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

    \n

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

    \n

    Users with repo or repo_deployment scopes can create a deployment for a given ref.

    \n

    Merged branch response

    \n

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

    \n
      \n
    • Auto-merge option is enabled in the repository
      • \n
    • Topic branch does not include the latest changes on the base branch, which is master in the response example
      • \n
    • There are no merge conflicts
      • \n
    \n

    If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

    \n

    Merge conflict response

    \n

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    \n

    Failed commit status checks

    \n

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], "bodyParameters": [ { "type": "string", @@ -37993,8 +37675,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -38008,7 +37689,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -38043,9 +37724,33 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } ] }, { @@ -40289,7 +39994,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -40344,7 +40049,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -41112,7 +40817,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -41182,7 +40887,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -41316,7 +41021,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -41386,7 +41091,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -41730,8 +41435,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -41740,7 +41444,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -41749,7 +41453,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -41807,8 +41511,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -41817,7 +41520,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -41826,7 +41529,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -41972,8 +41675,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -41982,7 +41684,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -41991,7 +41693,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -42049,8 +41751,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -42059,7 +41760,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -42068,7 +41769,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -42295,8 +41996,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -42305,7 +42005,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -42314,7 +42014,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -42375,8 +42075,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -42385,7 +42084,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -42394,7 +42093,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -42542,8 +42241,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -42552,7 +42250,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -42561,7 +42259,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -42622,8 +42320,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -42632,7 +42329,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -42641,7 +42338,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -43617,7 +43314,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -43630,7 +43326,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -43652,12 +43348,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -43735,39 +43431,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    \n

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -43782,7 +43445,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, { @@ -43795,7 +43457,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -43817,12 +43479,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -43868,6 +43530,39 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -45095,11 +44790,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -45109,7 +44804,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -45144,12 +44839,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -45224,44 +44919,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -45277,11 +44934,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -45291,7 +44948,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -45326,12 +44983,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -45377,6 +45034,44 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -46175,17 +45870,12 @@ "type": "object", "properties": { "labels": { - "type": "array of strings", + "type": "array", "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] + } } } }, @@ -46258,22 +45948,8 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], + "bodyParameters": [], "descriptionHTML": "", - "bodyParameters": [ - { - "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", - "items": { - "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -51660,7 +51336,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -51758,7 +51434,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -53212,7 +52888,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -53357,7 +53033,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -54654,7 +54330,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -54663,7 +54339,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -54672,7 +54348,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -54681,7 +54357,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -54733,7 +54409,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54742,7 +54418,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54751,7 +54427,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54760,7 +54436,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -54889,7 +54565,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -54898,7 +54574,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -54907,7 +54583,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -54916,7 +54592,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -54968,7 +54644,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54977,7 +54653,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54986,7 +54662,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54995,7 +54671,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -55527,7 +55203,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -55568,7 +55244,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -56567,7 +56243,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -56618,7 +56294,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -61412,7 +61088,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -61497,7 +61173,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -64850,7 +64526,7 @@ }, "twitter_username": { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -64947,7 +64623,7 @@ }, { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -65157,19 +64833,14 @@ "type": "object", "properties": { "emails": { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] + "example": [] } }, "required": [ @@ -65211,24 +64882,8 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -65300,18 +64955,13 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", + "description": "Email addresses associated with the GitHub user account.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] + } } }, "example": { @@ -65385,23 +65035,8 @@ "description": "Validation failed" } ], - "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

    This endpoint is accessible with the user scope.

    " }, { "verb": "get", @@ -67584,7 +67219,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -67634,7 +67269,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 65ad3f00f..95cd80b92 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -7005,7 +7005,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7091,7 +7091,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7244,7 +7244,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7324,7 +7324,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7467,7 +7467,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7538,7 +7538,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7717,7 +7717,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -7807,7 +7807,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -10451,8 +10451,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -10562,8 +10561,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -14247,7 +14245,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -14441,7 +14439,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -17259,8 +17257,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -17269,7 +17266,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -17278,7 +17275,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -17339,8 +17336,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -17349,7 +17345,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -17358,7 +17354,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -17501,8 +17497,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -17511,7 +17506,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -17520,7 +17515,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -17581,8 +17576,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -17591,7 +17585,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -17600,7 +17594,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -17809,8 +17803,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -17871,8 +17864,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -17910,7 +17902,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -18005,8 +17997,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -18067,8 +18058,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -18106,7 +18096,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -21428,7 +21418,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -21507,7 +21497,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -24922,7 +24912,7 @@ "note": { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -24970,7 +24960,7 @@ { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -25719,35 +25709,10 @@ "type": "object", "properties": { "note": { - "description": "

    Required. The project card's note

    ", + "description": "The project card's note", "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "nullable": true } }, "required": [ @@ -25758,24 +25723,14 @@ "type": "object", "properties": { "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", + "description": "The unique identifier of the content associated with the card", "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] + "type": "integer" }, "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", + "description": "The piece of content associated with the card", "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "type": "string" } }, "required": [ @@ -25808,40 +25763,8 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    \n

    Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

    ", - "bodyParameters": [ - { - "description": "

    Required. The project card's note

    ", - "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -26137,7 +26060,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -26218,7 +26141,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -31138,7 +31061,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -31204,7 +31127,7 @@ ] }, "enforce_admins": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -31214,7 +31137,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -31453,7 +31376,7 @@ ] }, "restrictions": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -31558,7 +31481,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -31673,7 +31596,7 @@ "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

    Protecting a branch requires admin or owner permissions to the repository.

    \n

    Note: Passing new arrays of users and teams replaces their previous values.

    \n

    Note: The list of users, apps, and teams in total is limited to 100 items.

    ", "bodyParameters": [ { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -31739,7 +31662,7 @@ ] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -31749,7 +31672,7 @@ "childParamsGroups": [] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -31988,7 +31911,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -32093,7 +32016,7 @@ "childParamsGroups": [] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -33671,16 +33594,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -33718,21 +33636,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -33823,16 +33728,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -33870,21 +33770,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -33970,16 +33857,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -34017,21 +33899,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -34369,16 +34238,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -34415,21 +34279,131 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ + "responses": [ { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    [\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
    " + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "serverUrl": "http(s)://{hostname}/api/v3", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "branch", + "description": "The name of the branch.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true, + "descriptionHTML": "

    The name of the branch.

    " } ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + } + ], + "summary": "Set app access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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 installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": [ + "repos" + ], + "operationId": "repos/set-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#set-app-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "apps parameter", + "items": { + "type": "string" + } + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "requestBodyParameterName": "apps", + "category": "repos", + "subcategory": "branches" + }, + "slug": "set-app-access-restrictions", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "branches", + "subcategoryLabel": "Branches", + "notes": [], + "bodyParameters": [], + "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -34445,7 +34419,7 @@ ] }, { - "verb": "put", + "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -34482,24 +34456,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Set app access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces 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 installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Remove app access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/set-app-access-restrictions", + "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#remove-app-access-restrictions" }, "requestBody": { "content": { @@ -34510,16 +34484,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -34550,27 +34519,14 @@ "category": "repos", "subcategory": "branches" }, - "slug": "set-app-access-restrictions", + "slug": "remove-app-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -34586,8 +34542,8 @@ ] }, { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ { @@ -34623,111 +34579,56 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/apps
    " + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Remove app access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Get teams with access to the protected branch", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], - "operationId": "repos/remove-app-access-restrictions", + "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#remove-app-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-teams-with-access-to-the-protected-branch" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "requestBodyParameterName": "apps", "category": "repos", "subcategory": "branches" }, - "slug": "remove-app-access-restrictions", + "slug": "get-teams-with-access-to-the-protected-branch", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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 the teams who have push access to this branch. The list includes child teams.

    ", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
    [\n  {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  }\n]\n
    " + "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "get", + "verb": "post", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -34764,40 +34665,78 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Get teams with access to the protected branch", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "summary": "Add team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/get-teams-with-access-to-protected-branch", + "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#add-team-access-restrictions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "teams parameter", + "items": { + "type": "string" + } + } + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], + "requestBodyParameterName": "teams", "category": "repos", "subcategory": "branches" }, - "slug": "get-teams-with-access-to-the-protected-branch", + "slug": "add-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], "bodyParameters": [], - "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 the teams who have push access to this branch. The list includes child teams.

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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -34806,14 +34745,14 @@ "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -34850,24 +34789,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Add team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Set team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/add-team-access-restrictions", + "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#set-team-access-restrictions" }, "requestBody": { "content": { @@ -34878,16 +34817,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -34919,27 +34853,14 @@ "category": "repos", "subcategory": "branches" }, - "slug": "add-team-access-restrictions", + "slug": "set-team-access-restrictions", "category": "repos", "categoryLabel": "Repos", "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], - "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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", "responses": [ { "httpStatusCode": "200", @@ -34955,7 +34876,7 @@ ] }, { - "verb": "put", + "verb": "delete", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "serverUrl": "http(s)://{hostname}/api/v3", "parameters": [ @@ -34992,24 +34913,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", + "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " } ], - "summary": "Set team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "summary": "Remove team access restrictions", + "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], - "operationId": "repos/set-team-access-restrictions", + "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#remove-team-access-restrictions" }, "requestBody": { "content": { @@ -35020,158 +34941,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - }, - "required": [ - "teams" - ], - "example": { - "teams": [ - "my-team" - ] - } - }, - { - "type": "array", - "description": "teams parameter", - "items": { - "type": "string" - } - } - ] - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "requestBodyParameterName": "teams", - "category": "repos", - "subcategory": "branches" - }, - "slug": "set-team-access-restrictions", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "branches", - "subcategoryLabel": "Branches", - "notes": [], - "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    [\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
    " - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "serverUrl": "http(s)://{hostname}/api/v3", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true, - "descriptionHTML": "

    The name of the branch.

    " - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams", - "html": "
    curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/restrictions/teams
    " - }, - { - "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", - "html": "
    await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
    " - } - ], - "summary": "Remove team access restrictions", - "description": "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](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "tags": [ - "repos" - ], - "operationId": "repos/remove-team-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#remove-team-access-restrictions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -35209,21 +34983,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a team to push to this branch. You can also remove push access for child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayTeams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -35390,16 +35151,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -35436,21 +35192,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified people push access for this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -35531,16 +35274,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -35577,21 +35315,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -35672,16 +35397,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -35718,21 +35438,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a user to push to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -41053,7 +40760,7 @@ "childParamsGroups": [] }, "dismissed_reason": { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", "nullable": true, "oneOf": [ @@ -41099,29 +40806,6 @@ "categoryLabel": "Code scanning", "notes": [], "descriptionHTML": "

    Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "description": "

    Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

    ", @@ -41137,7 +40821,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", "nullable": true, "oneOf": [ @@ -41160,6 +40844,29 @@ "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -41292,7 +40999,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
    " + "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true\n  }\n]\n
    " }, { "httpStatusCode": "403", @@ -41348,7 +41055,7 @@ } ], "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -41443,7 +41150,7 @@ "category": "code-scanning", "categoryLabel": "Code scanning", "notes": [], - "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64 -w0\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", + "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", "bodyParameters": [ { "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", @@ -41823,7 +41530,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -41870,7 +41577,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -44458,7 +44165,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -44500,7 +44207,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -44535,7 +44242,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -44577,7 +44284,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -44726,7 +44433,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -44768,7 +44475,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -44803,7 +44510,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -44845,7 +44552,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -45615,8 +45322,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, "environment": { @@ -45630,7 +45336,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -45665,7 +45371,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -45720,30 +45426,6 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

    Deployments offer a few configurable parameters with certain defaults.

    \n

    The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

    \n

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

    \n

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

    \n

    By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

    \n

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

    \n

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

    \n

    Users with repo or repo_deployment scopes can create a deployment for a given ref.

    \n

    Merged branch response

    \n

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

    \n
      \n
    • Auto-merge option is enabled in the repository
      • \n
    • Topic branch does not include the latest changes on the base branch, which is master in the response example
      • \n
    • There are no merge conflicts
      • \n
    \n

    If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

    \n

    Merge conflict response

    \n

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    \n

    Failed commit status checks

    \n

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], "bodyParameters": [ { "type": "string", @@ -45800,8 +45482,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -45815,7 +45496,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -45850,9 +45531,33 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } ] }, { @@ -48084,7 +47789,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -48139,7 +47844,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -48907,7 +48612,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -48977,7 +48682,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -49111,7 +48816,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -49181,7 +48886,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -49525,8 +49230,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -49535,7 +49239,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -49544,7 +49248,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49602,8 +49306,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49612,7 +49315,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49621,7 +49324,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -49767,8 +49470,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -49777,7 +49479,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -49786,7 +49488,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49844,8 +49546,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49854,7 +49555,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -49863,7 +49564,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50090,8 +49791,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -50100,7 +49800,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -50109,7 +49809,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50170,8 +49870,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50180,7 +49879,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50189,7 +49888,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50337,8 +50036,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -50347,7 +50045,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -50356,7 +50054,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50417,8 +50115,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50427,7 +50124,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50436,7 +50133,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -51396,7 +51093,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -51409,7 +51105,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -51431,12 +51127,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -51514,39 +51210,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    \n

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -51561,7 +51224,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, { @@ -51574,7 +51236,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -51596,12 +51258,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -51647,6 +51309,39 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -52856,11 +52551,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -52870,7 +52565,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -52905,12 +52600,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -52985,44 +52680,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -53038,11 +52695,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -53052,7 +52709,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -53087,12 +52744,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -53138,6 +52795,44 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -53930,17 +53625,12 @@ "type": "object", "properties": { "labels": { - "type": "array of strings", + "type": "array", "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] + } } } }, @@ -54013,22 +53703,8 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], + "bodyParameters": [], "descriptionHTML": "", - "bodyParameters": [ - { - "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", - "items": { - "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -57798,7 +57474,7 @@ "type": "object", "properties": { "cname": { - "type": "string or nullable", + "type": "string or null", "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "nullable": true, "name": "cname", @@ -57861,8 +57537,7 @@ ], "name": "source", "in": "body", - "type": "", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -57932,7 +57607,7 @@ "descriptionHTML": "

    Updates information for a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.

    ", "bodyParameters": [ { - "type": "string or nullable", + "type": "string or null", "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "nullable": true, "name": "cname", @@ -57995,8 +57670,7 @@ ], "name": "source", "in": "body", - "type": "", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -59397,7 +59071,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -59489,7 +59163,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -60937,7 +60611,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -61082,7 +60756,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -62379,7 +62053,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -62388,7 +62062,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -62397,7 +62071,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -62406,7 +62080,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -62458,7 +62132,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -62467,7 +62141,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -62476,7 +62150,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -62485,7 +62159,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -62614,7 +62288,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -62623,7 +62297,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -62632,7 +62306,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -62641,7 +62315,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -62693,7 +62367,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -62702,7 +62376,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -62711,7 +62385,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -62720,7 +62394,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -63252,7 +62926,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -63293,7 +62967,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -64292,7 +63966,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -64343,7 +64017,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -69137,7 +68811,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -69222,7 +68896,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -72575,7 +72249,7 @@ }, "twitter_username": { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -72672,7 +72346,7 @@ }, { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -72882,19 +72556,14 @@ "type": "object", "properties": { "emails": { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] + "example": [] } }, "required": [ @@ -72936,24 +72605,8 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -73025,18 +72678,13 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", + "description": "Email addresses associated with the GitHub user account.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] + } } }, "example": { @@ -73110,23 +72758,8 @@ "description": "Validation failed" } ], - "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

    This endpoint is accessible with the user scope.

    " }, { "verb": "get", @@ -75261,7 +74894,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -75311,7 +74944,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index b4b8627b9..c3426f556 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -3846,8 +3846,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -3875,14 +3874,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

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

    \n

    You must use a JWT to access this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -3928,10 +3919,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -9042,7 +9040,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -9128,7 +9126,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -9281,7 +9279,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -9361,7 +9359,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -9504,7 +9502,7 @@ }, "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -9575,7 +9573,7 @@ }, { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -9754,7 +9752,7 @@ "properties": { "scopes": { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -9844,7 +9842,7 @@ "bodyParameters": [ { "description": "

    A list of scopes that this authorization is in.

    ", - "type": "array of strings or nullable", + "type": "array of strings or null", "items": { "type": "string" }, @@ -10458,7 +10456,7 @@ "childParamsGroups": [] }, "expires_at": { - "type": "string or nullable", + "type": "string or null", "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", "example": "\"2021-01-01T00:00:00.000-07:00\"", "nullable": true, @@ -10502,7 +10500,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", "example": "\"2021-01-01T00:00:00.000-07:00\"", "nullable": true, @@ -13422,8 +13420,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -13533,8 +13530,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -17228,7 +17224,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -17432,7 +17428,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -20963,8 +20959,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -20973,7 +20968,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -20982,7 +20977,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -21043,8 +21038,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -21053,7 +21047,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -21062,7 +21056,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -21205,8 +21199,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -21215,7 +21208,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -21224,7 +21217,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -21285,8 +21278,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -21295,7 +21287,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -21304,7 +21296,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -21513,8 +21505,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -21575,8 +21566,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -21614,7 +21604,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -21709,8 +21699,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -21771,8 +21760,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -21810,7 +21798,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -22055,8 +22043,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -22085,14 +22072,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "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

    Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -22138,10 +22117,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -25387,7 +25373,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -25466,7 +25452,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -28881,7 +28867,7 @@ "note": { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -28929,7 +28915,7 @@ { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -29678,35 +29664,10 @@ "type": "object", "properties": { "note": { - "description": "

    Required. The project card's note

    ", + "description": "The project card's note", "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "nullable": true } }, "required": [ @@ -29717,24 +29678,14 @@ "type": "object", "properties": { "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", + "description": "The unique identifier of the content associated with the card", "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] + "type": "integer" }, "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", + "description": "The piece of content associated with the card", "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "type": "string" } }, "required": [ @@ -29767,40 +29718,8 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    \n

    Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

    ", - "bodyParameters": [ - { - "description": "

    Required. The project card's note

    ", - "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -30096,7 +30015,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -30177,7 +30096,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -35682,7 +35601,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -35748,7 +35667,7 @@ ] }, "enforce_admins": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -35758,7 +35677,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -35997,7 +35916,7 @@ ] }, "restrictions": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -36102,7 +36021,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -36217,7 +36136,7 @@ "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

    Protecting a branch requires admin or owner permissions to the repository.

    \n

    Note: Passing new arrays of users and teams replaces their previous values.

    \n

    Note: The list of users, apps, and teams in total is limited to 100 items.

    ", "bodyParameters": [ { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -36283,7 +36202,7 @@ ] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -36293,7 +36212,7 @@ "childParamsGroups": [] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -36532,7 +36451,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -36637,7 +36556,7 @@ "childParamsGroups": [] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -38215,16 +38134,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -38262,21 +38176,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -38367,16 +38268,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -38414,21 +38310,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -38514,16 +38397,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -38561,21 +38439,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -38913,16 +38778,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -38959,21 +38819,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39054,16 +38901,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39100,21 +38942,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39195,16 +39024,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39241,21 +39065,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39422,16 +39233,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39469,21 +39275,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39564,16 +39357,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39611,21 +39399,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39706,16 +39481,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39753,21 +39523,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a team to push to this branch. You can also remove push access for child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayTeams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39934,16 +39691,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -39980,21 +39732,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified people push access for this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -40075,16 +39814,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -40121,21 +39855,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -40216,16 +39937,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -40262,21 +39978,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a user to push to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -45534,7 +45237,7 @@ "childParamsGroups": [] }, "dismissed_reason": { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", "nullable": true, "oneOf": [ @@ -45580,29 +45283,6 @@ "categoryLabel": "Code scanning", "notes": [], "descriptionHTML": "

    Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "description": "

    Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

    ", @@ -45618,7 +45298,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", "nullable": true, "oneOf": [ @@ -45641,6 +45321,29 @@ "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -45773,7 +45476,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
    " + "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true\n  }\n]\n
    " }, { "httpStatusCode": "403", @@ -45829,7 +45532,7 @@ } ], "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -45924,7 +45627,7 @@ "category": "code-scanning", "categoryLabel": "Code scanning", "notes": [], - "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64 -w0\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", + "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", "bodyParameters": [ { "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", @@ -46304,7 +46007,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -46351,7 +46054,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -48925,7 +48628,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -48967,7 +48670,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -49002,7 +48705,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49044,7 +48747,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -49193,7 +48896,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49235,7 +48938,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -49270,7 +48973,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49312,7 +49015,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -50082,8 +49785,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, "environment": { @@ -50097,7 +49799,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -50132,7 +49834,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -50187,30 +49889,6 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

    Deployments offer a few configurable parameters with certain defaults.

    \n

    The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.

    \n

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

    \n

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

    \n

    By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

    \n

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

    \n

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

    \n

    Users with repo or repo_deployment scopes can create a deployment for a given ref.

    \n

    Merged branch response

    \n

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

    \n
      \n
    • Auto-merge option is enabled in the repository
      • \n
    • Topic branch does not include the latest changes on the base branch, which is master in the response example
      • \n
    • There are no merge conflicts
      • \n
    \n

    If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

    \n

    Merge conflict response

    \n

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    \n

    Failed commit status checks

    \n

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], "bodyParameters": [ { "type": "string", @@ -50267,8 +49945,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -50282,7 +49959,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -50317,9 +49994,33 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } ] }, { @@ -52551,7 +52252,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -52606,7 +52307,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -53374,7 +53075,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -53444,7 +53145,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -53578,7 +53279,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -53648,7 +53349,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -53992,8 +53693,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -54002,7 +53702,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -54011,7 +53711,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -54069,8 +53769,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54079,7 +53778,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54088,7 +53787,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -54234,8 +53933,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -54244,7 +53942,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -54253,7 +53951,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -54311,8 +54009,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54321,7 +54018,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54330,7 +54027,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -54557,8 +54254,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -54567,7 +54263,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -54576,7 +54272,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -54637,8 +54333,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54647,7 +54342,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54656,7 +54351,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -54804,8 +54499,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -54814,7 +54508,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -54823,7 +54517,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -54884,8 +54578,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54894,7 +54587,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -54903,7 +54596,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -55229,8 +54922,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -55258,14 +54950,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

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

    \n

    Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -55311,10 +54995,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -56136,7 +55827,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -56149,7 +55839,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -56171,12 +55861,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -56254,39 +55944,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    \n

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -56301,7 +55958,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, { @@ -56314,7 +55970,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -56336,12 +55992,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -56387,6 +56043,39 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -57596,11 +57285,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -57610,7 +57299,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -57645,12 +57334,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -57725,44 +57414,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -57778,11 +57429,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -57792,7 +57443,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -57827,12 +57478,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -57878,6 +57529,44 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -58670,17 +58359,12 @@ "type": "object", "properties": { "labels": { - "type": "array of strings", + "type": "array", "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] + } } } }, @@ -58753,22 +58437,8 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], + "bodyParameters": [], "descriptionHTML": "", - "bodyParameters": [ - { - "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", - "items": { - "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -62538,7 +62208,7 @@ "type": "object", "properties": { "cname": { - "type": "string or nullable", + "type": "string or null", "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "nullable": true, "name": "cname", @@ -62601,8 +62271,7 @@ ], "name": "source", "in": "body", - "type": "", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -62672,7 +62341,7 @@ "descriptionHTML": "

    Updates information for a GitHub Enterprise Server Pages site. For more information, see \"About GitHub Pages.

    ", "bodyParameters": [ { - "type": "string or nullable", + "type": "string or null", "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "nullable": true, "name": "cname", @@ -62735,8 +62404,7 @@ ], "name": "source", "in": "body", - "type": "", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -64137,7 +63805,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -64229,7 +63897,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -65677,7 +65345,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -65822,7 +65490,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -67119,7 +66787,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -67128,7 +66796,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -67137,7 +66805,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -67146,7 +66814,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -67198,7 +66866,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -67207,7 +66875,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -67216,7 +66884,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -67225,7 +66893,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -67354,7 +67022,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -67363,7 +67031,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -67372,7 +67040,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -67381,7 +67049,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -67433,7 +67101,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -67442,7 +67110,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -67451,7 +67119,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -67460,7 +67128,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -67992,7 +67660,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -68033,7 +67701,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -69032,7 +68700,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -69083,7 +68751,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -73877,7 +73545,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -73962,7 +73630,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -77315,7 +76983,7 @@ }, "twitter_username": { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -77412,7 +77080,7 @@ }, { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -77622,19 +77290,14 @@ "type": "object", "properties": { "emails": { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] + "example": [] } }, "required": [ @@ -77676,24 +77339,8 @@ "subcategory": "emails", "subcategoryLabel": "Emails", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "example": [], - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -77765,18 +77412,13 @@ "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "properties": { "emails": { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", + "description": "Email addresses associated with the GitHub user account.", + "type": "array", "items": { "type": "string", "example": "username@example.com", "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] + } } }, "example": { @@ -77850,23 +77492,8 @@ "description": "Validation failed" } ], - "descriptionHTML": "

    This endpoint is accessible with the user scope.

    ", - "bodyParameters": [ - { - "description": "

    Required. Email addresses associated with the GitHub user account.

    ", - "type": "array of strings", - "items": { - "type": "string", - "example": "username@example.com", - "minItems": 1 - }, - "name": "emails", - "in": "body", - "rawType": "array", - "rawDescription": "Email addresses associated with the GitHub user account.", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

    This endpoint is accessible with the user scope.

    " }, { "verb": "get", @@ -80001,7 +79628,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -80051,7 +79678,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 7ebd0bb8b..9fda4cb8c 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -2674,8 +2674,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -2703,14 +2702,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

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

    \n

    You must use a JWT to access this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -2756,10 +2747,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -6108,7 +6106,7 @@ "childParamsGroups": [] }, "expires_at": { - "type": "string or nullable", + "type": "string or null", "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", "example": "\"2021-01-01T00:00:00.000-07:00\"", "nullable": true, @@ -6152,7 +6150,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The time at which the announcement expires. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. To set an announcement that never expires, omit this parameter, set it to null, or set it to an empty string.

    ", "example": "\"2021-01-01T00:00:00.000-07:00\"", "nullable": true, @@ -8784,8 +8782,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -8895,8 +8892,7 @@ ], "name": "public", "in": "body", - "description": "

    Flag indicating whether the gist is public

    ", - "type": "boolean or string", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -12610,7 +12606,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -12834,7 +12830,7 @@ "name": "blog", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -15158,8 +15154,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -15168,7 +15163,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -15177,7 +15172,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -15238,8 +15233,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -15248,7 +15242,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -15257,7 +15251,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -15400,8 +15394,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "username": { @@ -15410,7 +15403,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "password": { @@ -15419,7 +15412,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -15480,8 +15473,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -15490,7 +15482,7 @@ "name": "username", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -15499,7 +15491,7 @@ "name": "password", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -15708,8 +15700,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -15770,8 +15761,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -15809,7 +15799,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -15904,8 +15894,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -15966,8 +15955,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -16005,7 +15993,7 @@ "name": "name", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -16250,8 +16238,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -16280,14 +16267,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "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

    Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -16333,10 +16312,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -19180,7 +19166,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -19259,7 +19245,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -22674,7 +22660,7 @@ "note": { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -22722,7 +22708,7 @@ { "description": "

    The project card's note

    ", "example": "Update all gems", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "note", "in": "body", @@ -23471,35 +23457,10 @@ "type": "object", "properties": { "note": { - "description": "

    Required. The project card's note

    ", + "description": "The project card's note", "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "nullable": true } }, "required": [ @@ -23510,24 +23471,14 @@ "type": "object", "properties": { "content_id": { - "description": "

    Required. The unique identifier of the content associated with the card

    ", + "description": "The unique identifier of the content associated with the card", "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] + "type": "integer" }, "content_type": { - "description": "

    Required. The piece of content associated with the card

    ", + "description": "The piece of content associated with the card", "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] + "type": "string" } }, "required": [ @@ -23560,40 +23511,8 @@ "subcategory": "cards", "subcategoryLabel": "Cards", "notes": [], + "bodyParameters": [], "descriptionHTML": "

    Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

    \n

    Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

    ", - "bodyParameters": [ - { - "description": "

    Required. The project card's note

    ", - "example": "Update all gems", - "type": "string or nullable", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

    Required. The unique identifier of the content associated with the card

    ", - "example": 42, - "type": "integer", - "name": "content_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the content associated with the card", - "childParamsGroups": [] - }, - { - "description": "

    Required. The piece of content associated with the card

    ", - "example": "PullRequest", - "type": "string", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The piece of content associated with the card", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "201", @@ -23889,7 +23808,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -23970,7 +23889,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -29366,7 +29285,7 @@ "type": "object", "properties": { "required_status_checks": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -29432,7 +29351,7 @@ ] }, "enforce_admins": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -29442,7 +29361,7 @@ "childParamsGroups": [] }, "required_pull_request_reviews": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -29681,7 +29600,7 @@ ] }, "restrictions": { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -29786,7 +29705,7 @@ "childParamsGroups": [] }, "allow_force_pushes": { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -29901,7 +29820,7 @@ "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

    Protecting a branch requires admin or owner permissions to the repository.

    \n

    Note: Passing new arrays of users and teams replaces their previous values.

    \n

    Note: The list of users, apps, and teams in total is limited to 100 items.

    ", "bodyParameters": [ { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require status checks to pass before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -29967,7 +29886,7 @@ ] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

    ", "nullable": true, "name": "enforce_admins", @@ -29977,7 +29896,7 @@ "childParamsGroups": [] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Require at least one approving review on a pull request, before merging. Set to null to disable.

    ", "nullable": true, "properties": { @@ -30216,7 +30135,7 @@ ] }, { - "type": "object or nullable", + "type": "object or null", "description": "

    Required. Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

    ", "nullable": true, "properties": { @@ -30321,7 +30240,7 @@ "childParamsGroups": [] }, { - "type": "boolean or nullable", + "type": "boolean or null", "description": "

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

    ", "nullable": true, "name": "allow_force_pushes", @@ -31899,16 +31818,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -31946,21 +31860,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -32051,16 +31952,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -32098,21 +31994,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -32198,16 +32081,11 @@ "type": "object", "properties": { "contexts": { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", + "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -32245,21 +32123,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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.

    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. contexts parameter

    ", - "items": { - "type": "string" - }, - "name": "contexts", - "in": "body", - "rawType": "array", - "rawDescription": "contexts parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -32597,16 +32462,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -32643,21 +32503,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -32738,16 +32585,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -32784,21 +32626,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -32879,16 +32708,11 @@ "type": "object", "properties": { "apps": { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", + "type": "array", + "description": "apps parameter", "items": { "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -32925,21 +32749,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe GitHub Apps that have push access to this branch. Use the app's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. apps parameter

    ", - "items": { - "type": "string" - }, - "name": "apps", - "in": "body", - "rawType": "array", - "rawDescription": "apps parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -33106,16 +32917,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -33153,21 +32959,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified teams push access for this branch. You can also give push access to child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -33248,16 +33041,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -33295,21 +33083,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayThe teams that can have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -33390,16 +33165,11 @@ "type": "object", "properties": { "teams": { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", + "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -33437,21 +33207,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a team to push to this branch. You can also remove push access for child teams.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayTeams that should no longer have push access. Use the team's slug. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. teams parameter

    ", - "items": { - "type": "string" - }, - "name": "teams", - "in": "body", - "rawType": "array", - "rawDescription": "teams parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -33618,16 +33375,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -33664,21 +33416,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Grants the specified people push access for this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -33759,16 +33498,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -33805,21 +33539,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -33900,16 +33621,11 @@ "type": "object", "properties": { "users": { - "type": "array of strings", - "description": "

    Required. users parameter

    ", + "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] + } } }, "required": [ @@ -33946,21 +33662,8 @@ "subcategory": "branches", "subcategoryLabel": "Branches", "notes": [], + "bodyParameters": [], "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

    Removes the ability of a user to push to this branch.

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n
    TypeDescription
    arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
    ", - "bodyParameters": [ - { - "type": "array of strings", - "description": "

    Required. users parameter

    ", - "items": { - "type": "string" - }, - "name": "users", - "in": "body", - "rawType": "array", - "rawDescription": "users parameter", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -39218,7 +38921,7 @@ "childParamsGroups": [] }, "dismissed_reason": { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", "nullable": true, "oneOf": [ @@ -39264,29 +38967,6 @@ "categoryLabel": "Code scanning", "notes": [], "descriptionHTML": "

    Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "description": "

    Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

    ", @@ -39302,7 +38982,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

    ", "nullable": true, "oneOf": [ @@ -39325,6 +39005,29 @@ "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -39584,7 +39287,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true,\n    \"warning\": \"\"\n  }\n]\n
    " + "payload": "
    [\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true\n  }\n]\n
    " }, { "httpStatusCode": "403", @@ -39676,7 +39379,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
    {\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true,\n  \"warning\": \"\"\n}\n
    " + "payload": "
    {\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true\n}\n
    " }, { "httpStatusCode": "403", @@ -39732,7 +39435,7 @@ } ], "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -39827,7 +39530,7 @@ "category": "code-scanning", "categoryLabel": "Code scanning", "notes": [], - "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64 -w0\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", + "descriptionHTML": "

    Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

    \n

    There are two places where you can upload code scanning results.

    \n\n

    You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

    \n
    gzip -c analysis-data.sarif | base64\n
    \n

    SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

    \n

    The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

    ", "bodyParameters": [ { "description": "

    Required. The SHA of the commit to which the analysis you are uploading relates.

    ", @@ -40299,7 +40002,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -40346,7 +40049,7 @@ "name": "permissions", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -42940,7 +42643,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -42982,7 +42685,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -43017,7 +42720,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -43059,7 +42762,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -43208,7 +42911,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -43250,7 +42953,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -43285,7 +42988,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -43327,7 +43030,7 @@ "name": "date", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -44097,8 +43800,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, "environment": { @@ -44112,7 +43814,7 @@ "childParamsGroups": [] }, "description": { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -44147,7 +43849,7 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -44202,30 +43904,6 @@ "subcategoryLabel": "Deployments", "notes": [], "descriptionHTML": "

    Deployments offer a few configurable parameters with certain defaults.

    \n

    The ref parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them\nbefore we merge a pull request.

    \n

    The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

    \n

    The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

    \n

    By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

    \n

    The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

    \n

    The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

    \n

    Users with repo or repo_deployment scopes can create a deployment for a given ref.

    \n

    Merged branch response

    \n

    You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

    \n
      \n
    • Auto-merge option is enabled in the repository
      • \n
    • Topic branch does not include the latest changes on the base branch, which is master in the response example
      • \n
    • There are no merge conflicts
      • \n
    \n

    If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

    \n

    Merge conflict response

    \n

    This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

    \n

    Failed commit status checks

    \n

    This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Simple example", - "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " - }, - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Merged branch response", - "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict when there is a merge conflict or the commit's status checks failed" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], "bodyParameters": [ { "type": "string", @@ -44282,8 +43960,7 @@ ], "name": "payload", "in": "body", - "description": "

    JSON payload with extra information about the deployment.

    ", - "type": "object or string", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -44297,7 +43974,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Short description of the deployment.

    ", "default": "", "nullable": true, @@ -44332,9 +44009,33 @@ "name": "created_at", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Simple example", + "payload": "
    {\n  \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n  \"id\": 1,\n  \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n  \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n  \"ref\": \"topic-branch\",\n  \"task\": \"deploy\",\n  \"payload\": {},\n  \"original_environment\": \"staging\",\n  \"environment\": \"production\",\n  \"description\": \"Deploy request from hubot\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2012-07-20T01:19:13Z\",\n  \"updated_at\": \"2012-07-20T01:19:13Z\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n  \"transient_environment\": false,\n  \"production_environment\": true\n}\n
    " + }, + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Merged branch response", + "payload": "
    {\n  \"message\": \"Auto-merged master into topic-branch on deployment.\"\n}\n
    " + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } ] }, { @@ -46428,7 +46129,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -46483,7 +46184,7 @@ "name": "key", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -47251,7 +46952,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -47321,7 +47022,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -47455,7 +47156,7 @@ "childParamsGroups": [] }, "sha": { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -47525,7 +47226,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The SHA1 checksum ID of the object in the tree. Also called tree.sha. If the value is null then the file will be deleted.

    \n

    Note: Use either tree.sha or content to specify the contents of the entry. Using both tree.sha and content will return an error.

    ", "nullable": true, "name": "sha", @@ -47869,8 +47570,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -47879,7 +47579,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -47888,7 +47588,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -47946,8 +47646,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -47956,7 +47655,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -47965,7 +47664,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -48111,8 +47810,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "token": { @@ -48121,7 +47819,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "digest": { @@ -48130,7 +47828,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -48188,8 +47886,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -48198,7 +47895,7 @@ "name": "token", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -48207,7 +47904,7 @@ "name": "digest", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -48434,8 +48131,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -48444,7 +48140,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -48453,7 +48149,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -48514,8 +48210,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -48524,7 +48219,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -48533,7 +48228,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -48681,8 +48376,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, "address": { @@ -48691,7 +48385,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "room": { @@ -48700,7 +48394,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -48761,8 +48455,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -48771,7 +48464,7 @@ "name": "address", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -48780,7 +48473,7 @@ "name": "room", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -49106,8 +48799,7 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -49135,14 +48827,6 @@ "subcategoryLabel": "Webhooks", "notes": [], "descriptionHTML": "

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

    \n

    Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " - } - ], "bodyParameters": [ { "type": "string", @@ -49188,10 +48872,17 @@ ], "name": "insecure_ssl", "in": "body", - "description": "

    Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

    ", - "type": "string or number", + "description": "

    undefined

    ", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
    " + } ] }, { @@ -50013,7 +49704,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, "body": { @@ -50026,7 +49716,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -50048,12 +49738,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -50131,39 +49821,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    \n

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

    ", - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -50178,7 +49835,6 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer", "childParamsGroups": [] }, { @@ -50191,7 +49847,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

    ", "nullable": true, "name": "assignee", @@ -50213,12 +49869,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -50264,6 +49920,39 @@ "rawDescription": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -51473,11 +51162,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, "body": { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -51487,7 +51176,7 @@ "childParamsGroups": [] }, "assignee": { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -51522,12 +51211,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, "labels": { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -51602,44 +51291,6 @@ "categoryLabel": "Issues", "notes": [], "descriptionHTML": "

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

    ", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response", - "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], "bodyParameters": [ { "oneOf": [ @@ -51655,11 +51306,11 @@ "name": "title", "in": "body", "rawDescription": "The title of the issue.", - "type": "string or integer or nullable", + "type": "undefined or null", "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "description": "

    The contents of the issue.

    ", "nullable": true, "name": "body", @@ -51669,7 +51320,7 @@ "childParamsGroups": [] }, { - "type": "string or nullable", + "type": "string or null", "nullable": true, "description": "

    Login for the user that this issue should be assigned to. This field is deprecated.

    ", "name": "assignee", @@ -51704,12 +51355,12 @@ "nullable": true, "name": "milestone", "in": "body", - "description": "

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

    ", - "type": "string or integer or nullable", + "type": "undefined or null", + "description": "

    undefined

    ", "childParamsGroups": [] }, { - "type": "array of strings or array of objects", + "type": "array of undefineds", "description": "

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

    ", "items": { "oneOf": [ @@ -51755,6 +51406,44 @@ "rawDescription": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
    {\n  \"id\": 1,\n  \"node_id\": \"MDU6SXNzdWUx\",\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n  \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n  \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n  \"number\": 1347,\n  \"state\": \"open\",\n  \"title\": \"Found a bug\",\n  \"body\": \"I'm having a problem with this.\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"labels\": [\n    {\n      \"id\": 208045946,\n      \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n      \"name\": \"bug\",\n      \"description\": \"Something isn't working\",\n      \"color\": \"f29513\",\n      \"default\": true\n    }\n  ],\n  \"assignee\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"assignees\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  ],\n  \"milestone\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n    \"id\": 1002604,\n    \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"title\": \"v1.0\",\n    \"description\": \"Tracking milestone for version 1.0\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"open_issues\": 4,\n    \"closed_issues\": 8,\n    \"created_at\": \"2011-04-10T20:09:31Z\",\n    \"updated_at\": \"2014-03-03T18:58:10Z\",\n    \"closed_at\": \"2013-02-12T13:22:01Z\",\n    \"due_on\": \"2012-10-09T23:39:01Z\"\n  },\n  \"locked\": true,\n  \"active_lock_reason\": \"too heated\",\n  \"comments\": 0,\n  \"pull_request\": {\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n    \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n    \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n  },\n  \"closed_at\": null,\n  \"created_at\": \"2011-04-22T13:33:48Z\",\n  \"updated_at\": \"2011-04-22T13:33:48Z\",\n  \"closed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"author_association\": \"COLLABORATOR\"\n}\n
    " + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } ] }, { @@ -52547,17 +52236,12 @@ "type": "object", "properties": { "labels": { - "type": "array of strings", + "type": "array", "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] + } } } }, @@ -52630,22 +52314,8 @@ "subcategory": "labels", "subcategoryLabel": "Labels", "notes": [], + "bodyParameters": [], "descriptionHTML": "", - "bodyParameters": [ - { - "type": "array of strings", - "minItems": 1, - "description": "

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    ", - "items": { - "type": "string" - }, - "name": "labels", - "in": "body", - "rawType": "array", - "rawDescription": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", - "childParamsGroups": [] - } - ], "responses": [ { "httpStatusCode": "200", @@ -56415,7 +56085,7 @@ "type": "object", "properties": { "cname": { - "type": "string or nullable", + "type": "string or null", "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "nullable": true, "name": "cname", @@ -56478,8 +56148,7 @@ ], "name": "source", "in": "body", - "type": "", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -56549,7 +56218,7 @@ "descriptionHTML": "

    Updates information for a GitHub AE Pages site. For more information, see \"About GitHub Pages.

    ", "bodyParameters": [ { - "type": "string or nullable", + "type": "string or null", "description": "

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

    ", "nullable": true, "name": "cname", @@ -56612,8 +56281,7 @@ ], "name": "source", "in": "body", - "type": "", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -57586,7 +57254,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -57678,7 +57346,7 @@ "name": "issue", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -59126,7 +58794,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -59271,7 +58939,7 @@ "name": "in_reply_to", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -60568,7 +60236,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -60577,7 +60245,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -60586,7 +60254,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -60595,7 +60263,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -60647,7 +60315,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -60656,7 +60324,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -60665,7 +60333,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -60674,7 +60342,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -60803,7 +60471,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "side": { @@ -60812,7 +60480,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_line": { @@ -60821,7 +60489,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "start_side": { @@ -60830,7 +60498,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -60882,7 +60550,7 @@ "name": "line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -60891,7 +60559,7 @@ "name": "side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -60900,7 +60568,7 @@ "name": "start_line", "in": "body", "rawType": "integer", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -60909,7 +60577,7 @@ "name": "start_side", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -61441,7 +61109,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -61482,7 +61150,7 @@ "name": "event", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -62481,7 +62149,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } } @@ -62532,7 +62200,7 @@ "name": "state", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ], @@ -65708,7 +65376,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [ { "parentName": "members", @@ -65817,7 +65485,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [ { "parentName": "members", @@ -66018,7 +65686,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [ { "parentName": "members", @@ -66127,7 +65795,7 @@ "name": "members", "in": "body", "rawType": "array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [ { "parentName": "members", @@ -66235,7 +65903,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "path": { @@ -66243,7 +65911,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "value": { @@ -66260,8 +65928,7 @@ ], "name": "value", "in": "body", - "type": "string or object or array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -66292,7 +65959,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -66300,7 +65967,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -66317,8 +65984,7 @@ ], "name": "value", "in": "body", - "type": "string or object or array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -66405,7 +66071,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, "path": { @@ -66413,7 +66079,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, "value": { @@ -66430,8 +66096,7 @@ ], "name": "value", "in": "body", - "type": "string or object or array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } }, @@ -66462,7 +66127,7 @@ "name": "op", "in": "body", "rawType": "string", - "description": "

    Required.

    ", + "description": "

    Required. undefined

    ", "childParamsGroups": [] }, { @@ -66470,7 +66135,7 @@ "name": "path", "in": "body", "rawType": "string", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] }, { @@ -66487,8 +66152,7 @@ ], "name": "value", "in": "body", - "type": "string or object or array", - "description": "", + "description": "

    undefined

    ", "childParamsGroups": [] } ] @@ -67571,7 +67235,7 @@ "childParamsGroups": [] }, "parent_team_id": { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -67656,7 +67320,7 @@ "childParamsGroups": [] }, { - "type": "integer or nullable", + "type": "integer or null", "description": "

    The ID of a team to set as the parent team.

    ", "nullable": true, "name": "parent_team_id", @@ -71009,7 +70673,7 @@ }, "twitter_username": { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -71106,7 +70770,7 @@ }, { "description": "

    The new Twitter username of the user.

    ", - "type": "string or nullable", + "type": "string or null", "example": "therealomarj", "nullable": true, "name": "twitter_username", @@ -73321,7 +72985,7 @@ "body": { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", @@ -73371,7 +73035,7 @@ { "description": "

    Body of the project

    ", "example": "This project represents the sprint of the first week in January", - "type": "string or nullable", + "type": "string or null", "nullable": true, "name": "body", "in": "body", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 1bc109dea..f559a276f 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -164348,11 +164348,6 @@ }, "deletable": { "type": "boolean" - }, - "warning": { - "type": "string", - "description": "Warning generated when processing the analysis", - "example": "123 results were ignored" } }, "required": [ @@ -164368,8 +164363,7 @@ "url", "sarif_id", "tool", - "deletable", - "warning" + "deletable" ] } }, @@ -164393,8 +164387,7 @@ "guid": null, "version": "2.4.0" }, - "deletable": true, - "warning": "" + "deletable": true }, { "ref": "refs/heads/my-branch", @@ -164413,8 +164406,7 @@ "guid": null, "version": "1.2.0" }, - "deletable": true, - "warning": "" + "deletable": true } ] } @@ -164634,11 +164626,6 @@ }, "deletable": { "type": "boolean" - }, - "warning": { - "type": "string", - "description": "Warning generated when processing the analysis", - "example": "123 results were ignored" } }, "required": [ @@ -164654,8 +164641,7 @@ "url", "sarif_id", "tool", - "deletable", - "warning" + "deletable" ] }, "examples": { @@ -164678,8 +164664,7 @@ "guid": null, "version": "2.4.0" }, - "deletable": true, - "warning": "" + "deletable": true } } } @@ -165006,7 +164991,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index f73b94856..deec716a6 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -145573,11 +145573,6 @@ }, "deletable": { "type": "boolean" - }, - "warning": { - "type": "string", - "description": "Warning generated when processing the analysis", - "example": "123 results were ignored" } }, "required": [ @@ -145593,8 +145588,7 @@ "url", "sarif_id", "tool", - "deletable", - "warning" + "deletable" ] } }, @@ -145618,8 +145612,7 @@ "guid": null, "version": "2.4.0" }, - "deletable": true, - "warning": "" + "deletable": true }, { "ref": "refs/heads/my-branch", @@ -145638,8 +145631,7 @@ "guid": null, "version": "1.2.0" }, - "deletable": true, - "warning": "" + "deletable": true } ] } @@ -145734,7 +145726,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 532bac826..5044440c1 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -150856,11 +150856,6 @@ }, "deletable": { "type": "boolean" - }, - "warning": { - "type": "string", - "description": "Warning generated when processing the analysis", - "example": "123 results were ignored" } }, "required": [ @@ -150876,8 +150871,7 @@ "url", "sarif_id", "tool", - "deletable", - "warning" + "deletable" ] } }, @@ -150901,8 +150895,7 @@ "guid": null, "version": "2.4.0" }, - "deletable": true, - "warning": "" + "deletable": true }, { "ref": "refs/heads/my-branch", @@ -150921,8 +150914,7 @@ "guid": null, "version": "1.2.0" }, - "deletable": true, - "warning": "" + "deletable": true } ] } @@ -151017,7 +151009,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 2e50c3ce4..e4fa0a176 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -131000,11 +131000,6 @@ }, "deletable": { "type": "boolean" - }, - "warning": { - "type": "string", - "description": "Warning generated when processing the analysis", - "example": "123 results were ignored" } }, "required": [ @@ -131020,8 +131015,7 @@ "url", "sarif_id", "tool", - "deletable", - "warning" + "deletable" ] } }, @@ -131045,8 +131039,7 @@ "guid": null, "version": "2.4.0" }, - "deletable": true, - "warning": "" + "deletable": true }, { "ref": "refs/heads/my-branch", @@ -131065,8 +131058,7 @@ "guid": null, "version": "1.2.0" }, - "deletable": true, - "warning": "" + "deletable": true } ] } @@ -131286,11 +131278,6 @@ }, "deletable": { "type": "boolean" - }, - "warning": { - "type": "string", - "description": "Warning generated when processing the analysis", - "example": "123 results were ignored" } }, "required": [ @@ -131306,8 +131293,7 @@ "url", "sarif_id", "tool", - "deletable", - "warning" + "deletable" ] }, "examples": { @@ -131330,8 +131316,7 @@ "guid": null, "version": "2.4.0" }, - "deletable": true, - "warning": "" + "deletable": true } } } @@ -131425,7 +131410,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" diff --git a/middleware/categories-for-support.js b/middleware/categories-for-support.js deleted file mode 100644 index b577d012b..000000000 --- a/middleware/categories-for-support.js +++ /dev/null @@ -1,55 +0,0 @@ -const path = require('path') -const renderOpts = { textOnly: true, encodeEntities: true } - -// This middleware exposes a list of all categories and child articles at /categories.json. -// GitHub Support uses this for internal ZenDesk search functionality. -module.exports = async function categoriesForSupport (req, res, next) { - const englishSiteTree = req.context.siteTree.en - - const allCategories = [] - - await Promise.all(Object.keys(englishSiteTree).map(async (version) => { - await Promise.all(englishSiteTree[version].childPages.map(async (productPage) => { - if (productPage.page.relativePath.startsWith('early-access')) return - if (!productPage.childPages) return - - await Promise.all(productPage.childPages.map(async (categoryPage) => { - // We can't get the rendered titles from middleware/render-tree-titles - // here because that middleware only runs on the current version, and this - // middleware processes all versions. - const name = categoryPage.page.title.includes('{') - ? await categoryPage.page.renderProp('title', req.context, renderOpts) - : categoryPage.page.title - - allCategories.push({ - name, - published_articles: await findArticlesPerCategory(categoryPage, [], req.context) - }) - })) - })) - })) - - return res.json(allCategories) -} - -async function findArticlesPerCategory (currentPage, articlesArray, context) { - if (currentPage.page.documentType === 'article') { - const title = currentPage.page.title.includes('{') - ? await currentPage.page.renderProp('title', context, renderOpts) - : currentPage.page.title - - articlesArray.push({ - title, - slug: path.basename(currentPage.href) - }) - } - - if (!currentPage.childPages) return articlesArray - - // Run recursively to find any articles deeper in the tree. - await Promise.all(currentPage.childPages.map(async (childPage) => { - await findArticlesPerCategory(childPage, articlesArray, context) - })) - - return articlesArray -} diff --git a/middleware/context.js b/middleware/context.js index ec9c94c85..7ec21bb78 100644 --- a/middleware/context.js +++ b/middleware/context.js @@ -10,7 +10,7 @@ const { getPathWithoutLanguage } = require('../lib/path-utils') const productNames = require('../lib/product-names') -const warmServer = process.env.FEATURE_NEW_SITETREE ? require('../lib/warm-server2') : require('../lib/warm-server') +const warmServer = require('../lib/warm-server') const featureFlags = Object.keys(require('../feature-flags')) const builtAssets = require('../lib/built-asset-urls') const searchVersions = require('../lib/search/versions') @@ -27,7 +27,7 @@ module.exports = async function contextualize (req, res, next) { // make feature flag environment variables accessible in layouts req.context.process = { env: {} } featureFlags.forEach(featureFlagName => { - req.context[featureFlagName] = process.env[featureFlagName] + req.context.process.env[featureFlagName] = process.env[featureFlagName] }) // define each context property explicitly for code-search friendliness @@ -54,7 +54,6 @@ module.exports = async function contextualize (req, res, next) { if (productMap[req.context.currentProduct]) { req.context.productCodeExamples = req.context.site.data.variables[`${productMap[req.context.currentProduct].id}_code_examples`] req.context.productCommunityExamples = req.context.site.data.variables[`${productMap[req.context.currentProduct].id}_community_examples`] - req.context.productUserExamples = req.context.site.data.variables[`${productMap[req.context.currentProduct].id}_user_examples`] } // JS + CSS asset paths diff --git a/middleware/contextualizers/breadcrumbs.js b/middleware/contextualizers/breadcrumbs.js deleted file mode 100644 index 2eccfd0e4..000000000 --- a/middleware/contextualizers/breadcrumbs.js +++ /dev/null @@ -1,38 +0,0 @@ -module.exports = async function breadcrumbs (req, res, next) { - if (!req.context.page) return next() - if (req.context.page.hidden) return next() - - req.context.breadcrumbs = [] - - // Return an empty array on the landing page. - if (req.context.page.documentType === 'homepage') { - return next() - } - - const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion] - - await createBreadcrumb( - // Array of child pages on the root, i.e., the product level. - currentSiteTree.childPages, - req.context - ) - - return next() -} - -async function createBreadcrumb (pageArray, context) { - // Find each page in the siteTree's array of child pages that starts with the requested path. - const childPage = pageArray.find(page => context.currentPath.startsWith(page.href)) - - context.breadcrumbs.push({ - documentType: childPage.page.documentType, - href: childPage.href, - title: childPage.renderedShortTitle || childPage.renderedFullTitle - }) - - // Recursively loop through the siteTree and create each breadcrumb, until we reach the - // point where the current siteTree page is the same as the requested page. Then stop. - if (childPage.childPages && context.currentPath !== childPage.href) { - createBreadcrumb(childPage.childPages, context) - } -} diff --git a/middleware/contextualizers/current-product-tree.js b/middleware/contextualizers/current-product-tree.js deleted file mode 100644 index 92d0cb03d..000000000 --- a/middleware/contextualizers/current-product-tree.js +++ /dev/null @@ -1,10 +0,0 @@ -module.exports = function currentProductTree (req, res, next) { - if (!req.context.page) return next() - if (req.context.page.documentType === 'homepage') return next() - - const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion] - - req.context.currentProductTree = currentSiteTree.childPages.find(page => req.context.currentPath.startsWith(page.href)) - - return next() -} diff --git a/middleware/contextualizers/early-access-breadcrumbs.js b/middleware/contextualizers/early-access-breadcrumbs.js deleted file mode 100644 index 21f1a0aee..000000000 --- a/middleware/contextualizers/early-access-breadcrumbs.js +++ /dev/null @@ -1,55 +0,0 @@ -module.exports = async function breadcrumbs (req, res, next) { - if (!req.context.page) return next() - if (!req.context.page.hidden) return next() - - req.context.breadcrumbs = [] - - // Return an empty array on the landing page. - if (req.context.page.documentType === 'homepage') { - return next() - } - - const earlyAccessProduct = req.context.siteTree[req.language][req.context.currentVersion].childPages.find(childPage => childPage.page.relativePath === 'early-access/index.md') - if (!earlyAccessProduct) return next() - - // Create initial landing page breadcrumb - req.context.breadcrumbs.push({ - documentType: earlyAccessProduct.page.documentType, - href: '', - title: earlyAccessProduct.page.title - }) - - // If this is the Early Access landing page, return now - if (req.context.currentPath === earlyAccessProduct.href) { - return next() - } - - // Otherwise, create breadcrumbs - await createBreadcrumb( - earlyAccessProduct.childPages, - req.context - ) - - return next() -} - -async function createBreadcrumb (pageArray, context) { - // Find each page in the siteTree's array of child pages that starts with the requested path. - const childPage = pageArray.find(page => context.currentPath.startsWith(page.href)) - - // Gray out product breadcrumb links and `Articles` categories - const hideHref = childPage.page.documentType === 'product' || - (childPage.page.documentType === 'category' && childPage.page.relativePath.endsWith('/articles/index.md')) - - context.breadcrumbs.push({ - documentType: childPage.page.documentType, - href: hideHref ? '' : childPage.href, - title: await childPage.page.renderTitle(context, { textOnly: true, encodeEntities: true }) - }) - - // Recursively loop through the siteTree and create each breadcrumb, until we reach the - // point where the current siteTree page is the same as the requested page. Then stop. - if (childPage.childPages && context.currentPath !== childPage.href) { - createBreadcrumb(childPage.childPages, context) - } -} diff --git a/middleware/contextualizers/early-access-links.js b/middleware/contextualizers/early-access-links.js index b30090a07..f09c68f1d 100644 --- a/middleware/contextualizers/early-access-links.js +++ b/middleware/contextualizers/early-access-links.js @@ -7,7 +7,7 @@ module.exports = function earlyAccessContext (req, res, next) { // Get a list of all hidden pages per version const earlyAccessPageLinks = uniq(Object.values(req.context.pages) - .filter(page => page.hidden && page.relativePath.startsWith('early-access') && !page.relativePath.endsWith('index.md')) + .filter(page => page.hidden && page.relativePath.startsWith('early-access') && page.relativePath !== 'early-access/index.md') .map(page => page.permalinks) .flat()) // Get links for the current version diff --git a/middleware/contextualizers/generic-toc.js b/middleware/contextualizers/generic-toc.js deleted file mode 100644 index 9ebcee7d0..000000000 --- a/middleware/contextualizers/generic-toc.js +++ /dev/null @@ -1,59 +0,0 @@ -const { sortBy } = require('lodash') - -module.exports = async function genericToc (req, res, next) { - if (!req.context.page) return next() - if (req.context.page.hidden) return next() - if (req.context.currentLayoutName !== 'default') return next() - if (req.context.page.documentType === 'homepage' || req.context.page.documentType === 'article') return next() - - const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion] - - // Find the array of child pages that start with the requested path. - const currentPageInSiteTree = findPageInSiteTree(currentSiteTree.childPages, req.context.currentPath) - - req.context.tocItems = sortBy( - await getUnsortedTocItems(currentPageInSiteTree.childPages, req.context), - // Sort by the ordered array of `children` in the frontmatter. - currentPageInSiteTree.page.children - ) - - return next() -} - -// Recursively loop through the siteTree until we reach the point where the -// current siteTree page is the same as the requested page. Then stop. -function findPageInSiteTree (pageArray, currentPath) { - const childPage = pageArray.find(page => currentPath.startsWith(page.href)) - - if (childPage.href === currentPath) { - return childPage - } - - return findPageInSiteTree(childPage.childPages, currentPath) -} - -async function getUnsortedTocItems (pageArray, context) { - return Promise.all(pageArray.map(async (childPage) => { - // return an empty string if it's a hidden link on a non-hidden page (hidden links on hidden pages are OK) - if (childPage.page.hidden && !context.page.hidden) { - return '' - } - - const fullPath = childPage.href - // Titles are already rendered by middleware/contextualizers/render-tree-titles.js. - const title = childPage.renderedFullTitle - const intro = await childPage.page.renderProp('intro', context, { unwrap: true }) - - if (!childPage.childPages) { - return { fullPath, title, intro } - } - - const childTocItems = sortBy( - await getUnsortedTocItems(childPage.childPages, context), - // Sort by the ordered array of `children` in the frontmatter. - childPage.page.children - ) - - return { fullPath, title, intro, childTocItems } - })) -} diff --git a/middleware/contextualizers/layout.js b/middleware/contextualizers/layout.js index 7a6051c2e..54c40540a 100644 --- a/middleware/contextualizers/layout.js +++ b/middleware/contextualizers/layout.js @@ -3,18 +3,20 @@ const layouts = require('../../lib/layouts') module.exports = function layoutContext (req, res, next) { if (!req.context.page) return next() - const layoutOptsByType = { + let layoutName + + if (req.context.page.layout) { // Layouts can be specified with a `layout` frontmatter value. // Any invalid layout values will be caught by frontmatter schema validation. - string: req.context.page.layout, + layoutName = req.context.page.layout // A `layout: false` value means use no layout. - boolean: '', - // For all other files (like articles and the homepage), use the `default` layout. - undefined: 'default' + } else if (req.context.page.layout === false) { + layoutName = '' + // If undefined, use either the default layout or the generic-toc layout. + } else if (req.context.page.layout === undefined) { + layoutName = 'default' } - const layoutName = layoutOptsByType[typeof (req.context.page.layout)] - // Attach to the context object req.context.currentLayoutName = layoutName req.context.currentLayout = layouts[layoutName] diff --git a/middleware/contextualizers/render-tree-titles.js b/middleware/contextualizers/render-tree-titles.js deleted file mode 100644 index 0d71ae50d..000000000 --- a/middleware/contextualizers/render-tree-titles.js +++ /dev/null @@ -1,33 +0,0 @@ -const { sortBy } = require('lodash') -const renderOpts = { textOnly: true, encodeEntities: true } - -module.exports = async function renderTreeTitles (req, res, next) { - if (!req.context.page) return next() - if (req.context.page.documentType === 'homepage') return next() - - await renderLiquidInTitles(req.context.siteTree[req.context.currentLanguage][req.context.currentVersion], req.context) - - return next() -} - -// Add new props to each siteTree page here... -async function renderLiquidInTitles (pageInTree, context) { - // We _only_ need to render the titles and shortTitles that contain Liquid. - pageInTree.renderedFullTitle = pageInTree.page.title.includes('{') - ? await pageInTree.page.renderProp('title', context, renderOpts) - : pageInTree.page.title - - if (pageInTree.page.shortTitle) { - pageInTree.renderedShortTitle = pageInTree.page.shortTitle.includes('{') - ? await pageInTree.page.renderProp('shortTitle', context, renderOpts) - : pageInTree.page.shortTitle - } - - if (!pageInTree.childPages) return - - pageInTree.page.childPages = sortBy( - await Promise.all(pageInTree.childPages.map(async (childPage) => await renderLiquidInTitles(childPage, context))), - // Sort by the ordered array of `children` in the frontmatter. - pageInTree.page.children - ) -} diff --git a/middleware/index.js b/middleware/index.js index cb70213a7..e6cacac9a 100644 --- a/middleware/index.js +++ b/middleware/index.js @@ -97,12 +97,7 @@ module.exports = function (app) { app.use(asyncMiddleware(instrument('./archived-enterprise-versions'))) app.use(instrument('./robots')) app.use(/(\/.*)?\/early-access$/, instrument('./contextualizers/early-access-links')) - if (!process.env.FEATURE_NEW_SITETREE) { - app.use('/categories.json', asyncMiddleware(instrument('./categories-for-support-team'))) - } - if (process.env.FEATURE_NEW_SITETREE) { - app.use('/categories.json', asyncMiddleware(instrument('./categories-for-support'))) - } + app.use('/categories.json', asyncMiddleware(instrument('./categories-for-support-team'))) app.use(instrument('./loaderio-verification')) app.get('/_500', asyncMiddleware(instrument('./trigger-error'))) @@ -116,20 +111,8 @@ module.exports = function (app) { app.use(instrument('./contextualizers/webhooks')) app.use(asyncMiddleware(instrument('./contextualizers/whats-new-changelog'))) app.use(instrument('./contextualizers/layout')) - - if (!process.env.FEATURE_NEW_SITETREE) { - app.use(asyncMiddleware(instrument('./breadcrumbs'))) - app.use(asyncMiddleware(instrument('./early-access-breadcrumbs'))) - } - - if (process.env.FEATURE_NEW_SITETREE) { - app.use(asyncMiddleware(instrument('./contextualizers/render-tree-titles'))) - app.use(instrument('./contextualizers/current-product-tree')) - app.use(asyncMiddleware(instrument('./contextualizers/generic-toc'))) - app.use(asyncMiddleware(instrument('./contextualizers/breadcrumbs'))) - app.use(asyncMiddleware(instrument('./contextualizers/early-access-breadcrumbs'))) - } - + app.use(asyncMiddleware(instrument('./breadcrumbs'))) + app.use(asyncMiddleware(instrument('./early-access-breadcrumbs'))) app.use(asyncMiddleware(instrument('./enterprise-server-releases'))) app.use(asyncMiddleware(instrument('./dev-toc'))) app.use(asyncMiddleware(instrument('./featured-links'))) diff --git a/script/content-migrations/add-early-access-tocs.js b/script/content-migrations/add-early-access-tocs.js deleted file mode 100755 index 34d936f50..000000000 --- a/script/content-migrations/add-early-access-tocs.js +++ /dev/null @@ -1,44 +0,0 @@ -#!/usr/bin/env node - -const fs = require('fs') -const path = require('path') -const readFrontmatter = require('../../lib/read-frontmatter') -const earlyAccessDir = path.posix.join(process.cwd(), 'content', 'early-access') -const { sentenceCase } = require('change-case') - -updateOrCreateToc(earlyAccessDir) - -console.log('Updated Early Access TOCs!') - -function updateOrCreateToc (directory) { - const children = fs.readdirSync(directory) - .filter(subpath => !subpath.endsWith('index.md')) - - if (!children.length) return - - const tocFile = path.posix.join(directory, 'index.md') - - let content, data - - if (fs.existsSync(tocFile)) { - const matter = readFrontmatter(fs.readFileSync(tocFile, 'utf8')) - content = matter.content - data = matter.data - } else { - content = '' - data = { - title: sentenceCase(path.basename(directory)), - versions: '*', - hidden: true - } - } - - data.children = children.map(child => `/${child.replace('.md', '')}`) - const newContents = readFrontmatter.stringify(content, data, { lineWidth: 10000 }) - fs.writeFileSync(tocFile, newContents) - - children.forEach(child => { - if (child.endsWith('.md')) return - updateOrCreateToc(path.posix.join(directory, child)) - }) -} diff --git a/script/content-migrations/remove-map-topics.js b/script/content-migrations/remove-map-topics.js index ec24064da..7da04a8e4 100755 --- a/script/content-migrations/remove-map-topics.js +++ b/script/content-migrations/remove-map-topics.js @@ -3,7 +3,6 @@ const fs = require('fs') const path = require('path') const walk = require('walk-sync') -const stripHtmlComments = require('strip-html-comments') const languages = require('../../lib/languages') const frontmatter = require('../../lib/read-frontmatter') const addRedirectToFrontmatter = require('../../lib/redirects/add-redirect-to-frontmatter') @@ -27,10 +26,6 @@ const categoryIndexFiles = fullDirectoryPaths.map(fullDirectoryPath => walk(full categoryIndexFiles.forEach(categoryIndexFile => { let categoryIndexContent = fs.readFileSync(categoryIndexFile, 'utf8') - if (categoryIndexFile.endsWith('github/getting-started-with-github/index.md')) { - categoryIndexContent = stripHtmlComments(categoryIndexContent.replace(/\n$/m.test(line)) - - newContent = newLinesArray.join('\n') - // Index files should no longer have body content, so we write an empty string - fs.writeFileSync(indexFile, frontmatter.stringify(newContent, data, { lineWidth: 10000 })) + fs.writeFileSync(indexFile, frontmatter.stringify('', data, { lineWidth: 10000 })) }) function getLinks (linkItemArray) { diff --git a/script/rest/utils/operation.js b/script/rest/utils/operation.js index f2a6d6be0..c81f946aa 100644 --- a/script/rest/utils/operation.js +++ b/script/rest/utils/operation.js @@ -166,43 +166,8 @@ module.exports = class Operation { } async renderBodyParameterDescriptions () { - let bodyParamsObject = get(this, 'requestBody.content.application/json.schema.properties', {}) - let requiredParams = get(this, 'requestBody.content.application/json.schema.required', []) - const oneOfObject = get(this, 'requestBody.content.application/json.schema.oneOf', undefined) - - // oneOf is an array of input parameter options, so we need to either - // use the first option or munge the options together. - if (oneOfObject) { - const firstOneOfObject = oneOfObject[0] - const allOneOfAreObjects = oneOfObject - .filter(elem => elem.type === 'object') - .length === oneOfObject.length - - // TODO: Remove this check - // This operation shouldn't have a oneOf in this case, it needs to be - // removed from the schema in the github/github repo. - if (this.operationId === 'checks/create') { - delete bodyParamsObject.oneOf - } else if (allOneOfAreObjects) { - // When all of the oneOf objects have the `type: object` we - // need to display all of the parameters. - // This merges all of the properties and required values into the - // first requestBody object. - for (let i = 1; i < oneOfObject.length; i++) { - Object.assign(firstOneOfObject.properties, oneOfObject[i].properties) - requiredParams = firstOneOfObject.required - .concat(oneOfObject[i].required) - } - bodyParamsObject = firstOneOfObject.properties - } else if (oneOfObject) { - // When a oneOf exists but the `type` differs, the case has historically - // been that the alternate option is an array, where the first option - // is the array as a property of the object. We need to ensure that the - // first option listed is the most comprehensive and preferred option. - bodyParamsObject = firstOneOfObject.properties - requiredParams = firstOneOfObject.required - } - } + const bodyParamsObject = get(this, 'requestBody.content.application/json.schema.properties', {}) + const requiredParams = get(this, 'requestBody.content.application/json.schema.required', []) this.bodyParameters = await getBodyParams(bodyParamsObject, requiredParams) } @@ -246,57 +211,16 @@ async function getBodyParams (paramsObject, requiredParams) { param.rawType = param.type param.rawDescription = param.description - // Stores the types listed under the `Type` column in the `Parameters` - // table in the REST API docs. When the parameter contains oneOf - // there are multiple acceptable parameters that we should list. - const paramArray = [] - - const oneOfArray = param.oneOf - const isOneOfObjectOrArray = oneOfArray - ? oneOfArray.filter(elem => elem.type !== 'object' || elem.type !== 'array') - : false - - // When oneOf has the type array or object, the type is defined - // in a child object - if (oneOfArray && isOneOfObjectOrArray.length > 0) { - // Store the defined types - paramArray.push(oneOfArray - .filter(elem => elem.type) - .map(elem => elem.type) - ) - - // If an object doesn't have a description, it is invalid - const oneOfArrayWithDescription = oneOfArray.filter(elem => elem.description) - - // Use the parent description when set, otherwise enumerate each - // description in the `Description` column of the `Parameters` table. - if (!param.description && oneOfArrayWithDescription.length > 1) { - param.description = oneOfArray - .filter(elem => elem.description) - .map(elem => `**Type ${elem.type}** - ${elem.description}`) - .join('\n\n') - } else if (!param.description && oneOfArrayWithDescription.length === 1) { - // When there is only on valid description, use that one. - param.description = oneOfArrayWithDescription[0].description - } - } - - // Arrays require modifying the displayed type (e.g., array of strings) - if (param.type === 'array') { - if (param.items.type) paramArray.push(`array of ${param.items.type}s`) - if (param.items.oneOf) { - paramArray.push(param.items.oneOf - .map(elem => `array of ${elem.type}s`) - ) - } - } else if (param.type) { - paramArray.push(param.type) - } + // e.g. array of strings + param.type = param.type === 'array' + ? `array of ${param.items.type}s` + : param.type - if (param.nullable) paramArray.push('nullable') + // e.g. object or null + param.type = param.nullable + ? `${param.type} or null` + : param.type - param.type = paramArray.flat().join(' or ') - param.description = param.description || '' const isRequired = requiredParams && requiredParams.includes(param.name) const requiredString = isRequired ? '**Required**. ' : '' param.description = await renderContent(requiredString + param.description) @@ -321,9 +245,8 @@ async function getBodyParams (paramsObject, requiredParams) { } async function getChildParamsGroup (param) { - // only objects, arrays of objects, anyOf, allOf, and oneOf have child params - if (!(param.rawType === 'array' || param.rawType === 'object' || param.oneOf)) return - if (param.oneOf && !param.oneOf.filter(param => param.type === 'object' || param.type === 'array')) return + // only objects and arrays of objects ever have child params + if (!(param.rawType === 'array' || param.rawType === 'object')) return if (param.items && param.items.type !== 'object') return const childParamsObject = param.rawType === 'array' ? param.items.properties : param.properties diff --git a/stylesheets/article.scss b/stylesheets/article.scss index f7fdf6349..8533e1cb8 100644 --- a/stylesheets/article.scss +++ b/stylesheets/article.scss @@ -10,8 +10,8 @@ grid-template-rows: auto 1fr; grid-template-columns: minmax(500px, 720px) minmax(220px, 1fr); grid-template-areas: - "top right-sidebar" - "bottom right-sidebar"; + 'top right-sidebar' + 'bottom right-sidebar'; column-gap: $spacer-6; } @@ -45,6 +45,7 @@ /* Deprecation banner ------------------------------------------------------------------------------*/ .deprecation-banner { + & + .alert { margin-top: 5px; } @@ -57,21 +58,24 @@ margin-bottom: 0; } + + #bootcamp { + margin-top: 20px; + } + b, strong { font-weight: bold; } p { - margin: 0; + margin: 0; } } /* Code style overrides ------------------------------------------------------------------------------*/ -.markdown-body .highlight pre, -.markdown-body pre { +.markdown-body .highlight pre, .markdown-body pre { margin-top: 10px; } @@ -89,13 +93,12 @@ } } -.breadcrumbs a:not(:last-child)::after, -.breadcrumbs span:not(:last-child)::after { - content: "/"; +.breadcrumbs a:not(:last-child)::after, .breadcrumbs span:not(:last-child)::after { + content: '/'; color: var(--color-auto-gray-4); padding-right: $spacer-1; padding-left: $spacer-2; - display: inline-block; + display:inline-block; } /* Numbered procedures (step 1, step 2, ...) @@ -178,8 +181,7 @@ img[src*="https://github.githubassets.com/images/icons/emoji"] { .warning, .danger { // remove extra space under lists inside of notes - ul, - ol { + ul, ol { margin-bottom: 0; } } diff --git a/stylesheets/dev-toc.scss b/stylesheets/dev-toc.scss index b40f48cbb..6c16a24b8 100644 --- a/stylesheets/dev-toc.scss +++ b/stylesheets/dev-toc.scss @@ -11,4 +11,4 @@ ul.versions-list > li { details ul.products-list li { margin: 3px 0 0 30px; -} +} \ No newline at end of file diff --git a/stylesheets/directory.scss b/stylesheets/directory.scss new file mode 100644 index 000000000..67c9d0afb --- /dev/null +++ b/stylesheets/directory.scss @@ -0,0 +1,50 @@ +/* Styles for directory pages (any page that organizes categories and articles) +------------------------------------------------------------------------------*/ + +// Hoverable boxes on product pages +// Markup can be different and we need both selectors below +.directory-link-box:hover .Box, +.directory-link-box.Box:hover { + border: 1px solid var(--color-auto-blue-5); +} + +// Expandable grid is used on article listing pages +// e.g. enterprise/2.15/admin/installation +.directory-dropdown-grid { + display: grid; + grid-template-columns: 100%; + grid-column-gap: 48px; + grid-row-gap: 24px; + + @include breakpoint(lg) { + grid-template-columns: calc(50% - 24px) calc(50% - 24px); + } + + // Disable the grid row expanding from expanding a closed dropdown on desktop + @include breakpoint(lg) { + .dropdown-withArrow { + max-height: 74px; + + &[open] { + max-height: initial; + } + } + } +} + +// Product ToC list +.directory-toc { + h2 { + margin-top: $spacer-6; + + &:first-of-type { + margin-top: 0; + } + } + + h3 { + margin-top: 0; + padding-bottom: initial; + border-bottom: 0; + } +} diff --git a/stylesheets/gradient.scss b/stylesheets/gradient.scss index b6062ad72..a6e61d2f8 100644 --- a/stylesheets/gradient.scss +++ b/stylesheets/gradient.scss @@ -1,11 +1,6 @@ $gradients: ( - "-purple-pink": - linear-gradient( - 135deg, - var(--color-auto-purple-5) 0%, - var(--color-auto-pink-5) 100% - ), - /*"-aquamarine-mauve": linear-gradient(130deg, #3bf0e4 -6.8%, #bca1f7 70%), + "-purple-pink": linear-gradient(135deg, var(--color-auto-purple-5) 0%, var(--color-auto-pink-5) 100%), +/*"-aquamarine-mauve": linear-gradient(130deg, #3bf0e4 -6.8%, #bca1f7 70%), "-purple-coral": linear-gradient(87.54deg, #9867f0 -6.8%, #ed4e50 84.14%), "-purple-coral-dark": linear-gradient(92deg, #bca1f7 15%, #e577b4 45%, #ff7170 85%), "-coral-yellow": linear-gradient(267.91deg, #ffe57f 9.35%, #ff7170 96.48%), @@ -17,24 +12,9 @@ $gradients: ( "-blue-green": linear-gradient(-70deg, #2188ff 0%, #01a49e 100%), "-red-orange": linear-gradient(-70deg, #ed4e50 0%, #f06f00 100%), "-blue-purple": linear-gradient(-70deg, #2188ff 0%, #804eda 100%), */ - "-pink-blue": - linear-gradient( - 90deg, - var(--color-auto-pink-5) -50%, - var(--color-auto-blue-5) 150% - ), - "-pink-blue-dark": - linear-gradient( - -70deg, - var(--color-auto-pink-3) 0%, - var(--color-auto-blue-3) 100% - ), - "-blue-pink": - linear-gradient( - -70deg, - var(--color-auto-blue-5) 0%, - var(--color-auto-pink-5) 100% - ) + "-pink-blue": linear-gradient(90deg, var(--color-auto-pink-5) -50%, var(--color-auto-blue-5) 150%), + "-pink-blue-dark": linear-gradient(-70deg, var(--color-auto-pink-3) 0%, var(--color-auto-blue-3) 100%), + "-blue-pink": linear-gradient(-70deg, var(--color-auto-blue-5) 0%, var(--color-auto-pink-5) 100%) ) !default; @mixin bg-gradient($parent, $gradient) { @@ -43,9 +23,8 @@ $gradients: ( } } -/* @mixin text-gradient($parent, $gradient) { - #{parent} { + #{$parent} { background-image: $gradient; -webkit-background-clip: text; background-clip: text; @@ -53,7 +32,6 @@ $gradients: ( color: transparent; } } -*/ $border-width: 2px; @mixin border-gradient($parent, $gradient) { @@ -93,11 +71,9 @@ $border-width: 2px; @include bg-gradient(".bg-gradient-#{$gradient}", $value); } -/* @each $gradient, $value in $gradients { - @include text-gradient(".text-gradient-#{gradient}", $value); + @include text-gradient(".text-gradient-#{$gradient}", $value); } -*/ @each $gradient, $value in $gradients { @include border-gradient(".border-gradient-#{$gradient}", $value); diff --git a/stylesheets/index.scss b/stylesheets/index.scss index 839832056..5408f708c 100644 --- a/stylesheets/index.scss +++ b/stylesheets/index.scss @@ -1,9 +1,39 @@ -@import "@primer/css/core/index.scss"; +// Import modules needed from Primer (stored in local `node_modules` directory) +@import "@primer/css/support/index.scss"; + +// BEGIN CUSTOM CORE IMPORT +// Normally we would just import @primer/css/core/index.scss, but that file +// currently imports @primer/css/layout/index.scss, which in turn imports +// @primer/css/layout/columns.scss, which has deprecated styles that litter +// the logs with warnings. We're not using those styles, so the warnings are +// avoided here by not importing the file. +// +// TODO: Use a simple core import when https://github.com/primer/css/issues/741 is resolved +@import "@primer/css/base/index.scss"; +@import "@primer/css/box/index.scss"; +@import "@primer/css/buttons/index.scss"; +@import "@primer/css/forms/index.scss"; + +// BEGIN CUSTOM LAYOUT IMPORT +@import "@primer/css/support/index.scss"; +@import "@primer/css/layout/container.scss"; +// @import "@primer/css/layout/columns.scss"; <-- deprecated and unused +@import "@primer/css/layout/grid.scss"; +@import "@primer/css/layout/grid-offset.scss"; +// END CUSTOM LAYOUT IMPORT + +@import "@primer/css/navigation/index.scss"; +@import "@primer/css/pagination/index.scss"; +@import "@primer/css/tooltips/index.scss"; +@import "@primer/css/truncate/index.scss"; +@import "@primer/css/utilities/index.scss"; +@import "@primer/css/avatars/index.scss"; +// END CUSTOM CORE IMPORT + @import "@primer/css/markdown/index.scss"; @import "@primer/css/forms/index.scss"; @import "@primer/css/navigation/index.scss"; @import "@primer/css/labels/index.scss"; -@import "@primer/css/avatars/avatar.scss"; $marketing-font-path: "/dist/fonts/"; @import "@primer/css/marketing/index.scss"; @@ -12,12 +42,14 @@ $marketing-font-path: "/dist/fonts/"; @import "new-mktg.scss"; @import "type.scss"; @import "nav.scss"; +@import "directory.scss"; @import "article.scss"; @import "search.scss"; @import "overrides.scss"; @import "sidebar.scss"; @import "scroll-button.scss"; @import "explorer.scss"; +// from https://unpkg.com/highlight.js@9.15.8/styles/github.css @import "syntax-highlighting.scss"; @import "tables.scss"; @import "opacity.scss"; diff --git a/stylesheets/nav.scss b/stylesheets/nav.scss index 9271120e1..f7c8a9fd5 100644 --- a/stylesheets/nav.scss +++ b/stylesheets/nav.scss @@ -46,14 +46,14 @@ header summary, } .nav-mobile-burgerIcon { - background: url("/assets/images/octicons/hamburger.svg") no-repeat right; + background: url('/assets/images/octicons/hamburger.svg') no-repeat right; width: 18px; height: 23px; position: relative; z-index: 3; &.js-open { - background: url("/assets/images/octicons/x.svg") no-repeat right; + background: url('/assets/images/octicons/x.svg') no-repeat right; width: 16px; height: 21px; } @@ -91,7 +91,7 @@ header summary, } } -.nav-dropdown { +.nav-dropdown { @media (min-width: 1012px) and (max-width: 1279px) { right: 0; } diff --git a/stylesheets/new-mktg.scss b/stylesheets/new-mktg.scss index ecef50779..6d5c56e10 100644 --- a/stylesheets/new-mktg.scss +++ b/stylesheets/new-mktg.scss @@ -1,15 +1,23 @@ /* Styles not incorporated into Primer yet ------------------------------------------------------------------------------*/ +// Position utils +@media (min-width: $width-lg) { + .top-lg-n9 { + top: -$spacer-9; + } +} + +// Type +.color-text-link-mktg { + color: var(--color-auto-blue-5) !important; +} + // Text styling .underline-dashed { display: inline; padding-bottom: $spacer-1; - background-image: linear-gradient( - to right, - var(--color-auto-gray-3) 50%, - transparent 0% - ); + background-image: linear-gradient(to right, var(--color-auto-gray-3) 50%, transparent 0%); background-repeat: repeat-x; background-position: bottom; background-size: 10px 1px; @@ -43,9 +51,7 @@ // Typography $marketing-font-path: "/assets/fonts/alliance/"; -$font-family-mktg: "Alliance No.1", -apple-system, BlinkMacSystemFont, - "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", - "Segoe UI Emoji", "Segoe UI Symbol" !default; +$font-family-mktg: "Alliance No.1", -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol" !default; $font-weight-extrabold: 800 !default; .font-mktg { @@ -57,8 +63,7 @@ $font-weight-extrabold: 800 !default; font-family: "Alliance No.1"; font-style: normal; font-weight: $font-weight-normal; - src: local("Alliance No.1 Regular"), local("alliance-no-1-regular"), - url("#{$marketing-font-path}alliance-no-1-regular.woff") format("woff"); + src: local("Alliance No.1 Regular"), local("alliance-no-1-regular"), url("#{$marketing-font-path}alliance-no-1-regular.woff") format("woff"); font-display: swap; } @@ -66,8 +71,7 @@ $font-weight-extrabold: 800 !default; font-family: "Alliance No.1"; font-style: normal; font-weight: $font-weight-semibold; - src: local("Alliance No.1 Medium"), local("alliance-no-1-medium"), - url("#{$marketing-font-path}alliance-no-1-medium.woff") format("woff"); + src: local("Alliance No.1 Medium"), local("alliance-no-1-medium"), url("#{$marketing-font-path}alliance-no-1-medium.woff") format("woff"); font-display: swap; } @@ -75,8 +79,7 @@ $font-weight-extrabold: 800 !default; font-family: "Alliance No.1"; font-style: normal; font-weight: $font-weight-bold; - src: local("Alliance No.1 Bold"), local("alliance-no-1-bold"), - url("#{$marketing-font-path}alliance-no-1-bold.woff") format("woff"); + src: local("Alliance No.1 Bold"), local("alliance-no-1-bold"), url("#{$marketing-font-path}alliance-no-1-bold.woff") format("woff"); font-display: swap; } @@ -84,7 +87,6 @@ $font-weight-extrabold: 800 !default; font-family: "Alliance No.1"; font-style: normal; font-weight: $font-weight-extrabold; - src: local("Alliance No.1 ExtraBold"), local("alliance-no-1-extrabold"), - url("#{$marketing-font-path}alliance-no-1-extrabold.woff") format("woff"); + src: local("Alliance No.1 ExtraBold"), local("alliance-no-1-extrabold"), url("#{$marketing-font-path}alliance-no-1-extrabold.woff") format("woff"); font-display: swap; } diff --git a/stylesheets/opacity.scss b/stylesheets/opacity.scss index a2b96b4cd..74f81ddef 100644 --- a/stylesheets/opacity.scss +++ b/stylesheets/opacity.scss @@ -1,6 +1,11 @@ -.opacity-60 { - opacity: 0.6; -} -.opacity-70 { - opacity: 0.7; -} +.opacity-0 { opacity: 0; } +.opacity-10 { opacity: 0.1; } +.opacity-80 { opacity: 0.2; } +.opacity-30 { opacity: 0.3; } +.opacity-40 { opacity: 0.4; } +.opacity-50 { opacity: 0.5; } +.opacity-60 { opacity: 0.6; } +.opacity-70 { opacity: 0.7; } +.opacity-80 { opacity: 0.8; } +.opacity-90 { opacity: 0.9; } +.opacity-100 { opacity: 1; } \ No newline at end of file diff --git a/stylesheets/overrides.scss b/stylesheets/overrides.scss index 30f3389ca..b898027c7 100644 --- a/stylesheets/overrides.scss +++ b/stylesheets/overrides.scss @@ -14,7 +14,6 @@ } } -// NB: Note that there's also overlapping styling in "article.scss" .markdown-body ol > li { padding: $spacer-2 0 $spacer-2 $spacer-7; border: 0; @@ -32,6 +31,7 @@ .extended-markdown { margin-top: 15px; } + } .markdown-body ul ul, @@ -65,18 +65,21 @@ color: var(--color-text-primary); } -.product-callout p, -.contributor-callout p { +.product-callout p, .contributor-callout p { margin: 0; } -// Largely overwritten in tables.scss .markdown-body table { display: table; table-layout: fixed; line-height: 1.5; } +li.nestedTocItem { + margin-left: 2em; + list-style-type: circle; +} + /* Getting Started and Popular Articles sections in article layout */ .markdown-body div.featured-links { padding-bottom: 30px; @@ -94,6 +97,12 @@ margin-top: 0; } +.octicon { + display: inline-block; + vertical-align: text-top; + fill: currentColor; +} + /* code styles */ pre .redbox { border: 2px solid var(--color-auto-red-5); @@ -116,6 +125,27 @@ pre .bluebox { margin-right: 2px; } +/* Accessibility color contrast */ +.btn-mktg { + background-color: var(--color-auto-blue-5); +} + +/* Accessibility color contrast */ +.btn-outline-mktg { + background-color: var(--color-auto-inverse); + color: var(--color-auto-blue-5); +} + +/* Accessibility color contrast */ +.color-bg-danger a { + color: var(--color-auto-blue-6); +} + +/* Accessibility color contrast */ +.markdown-body .color-bg-info blockquote { + color: var(--color-auto-gray-6); +} + /* Helpfulness survey override */ :checked + .x-radio-label { background: var(--color-auto-blue-5); diff --git a/stylesheets/product-landing.scss b/stylesheets/product-landing.scss index 65d0369fe..2024e1b43 100644 --- a/stylesheets/product-landing.scss +++ b/stylesheets/product-landing.scss @@ -1,7 +1,3 @@ .bg-guides-gradient { - background: linear-gradient( - 0deg, - var(--color-auto-blue-0) 0%, - transparent 100% - ); + background: linear-gradient(0deg, var(--color-auto-blue-0) 0%, transparent 100%); } diff --git a/stylesheets/product-sublanding.scss b/stylesheets/product-sublanding.scss index 200145b89..f3e5cb633 100644 --- a/stylesheets/product-sublanding.scss +++ b/stylesheets/product-sublanding.scss @@ -6,7 +6,7 @@ .learning-track { &--description { - min-height: 1em * $body-line-height * 3; + min-height: 1em * $body-line-height * 3 } } @@ -17,12 +17,10 @@ .step-circle-text { color: var(--color-auto-purple-5); } - .description-text { opacity: 0.7; line-height: 1.8em; } - .uppercase-category-text { letter-spacing: 0.08em; font-size: 0.8em; @@ -41,14 +39,27 @@ @include truncate(3); @include truncate(8); + .fade-background-left { - background: linear-gradient(to right, var(--color-bg-tertiary), transparent); + background: linear-gradient( + to right, + var(--color-bg-tertiary), + transparent + ); } .fade-background-right { - background: linear-gradient(to left, var(--color-bg-tertiary), transparent); + background: linear-gradient( + to left, + var(--color-bg-tertiary), + transparent + ); } .fade-background-bottom { - background: linear-gradient(to top, var(--color-bg-tertiary), transparent); + background: linear-gradient( + to top, + var(--color-bg-tertiary), + transparent + ); } diff --git a/stylesheets/release-notes.scss b/stylesheets/release-notes.scss index ba3397dde..7470f3132 100644 --- a/stylesheets/release-notes.scss +++ b/stylesheets/release-notes.scss @@ -1,15 +1,15 @@ ul.release-notes-list li.release-notes-list-item { font-size: 15px !important; - &::marker { + &::marker { // `• ` - content: "\2022\00a0\00a0\00a0\00a0"; + content: '\2022\00a0\00a0\00a0\00a0'; font-size: 1.6em; color: var(--color-auto-gray-4); } &.list-style-none::marker { - content: ""; + content: ''; } } @@ -17,9 +17,7 @@ ul.release-notes-list li.release-notes-list-item { font-size: 15px !important; } -details[open].release-notes-version-picker - summary - .octicon.octicon-chevron-down { +details[open].release-notes-version-picker summary .octicon.octicon-chevron-down { transform: rotate(180deg); } @@ -29,7 +27,7 @@ details[open].release-notes-version-picker } } -$colors-list: ( +$colors-list:( features: var(--color-auto-green-5), bugs: var(--color-auto-yellow-5), known_issues: var(--color-auto-blue-5), @@ -39,12 +37,11 @@ $colors-list: ( backups: var(--color-auto-orange-5) ); -@each $key, $val in $colors-list { +@each $key,$val in $colors-list{ .release-notes-section-#{$key} { .release-notes-section-label { background-color: #{$val}; } - .release-notes-section-heading { color: #{$val}; } diff --git a/stylesheets/scroll-button.scss b/stylesheets/scroll-button.scss index 4f49d3653..d2fe257a8 100644 --- a/stylesheets/scroll-button.scss +++ b/stylesheets/scroll-button.scss @@ -1,19 +1,18 @@ button.arrow-for-scrolling-top { - opacity: 0; - transition: 1s; - background-color: var(--color-auto-blue-5); - color: var(--color-text-inverse); - position: fixed; - bottom: 10px; - right: 10px; - display: block; - width: 40px; - height: 40px; - border-radius: 50%; - - &.show { - opacity: 1; - border: none; + opacity: 0; transition: 1s; - } + background-color: var(--color-auto-blue-5); + color: var(--color-text-inverse); + position: fixed; + bottom: 10px; + right: 10px; + display: block; + width: 40px; + height: 40px; + border-radius: 50%; + &.show { + opacity: 1; + border: none; + transition: 1s; + } } diff --git a/stylesheets/search.scss b/stylesheets/search.scss index 1219f5280..0972cd31b 100644 --- a/stylesheets/search.scss +++ b/stylesheets/search.scss @@ -22,8 +22,31 @@ Form and inputs using .ais- prefix gets added by search.js */ padding: 10px $spacer-2 10px $spacer-5; font-size: 16px; @extend .form-control; - background: var(--color-bg-primary) url("/assets/images/octicons/search.svg") - no-repeat 6px; + background: var(--color-bg-primary) url("/assets/images/octicons/search.svg") no-repeat 6px; +} + +.ais-SearchBox-reset { + width: 30px; + height: 100%; + position: absolute; + top: 0; + right: 0; + opacity: 0.5; + border: none; + outline: none; + background: none; + z-index: 1; + + @include breakpoint(md) { + header & { + height: 30px; + } + } + + .ais-SearchBox-resetIcon { + width: 12px; + height: 12px; + } } .ais-Hits-item { @@ -47,7 +70,8 @@ Form and inputs using .ais- prefix gets added by search.js */ } mark, -.ais-Highlight-highlighted { +.ais-Highlight-highlighted +{ background: none; color: inherit; diff --git a/stylesheets/shadows.scss b/stylesheets/shadows.scss index 63af06627..c3f05069d 100644 --- a/stylesheets/shadows.scss +++ b/stylesheets/shadows.scss @@ -1,5 +1,5 @@ .hover-shadow { - /* & { + & { transition: box-shadow 0.3s ease-in-out; &:hover { @@ -13,7 +13,7 @@ &:hover { box-shadow: var(--color-shadow-medium) !important; } - } */ + } &-large { transition: box-shadow 0.3s ease-in-out; @@ -23,11 +23,11 @@ } } - /* &-extra-large { + &-extra-large { transition: box-shadow 0.3s ease-in-out; &:hover { box-shadow: var(--color-shadow-extra-large) !important; } - } */ + } } diff --git a/stylesheets/sidebar.scss b/stylesheets/sidebar.scss index dcfcd8e58..5b7a13670 100644 --- a/stylesheets/sidebar.scss +++ b/stylesheets/sidebar.scss @@ -46,6 +46,8 @@ .sidebar-category, .sidebar-maptopic, .sidebar-article { + &.active > a { + } &.is-current-page > a { color: var(--color-auto-blue-3); } @@ -58,7 +60,6 @@ .sidebar-maptopic { .sidebar-article { position: relative; - &::before { content: ""; position: absolute; @@ -68,7 +69,6 @@ width: 1px; top: 0; } - &.active { &::before { border-left: 3px solid var(--color-auto-blue-7); diff --git a/stylesheets/tables.scss b/stylesheets/tables.scss index f402041bf..72b039ba3 100644 --- a/stylesheets/tables.scss +++ b/stylesheets/tables.scss @@ -34,7 +34,7 @@ vertical-align: top; z-index: 1; top: 0; - background: var(--color-bg-primary); + background: var(--color-bg-tertiary); box-shadow: 0 3px 0 0 var(--color-auto-gray-4); padding: 12px 8px; border: 0px; diff --git a/stylesheets/type.scss b/stylesheets/type.scss index 9811628ba..13b427b55 100644 --- a/stylesheets/type.scss +++ b/stylesheets/type.scss @@ -25,7 +25,6 @@ summary { display: inline-block; margin-top: 10px; margin-bottom: 10px; - p { margin: 0; padding: 0; @@ -38,4 +37,8 @@ summary { // except those on each product's toc h3 a { color: var(--color-auto-blue-5); + + .directory-toc & { + color: var(--color-auto-gray-9); + } } diff --git a/tests/rendering/server.js b/tests/rendering/server.js index 249730fba..ef799005a 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -191,8 +191,8 @@ describe('server', () => { test('renders product frontmatter callouts', async () => { const $ = await getDOM('/en/articles/about-branch-restrictions') const note = $('.product-callout').eq(0) - expect(note.hasClass('color-border-success')).toBe(true) - expect(note.hasClass('color-bg-success')).toBe(true) + expect(note.hasClass('color-border-info')).toBe(true) + expect(note.hasClass('color-bg-info')).toBe(true) }) test('renders liquid within liquid within product frontmatter callouts', async () => { diff --git a/tests/unit/liquid-helpers.js b/tests/unit/liquid-helpers.js index 8ca42fbb8..d686149f5 100644 --- a/tests/unit/liquid-helpers.js +++ b/tests/unit/liquid-helpers.js @@ -107,7 +107,7 @@ describe('liquid helper tags', () => { describe('indented_data_reference tag', () => { test('without any number of spaces specified', async () => { - const template = '{% indented_data_reference reusables.example %}' + const template = '{% indented_data_reference site.data.reusables.example %}' const expected = ` a rose by any other name would smell as sweet` const output = await liquid.parseAndRender(template, context) @@ -115,7 +115,7 @@ describe('liquid helper tags', () => { }) test('with 0 spaces specified', async () => { - const template = '{% indented_data_reference reusables.example spaces=0 %}' + const template = '{% indented_data_reference site.data.reusables.example spaces=0 %}' const expected = `a rose by any other name would smell as sweet` const output = await liquid.parseAndRender(template, context) @@ -123,7 +123,7 @@ would smell as sweet` }) test('with 0 spaces specified and whitespace around equals sign', async () => { - const template = '{% indented_data_reference reusables.example spaces = 0 %}' + const template = '{% indented_data_reference site.data.reusables.example spaces = 0 %}' const expected = `a rose by any other name would smell as sweet` const output = await liquid.parseAndRender(template, context) @@ -131,7 +131,7 @@ would smell as sweet` }) test('with 5 spaces specified', async () => { - const template = '{% indented_data_reference reusables.example spaces=5 %}' + const template = '{% indented_data_reference site.data.reusables.example spaces=5 %}' const expected = ` a rose by any other name would smell as sweet` const output = await liquid.parseAndRender(template, context)