diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml index e53ce2725e..716b76f015 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.yaml @@ -18,7 +18,7 @@ body: label: Code of Conduct description: This project has a Code of Conduct that all participants are expected to understand and follow. options: - - label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md) + - label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md) required: true - type: textarea diff --git a/.github/workflows/check-broken-links-github-github.yml b/.github/workflows/check-broken-links-github-github.yml index a21a6628eb..848c231152 100644 --- a/.github/workflows/check-broken-links-github-github.yml +++ b/.github/workflows/check-broken-links-github-github.yml @@ -19,7 +19,6 @@ jobs: env: # need to use a token from a user with access to github/github for this step GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }} - FIRST_RESPONDER_PROJECT: Docs content first responder REPORT_AUTHOR: docs-bot REPORT_LABEL: github github broken link report REPORT_REPOSITORY: github/docs-content @@ -52,7 +51,7 @@ jobs: - name: Run broken github/github link check run: | - src/links/scripts/check-github-github-links.js broken_github_github_links.md + npm run check-github-github-links -- broken_github_github_links.md - name: Get title for issue # If the file 'broken_github_github_links.md' got created, diff --git a/.github/workflows/delete-orphan-translation-files.yml b/.github/workflows/delete-orphan-translation-files.yml new file mode 100644 index 0000000000..2ce1de12cf --- /dev/null +++ b/.github/workflows/delete-orphan-translation-files.yml @@ -0,0 +1,116 @@ +name: Delete orphan translation files + +# **What it does**: +# Compares content & data files left in each translation that aren't +# in docs-internal. Then creates a PR to delete these files. +# **Why we have it**: +# When Juno dumps to each translation repo it can not account for the +# fact that files in docs-internal get moved or deleted. So the +# sum total of files constantly grows. +# This leads to excess files in each translation repo that are not +# ever used but has to be put into every production build. +# **Who does it impact**: Docs engineering + +on: + workflow_dispatch: + schedule: + - cron: '20 16 * * 1' # Run every Monday at 16:20 UTC / 8:20 PST + +permissions: + contents: write + +jobs: + delete-orphan-translation-files: + if: github.repository == 'github/docs-internal' + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + include: + - language: zh + language_dir: translations/zh-cn + language_repo: github/docs-internal.zh-cn + + - language: es + language_dir: translations/es-es + language_repo: github/docs-internal.es-es + + - language: pt + language_dir: translations/pt-br + language_repo: github/docs-internal.pt-br + + - language: ru + language_dir: translations/ru-ru + language_repo: github/docs-internal.ru-ru + + - language: ja + language_dir: translations/ja-jp + language_repo: github/docs-internal.ja-jp + + - language: fr + language_dir: translations/fr-fr + language_repo: github/docs-internal.fr-fr + + - language: de + language_dir: translations/de-de + language_repo: github/docs-internal.de-de + + - language: ko + language_dir: translations/ko-kr + language_repo: github/docs-internal.ko-kr + + steps: + - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 + + - name: Checkout the language-specific repo + uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 + with: + repository: ${{ matrix.language_repo }} + token: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }} + path: ${{ matrix.language_dir }} + + - uses: ./.github/actions/node-npm-setup + + - name: Delete orphan files + run: | + npm run delete-orphan-translation-files -- ${{ matrix.language_dir }} + + - name: Debug deleted files + working-directory: ${{ matrix.language_dir }} + run: git status + + - name: Git config + working-directory: ${{ matrix.language_dir }} + run: | + git config --global user.name "docs-bot" + git config --global user.email "77750099+docs-bot@users.noreply.github.com" + + - name: Git commit and push, create and merge PR + working-directory: ${{ matrix.language_dir }} + env: + # Needed for gh + GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }} + run: | + git status + current_timestamp=$(date '+%Y-%m-%d-%H%M%S') + branch_name="delete-orphan-files-$current_timestamp" + git checkout -b "$branch_name" + current_daystamp=$(date '+%Y-%m-%d') + git commit -a -m "Delete orphan files ($current_daystamp)" + git push origin "$branch_name" + + # Create PR + echo "Creating pull request..." + gh pr create \ + --title "Delete orphan files ($current_daystamp)" \ + --body '👋 humans. This PR was generated from docs-internal/.github/workflows/delete-orphan-translation-files.yml. + ' \ + --repo "${{ matrix.language_repo }}" + echo "Merge created PR..." + gh pr merge --merge --auto --delete-branch "$branch_name" + + - uses: ./.github/actions/slack-alert + if: ${{ failure() && github.event_name != 'workflow_dispatch' }} + with: + slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }} + slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} diff --git a/.github/workflows/generate-code-scanning-query-lists.yml b/.github/workflows/generate-code-scanning-query-lists.yml index 78acd93e7e..9ff57aedab 100644 --- a/.github/workflows/generate-code-scanning-query-lists.yml +++ b/.github/workflows/generate-code-scanning-query-lists.yml @@ -22,11 +22,13 @@ permissions: jobs: generate-query-lists: if: github.repository == 'github/docs-internal' - runs-on: ubuntu-latest + runs-on: ubuntu-20.04-xl steps: - name: Checkout repository code uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 + - uses: ./.github/actions/node-npm-setup + - name: Checkout codeql repo uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 with: @@ -42,22 +44,38 @@ jobs: echo "OPENAPI_COMMIT_SHA=$OPENAPI_COMMIT_SHA" >> $GITHUB_OUTPUT echo "Copied files from github/codeql repo. Commit SHA: $OPENAPI_COMMIT_SHA" - - name: Set up Python 3.8 - uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1 - with: - python-version: 3.8 - - name: Download CodeQL CLI - # Look under the `codeql` directory, as this is where we checked out the `github/codeql` repo + # Look under the `codeql` directory, as this is where we checked out the `github/codeql` repo uses: ./codeql/.github/actions/fetch-codeql + - name: Test CodeQL CLI Download + run: codeql --version + + # "Server for running multiple commands while avoiding repeated JVM initialization." + # Having started this should speed up the execution of the various + # CLI calls of the executable. + - name: Start CodeQL CLI server in the background + run: | + codeql execute cli-server & + sleep 3 + codeql --version + - name: Build code scanning query list run: | for lang in "cpp" "csharp" "go" "java" "javascript" "python" "ruby" "swift"; do echo "Generating code scanning query list for $lang" - python src/code-scanning/generate-code-scanning-query-list.py $lang > data/reusables/code-scanning/codeql-query-tables/$lang.md + npm run generate-code-scanning-query-list -- \ + --verbose \ + --codeql-path codeql \ + --codeql-dir codeql \ + -o data/reusables/code-scanning/codeql-query-tables/$lang.md \ + $lang done + - name: Debug + run: | + git diff + - name: Create pull request env: GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }} @@ -75,7 +93,7 @@ jobs: branchname=codeql-query-tables-${{ steps.codeql.outputs.OPENAPI_COMMIT_SHA }} - # Exit if the branch already exists. Since the actions/checkout fetch-depth is 1, + # Exit if the branch already exists. Since the actions/checkout fetch-depth is 1, # it doesn't "know" about branches locally, so we need to manually list them. branchExists=$(git ls-remote --heads origin refs/heads/$branchname | wc -l) @@ -93,7 +111,6 @@ jobs: echo "Creating pull request..." gh pr create \ --title "Update CodeQL query tables" \ - --draft \ --repo github/docs-internal \ --label "codeql-query-tables,skip FR board" \ --body '👋 humans. This PR updates the **CodeQL query table reusables** with the latest changes in preparation for the next **CodeQL CLI** release. diff --git a/.github/workflows/lint-entire-content-data-markdown.yml b/.github/workflows/lint-entire-content-data-markdown.yml index cae494e077..22f6a049b1 100644 --- a/.github/workflows/lint-entire-content-data-markdown.yml +++ b/.github/workflows/lint-entire-content-data-markdown.yml @@ -41,7 +41,7 @@ jobs: REPORT_AUTHOR: docs-bot REPORT_LABEL: broken content markdown report REPORT_REPOSITORY: github/docs-content - run: node src/content-linter/scripts/post-lints.js --path /tmp/error-lints.json + run: npm run post-lints -- --path /tmp/error-lints.json - uses: ./.github/actions/slack-alert if: ${{ failure() && github.event_name != 'workflow_dispatch' }} diff --git a/.github/workflows/local-dev.yml b/.github/workflows/local-dev.yml index 56d621f32b..fb5f305047 100644 --- a/.github/workflows/local-dev.yml +++ b/.github/workflows/local-dev.yml @@ -28,6 +28,9 @@ jobs: # Note that we don't check out docs-early-access, Elasticsearch, # or any remote translations. Nothing fancy here! + - name: Disable Next.js telemetry + run: npx next telemetry disable + - name: Start server in the background run: npm start > /tmp/stdout.log 2> /tmp/stderr.log & @@ -38,7 +41,7 @@ jobs: curl --fail --retry-connrefused --retry 5 http://localhost:4000/ - name: Run basic tests - run: node src/workflows/test-local-dev.js + run: npm run test-local-dev - if: ${{ failure() }} name: Debug server outputs on errors diff --git a/.github/workflows/move-content.yml b/.github/workflows/move-content.yml index b5c0d1cc46..8ed914b0dd 100644 --- a/.github/workflows/move-content.yml +++ b/.github/workflows/move-content.yml @@ -8,6 +8,7 @@ on: pull_request: paths: - src/content-render/scripts/move-content.js + - src/content-render/scripts/test-move-content.ts - 'src/frame/lib/**/*.js' - .github/workflows/move-content.yml @@ -40,7 +41,7 @@ jobs: src/fixtures/fixtures/content/get-started/quickstart/hello-world.md \ src/fixtures/fixtures/content/get-started/quickstart/hello-wurld.md - node src/content-render/scripts/test-moved-content.js \ + npm run test-moved-content -- \ src/fixtures/fixtures/content/get-started/quickstart/hello-world.md \ src/fixtures/fixtures/content/get-started/quickstart/hello-wurld.md @@ -55,7 +56,7 @@ jobs: src/fixtures/fixtures/content/code-security/getting-started \ src/fixtures/fixtures/content/code-security/got-started - node src/content-render/scripts/test-moved-content.js \ + npm run test-moved-content -- \ src/fixtures/fixtures/content/code-security/getting-started \ src/fixtures/fixtures/content/code-security/got-started diff --git a/.github/workflows/orphaned-assets-check.yml b/.github/workflows/orphaned-assets-check.yml index 24c7d61a4e..fd218d2ffd 100644 --- a/.github/workflows/orphaned-assets-check.yml +++ b/.github/workflows/orphaned-assets-check.yml @@ -41,7 +41,7 @@ jobs: run: | set -e - filesToRemove=`./src/assets/scripts/find-orphaned-assets.js` + filesToRemove=`npm run find-orphaned-assets` [ -z "$filesToRemove" ] && exit 0 echo $filesToRemove | xargs git rm @@ -64,7 +64,7 @@ jobs: gh pr create \ --title "Delete orphaned assets ($date)" \ - --body "Found with the find-orphaned-assets.js script.\n\nFor more info see https://github.com/github/docs-engineering/blob/main/docs/orphaned-assets.md" \ + --body "Found with the 'npm run find-orphaned-assets' script.\n\nFor more info see https://github.com/github/docs-engineering/blob/main/docs/orphaned-assets.md" \ --repo github/docs-internal \ --label docs-content-fr diff --git a/.github/workflows/ready-for-doc-review.yml b/.github/workflows/ready-for-doc-review.yml index 4d8d610af1..958ee59a60 100644 --- a/.github/workflows/ready-for-doc-review.yml +++ b/.github/workflows/ready-for-doc-review.yml @@ -35,6 +35,14 @@ jobs: - name: Install dependencies run: npm install @octokit/graphql + - name: Set AUTHOR_LOGIN + run: | + if [[ "${{ github.event.pull_request.assignee.login && github.event.pull_request.user.login == 'docs-bot' }}" ]]; then + echo "AUTHOR_LOGIN=${{ github.event.pull_request.assignee.login }}" >> $GITHUB_ENV + else + echo "AUTHOR_LOGIN=${{ github.event.pull_request.user.login }}" >> $GITHUB_ENV + fi + - name: Run script run: | node src/workflows/ready-for-docs-review.js @@ -43,7 +51,6 @@ jobs: PROJECT_NUMBER: 2936 ORGANIZATION: 'github' ITEM_NODE_ID: ${{ github.event.pull_request.node_id }} - AUTHOR_LOGIN: ${{ github.event.pull_request.user.login }} REPO: ${{ github.event.pull_request.base.repo.full_name }} # Since the projects API is still in beta, use the old workflow if something fails diff --git a/.github/workflows/remove-from-fr-board.yaml b/.github/workflows/remove-from-fr-board.yaml index d1e48ca3f6..7fddc1cee2 100644 --- a/.github/workflows/remove-from-fr-board.yaml +++ b/.github/workflows/remove-from-fr-board.yaml @@ -19,22 +19,13 @@ jobs: steps: - name: Remove issue from board if: ${{ github.event.client_payload.command.resource.type == 'Issue' }} - run: gh issue edit "$ISSUE_URL" --remove-project "Docs content first responder" --remove-label "docs-content-fr" + run: gh issue edit "$ISSUE_URL" --remove-project "Docs content first responder (deprecated)" --remove-label "docs-content-fr" env: GITHUB_TOKEN: ${{secrets.DOCS_BOT_PAT_WORKFLOW_READORG}} ISSUE_URL: https://github.com/${{ github.event.client_payload.command.repository.full_name }}/issues/${{ github.event.client_payload.command.resource.number }} - name: Remove PR from board if: ${{ github.event.client_payload.command.resource.type == 'PullRequest' }} - run: gh pr edit "$PR_URL" --remove-project "Docs content first responder" --remove-label "docs-content-fr" + run: gh pr edit "$PR_URL" --remove-project "Docs content first responder (deprecated)" --remove-label "docs-content-fr" env: GITHUB_TOKEN: ${{secrets.DOCS_BOT_PAT_WORKFLOW_READORG}} PR_URL: https://github.com/${{ github.event.client_payload.command.repository.full_name }}/pull/${{ github.event.client_payload.command.resource.number }} - - - name: Check out repo - if: ${{ failure() }} - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 - - uses: ./.github/actions/slack-alert - if: ${{ failure() }} - with: - slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }} - slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} diff --git a/.github/workflows/repo-freeze-check.yml b/.github/workflows/repo-freeze-check.yml deleted file mode 100644 index 79bee9b44f..0000000000 --- a/.github/workflows/repo-freeze-check.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: Repo Freeze Check - -# **What it does**: Prevent pull requests from merging during freezes. -# **Why we have it**: Sometimes we need to freeze deployments for various reasons. -# **Who does it impact**: Anyone working on docs. - -on: - workflow_dispatch: - merge_group: - # Needed in lieu of `pull_request` so that PRs from a fork can stopped from merging when there's a freeze. - pull_request_target: - types: - - opened - - reopened - - synchronize - - ready_for_review - - unlocked - branches: - - main - -permissions: - contents: read - -# **IMPORTANT:** Do not change the FREEZE environment variable set here! -# This workflow runs on a recurring basis. To temporarily disable it (e.g., -# during a docs deployment freeze), add an Actions Secret to the repo settings -# called `FREEZE` with a value of `true`. To re-enable Audit Logs updates, simply -# delete that Secret from the repo settings. The environment variable here -# will duplicate that Secret's value for later evaluation. -env: - FREEZE: ${{ secrets.FREEZE }} - -jobs: - check-freezer: - if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }} - name: Prevent merging during deployment freezes - runs-on: ubuntu-latest - steps: - - name: Check out repo - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 - - - name: Fail if repo merges are paused - if: ${{ env.FREEZE == 'true' && github.event.pull_request.user.login != 'docs-bot' }} - run: | - echo 'Merges into the "main" branch on this repo are currently paused!' - exit 1 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 190a17055f..dba0c07c7d 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -104,7 +104,7 @@ jobs: - name: Check the test fixture data (if applicable) if: ${{ matrix.name == 'fixtures' }} - run: ./src/tests/scripts/copy-fixture-data.js --check + run: npm run copy-fixture-data -- --check # This keeps our fixture content/data in check - name: Check the test fixture content (if applicable) @@ -114,11 +114,11 @@ jobs: run: | # If either of these fail, it means our fixture content's internal # links can and should be updated. - ./src/links/scripts/update-internal-links.js --dry-run --check --strict \ + npm run update-internal-links -- --dry-run --check --strict \ src/fixtures/fixtures/content \ --exclude src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md \ --exclude src/fixtures/fixtures/content/get-started/foo/anchor-autotitling.md - ./src/links/scripts/update-internal-links.js --dry-run --check --strict \ + npm run update-internal-links -- --dry-run --check --strict \ src/fixtures/fixtures/data - name: Clone all translations diff --git a/.github/workflows/translation-health-report.yml b/.github/workflows/translation-health-report.yml index 9dcd11974b..216df2c39e 100644 --- a/.github/workflows/translation-health-report.yml +++ b/.github/workflows/translation-health-report.yml @@ -85,7 +85,7 @@ jobs: env: POPULAR_PAGES_JSON: popular-pages/records/popular-pages.json run: | - node src/languages/scripts/create-translation-health-report.js \ + npm run create-translation-health-report -- \ --language ${{ matrix.language }} \ --gitref ${{ env.gitref }} \ >> $GITHUB_WORKSPACE/translation-health-report.json diff --git a/Dockerfile b/Dockerfile index f8a21fc81a..b3bebe63f6 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,7 +5,7 @@ # -------------------------------------------------------------------------------- # To update the sha, run `docker pull node:$VERSION-alpine` # look for something like: `Digest: sha256:0123456789abcdef` -FROM node:20-alpine@sha256:b1789b7be6aa16afd642eaaaccdeeeb33bd8f08e69b3d27d931aa9665b731f01 as base +FROM node:20-alpine@sha256:32427bc0620132b2d9e79e405a1b27944d992501a20417a7f407427cc4c2b672 as base # This directory is owned by the node user ARG APP_HOME=/home/node/app diff --git a/assets/images/help/branches/branch-selection-dropdown-global-nav-update.png b/assets/images/help/branches/branch-selection-dropdown-global-nav-update.png index 2a20f5813e..3677490346 100644 Binary files a/assets/images/help/branches/branch-selection-dropdown-global-nav-update.png and b/assets/images/help/branches/branch-selection-dropdown-global-nav-update.png differ diff --git a/assets/images/help/projects-v2/rec-template-handle.png b/assets/images/help/projects-v2/rec-template-handle.png new file mode 100644 index 0000000000..960634bf04 Binary files /dev/null and b/assets/images/help/projects-v2/rec-template-handle.png differ diff --git a/assets/images/help/projects-v2/rec-template-select.png b/assets/images/help/projects-v2/rec-template-select.png new file mode 100644 index 0000000000..35ab3c5d6c Binary files /dev/null and b/assets/images/help/projects-v2/rec-template-select.png differ diff --git a/assets/images/help/releases/release-link.png b/assets/images/help/releases/release-link.png index eb25efd486..67d3d0ea51 100644 Binary files a/assets/images/help/releases/release-link.png and b/assets/images/help/releases/release-link.png differ diff --git a/assets/images/help/repository/code-button.png b/assets/images/help/repository/code-button.png index 45719e599f..db8cee792b 100644 Binary files a/assets/images/help/repository/code-button.png and b/assets/images/help/repository/code-button.png differ diff --git a/assets/images/help/repository/file-tree-view-jump-to-file.png b/assets/images/help/repository/file-tree-view-jump-to-file.png index 350750f96a..008c432a9a 100644 Binary files a/assets/images/help/repository/file-tree-view-jump-to-file.png and b/assets/images/help/repository/file-tree-view-jump-to-file.png differ diff --git a/assets/images/help/repository/fork-button.png b/assets/images/help/repository/fork-button.png index f4190488b6..1314f93448 100644 Binary files a/assets/images/help/repository/fork-button.png and b/assets/images/help/repository/fork-button.png differ diff --git a/assets/images/help/repository/https-url-clone-cli.png b/assets/images/help/repository/https-url-clone-cli.png index 2a57eb0637..9236d52ae7 100644 Binary files a/assets/images/help/repository/https-url-clone-cli.png and b/assets/images/help/repository/https-url-clone-cli.png differ diff --git a/assets/images/help/repository/repo-actions-watch.png b/assets/images/help/repository/repo-actions-watch.png index 341b93f5f6..18cee6b378 100644 Binary files a/assets/images/help/repository/repo-actions-watch.png and b/assets/images/help/repository/repo-actions-watch.png differ diff --git a/assets/images/help/repository/repository-main-page-go-to-file-no-search-bar.png b/assets/images/help/repository/repository-main-page-go-to-file-no-search-bar.png new file mode 100644 index 0000000000..65cd282cef Binary files /dev/null and b/assets/images/help/repository/repository-main-page-go-to-file-no-search-bar.png differ diff --git a/assets/images/help/repository/repository-main-page-go-to-file.png b/assets/images/help/repository/repository-main-page-go-to-file.png new file mode 100644 index 0000000000..e87ebc0a65 Binary files /dev/null and b/assets/images/help/repository/repository-main-page-go-to-file.png differ diff --git a/assets/images/help/repository/upload-files-button.png b/assets/images/help/repository/upload-files-button.png index 12aaa1f8ce..ada1366b75 100644 Binary files a/assets/images/help/repository/upload-files-button.png and b/assets/images/help/repository/upload-files-button.png differ diff --git a/content/actions/guides.md b/content/actions/guides.md index 5bb2119b07..9c3d861159 100644 --- a/content/actions/guides.md +++ b/content/actions/guides.md @@ -1,5 +1,5 @@ --- -title: Guides for GitHub Actions +title: Guides for {% data variables.product.prodname_actions %} intro: 'These guides for {% data variables.product.prodname_actions %} include specific use cases and examples to help you configure workflows.' allowTitleToDifferFromFilename: true layout: product-guides @@ -70,4 +70,3 @@ includeGuides: - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app - /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service --- - diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md index 6aca74d9d9..024ad3fc41 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md @@ -188,7 +188,7 @@ codeload.github.com **Needed for uploading/downloading job summaries, logs, workflow artifacts, and caches:** ```shell copy -actions-results-receiver-production.githubapp.com +results-receiver.actions.githubusercontent.com *.blob.core.windows.net ``` diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md index 41800e680e..4dba856434 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -123,13 +123,13 @@ export GITHUB_ACTIONS_RUNNER_TLS_NO_VERIFY=1 ## Reviewing the self-hosted runner application log files -You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory where you installed the runner application, and a new log is generated each time the application is started. The filename begins with \_Runner__, and is followed by a UTC timestamp of when the application was started. +You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory where you installed the runner application, and a new log is generated each time the application is started. The filename begins with `Runner_`, and is followed by a UTC timestamp of when the application was started. -For detailed logs on workflow job executions, see the next section describing the \_Worker__ files. +For detailed logs on workflow job executions, see the next section describing the `Worker_` files. ## Reviewing a job's log file -The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory where you installed the runner application, and the filename begins with \_Worker__. +The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory where you installed the runner application, and the filename begins with `Worker_`. {% linux %} @@ -243,7 +243,7 @@ PS C:\actions-runner> Get-EventLog -LogName Application -Source ActionsRunnerSer We recommend that you regularly check the automatic update process, as the self-hosted runner will not be able to process jobs if it falls below a certain version threshold. The self-hosted runner application automatically updates itself, but note that this process does not include any updates to the operating system or other software; you will need to separately manage these updates. -You can view the update activities in the \_Runner__ log files. For example: +You can view the update activities in the `Runner_` log files. For example: ```shell [Feb 12 12:37:07 INFO SelfUpdater] An update is available. diff --git a/content/actions/learn-github-actions/essential-features-of-github-actions.md b/content/actions/learn-github-actions/essential-features-of-github-actions.md index ddb1553eaf..a2a3ee8dc0 100644 --- a/content/actions/learn-github-actions/essential-features-of-github-actions.md +++ b/content/actions/learn-github-actions/essential-features-of-github-actions.md @@ -25,6 +25,7 @@ topics: ```yaml jobs: example-job: + runs-on: ubuntu-latest steps: - name: Connect to PostgreSQL run: node client.js @@ -97,6 +98,7 @@ For example, you can create a file and then upload it as an artifact. jobs: example-job: name: Save output + runs-on: ubuntu-latest steps: - shell: bash run: | @@ -113,6 +115,7 @@ To download an artifact from a separate workflow run, you can use the `actions/d ```yaml jobs: example-job: + runs-on: ubuntu-latest steps: - name: Download a single artifact uses: {% data reusables.actions.action-download-artifact %} diff --git a/content/actions/security-guides/security-hardening-for-github-actions.md b/content/actions/security-guides/security-hardening-for-github-actions.md index 577cafcc25..95c9716fba 100644 --- a/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/content/actions/security-guides/security-hardening-for-github-actions.md @@ -249,7 +249,7 @@ These sections consider some of the steps an attacker can take if they're able t ### Accessing secrets -Workflows triggered using the `pull_request` event have read-only permissions and have no access to secrets. However, these permissions differ for various event triggers such as `issue_comment`, `issues` and `push`, where the attacker could attempt to steal repository secrets or use the write permission of the job's [`GITHUB_TOKEN`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token). +Workflows triggered from a forked repository using the `pull_request` event have read-only permissions and have no access to secrets. However, these permissions differ for various event triggers such as `issue_comment`, `issues`, `push` and `pull_request` from a branch within the repository, where the attacker could attempt to steal repository secrets or use the write permission of the job's [`GITHUB_TOKEN`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token). - If the secret or token is set to an environment variable, it can be directly accessed through the environment using `printenv`. - If the secret is used directly in an expression, the generated shell script is stored on-disk and is accessible. diff --git a/content/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users.md b/content/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users.md index abe59672ee..f397d0b76d 100644 --- a/content/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/understanding-iam-for-enterprises/about-enterprise-managed-users.md @@ -89,7 +89,7 @@ For more information about authentication and provisioning, see the following ar Some customers have reported success using a partner IdP's application only for authentication, in combination with a different IdP for provisioning. For example, a combination of Okta for authentication and a custom SCIM solution for provisioning, or a combination of Keycloak for authentication and SailPoint for provisioning. {% data variables.product.company_short %} has not tested all IdPs, and does not test partner IdPs in combination with other IdPs. -For more information about provisioning users from your IdP using the public beta of {% data variables.product.company_short %}'s SCIM schema, see "[AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/provisioning-users-with-scim-using-the-rest-api)," and consult your IdP's documentation, support team, or other resources. +For more information about provisioning users from your IdP using the private beta of {% data variables.product.company_short %}'s SCIM schema, see "[AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/provisioning-users-with-scim-using-the-rest-api)," and consult your IdP's documentation, support team, or other resources. {% data reusables.enterprise_user_management.authentication-or-provisioning-migration-not-supported %} diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md index 8a08229428..9241da62be 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md @@ -67,9 +67,13 @@ After a user successfully authenticates on your IdP, the user's SAML session for {% data reusables.saml.saml-supported-idps %} -For more information about connecting Azure AD to your enterprise, see [Tutorial: Azure Active Directory SSO integration with GitHub Enterprise Cloud - Enterprise Account](https://learn.microsoft.com/en-us/azure/active-directory/saas-apps/github-enterprise-cloud-enterprise-account-tutorial) in Microsoft Docs. +{% ifversion ghec %} -{% ifversion ghes or ghae %} +For more information about connecting Azure AD to your enterprise, see [Tutorial: Microsoft Entra SSO integration with GitHub Enterprise Cloud - Enterprise Account](https://learn.microsoft.com/en-us/entra/identity/saas-apps/github-enterprise-cloud-enterprise-account-tutorial) in Microsoft Docs. + +{% elsif ghes or ghae %} + +For more information about connecting Azure AD to your enterprise, see [Tutorial: Microsoft Entra SSO integration with GitHub Enterprise Server](https://learn.microsoft.com/en-us/entra/identity/saas-apps/github-ae-tutorial) in Microsoft Docs. ## Username considerations with SAML diff --git a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app.md b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app.md index 667bea7a76..038a8d2bde 100644 --- a/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app.md +++ b/content/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app.md @@ -88,7 +88,7 @@ puts jwt ```python copy #!/usr/bin/env python3 -import jwt +from jwt import JWT, jwk_from_pem import time import sys @@ -107,7 +107,7 @@ else: # Open PEM with open(pem, 'rb') as pem_file: - signing_key = jwt.jwk_from_pem(pem_file.read()) + signing_key = jwk_from_pem(pem_file.read()) payload = { # Issued at time @@ -119,7 +119,7 @@ payload = { } # Create JWT -jwt_instance = jwt.JWT() +jwt_instance = JWT() encoded_jwt = jwt_instance.encode(payload, signing_key, alg='RS256') print(f"JWT: {encoded_jwt}") diff --git a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index 72d790db6d..0c2c9f06bc 100644 --- a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -24,7 +24,7 @@ You can remove the file from the latest commit with `git rm`. For information on {% warning %} -**Warning**: This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. However, those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. +**Warning**: This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. However, those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. {% ifversion fpt or ghec %}{% data variables.contact.github_support %} only assists in the removal of sensitive data in cases where we determine that the risk can't be mitigated by rotating affected credentials.{% endif %} Once you have pushed a commit to {% data variables.product.product_name %}, you should consider any sensitive data in the commit compromised. If you have committed a password, you should change it. If you have committed a key, generate a new one. Removing the compromised data doesn't resolve its initial exposure, especially in existing clones or forks of your repository. @@ -126,9 +126,9 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil ``` {% note %} - + **Note:** If the file with sensitive data used to exist at any other paths (because it was moved or renamed), you must run this command on those paths, as well. - + {% endnote %} 1. Add your file with sensitive data to `.gitignore` to ensure that you don't accidentally commit it again. @@ -143,7 +143,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil 1. Double-check that you've removed everything you wanted to from your repository's history, and that all of your branches are checked out. 1. The `git filter-repo` tool will automatically remove your configured remotes. Use the `git remote set-url` command to restore your remotes, replacing `OWNER` and `REPO` with your repository details. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/managing-remote-repositories#adding-a-remote-repository)." - + ```shell git remote add origin https://github.com/OWNER/REPOSITORY.git ``` @@ -178,7 +178,13 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil After using either the BFG tool or `git filter-repo` to remove the sensitive data and pushing your changes to {% data variables.product.product_name %}, you must take a few more steps to fully remove the data from {% data variables.product.product_name %}. -1. Contact {% data variables.contact.contact_support %}, and ask to remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %}. Please provide the name of the repository and/or a link to the commit you need removed.{% ifversion ghes %} For more information about how site administrators can remove unreachable Git objects, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-repo-gc)."{% endif %} +1. Contact {% data variables.contact.contact_support %}, and ask to remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %}. Please provide the name of the repository and/or a link to the commit you need removed.{% ifversion ghes %} For more information about how site administrators can remove unreachable Git objects, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-repo-gc)."{% endif %}{% ifversion fpt or ghec %} + + {% note %} + + **Note:** {% data variables.contact.github_support %} won't remove non-sensitive data, and will only assist in the removal of sensitive data in cases where we determine that the risk can't be mitigated by rotating affected credentials. + + {% endnote %}{% endif %} 1. Tell your collaborators to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing), _not_ merge, any branches they created off of your old (tainted) repository history. One merge commit could reintroduce some or all of the tainted history that you just went to the trouble of purging. diff --git a/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md b/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md index 9de2421a34..ee5aa71df2 100644 --- a/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md +++ b/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md @@ -25,7 +25,7 @@ shortTitle: Billing for GitHub Actions {% data reusables.actions.actions-spending-limit-brief %} For more information, see "[About spending limits](#about-spending-limits)." -If you are an organization owner{% ifversion ghec %} or enterprise owner{% endif%}, you can connect an Azure Subscription ID to your organization {% ifversion ghec %}or enterprise{% endif%} account to enable and pay for {% data variables.product.prodname_actions %} usage beyond the amounts including with your account. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription)." +If you are an organization owner{% ifversion ghec %} or enterprise owner{% endif%}, you can connect an Azure Subscription ID to your organization {% ifversion ghec %}or enterprise{% endif%} account to enable and pay for {% data variables.product.prodname_actions %} usage beyond the amounts included with your account. For more information, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription)." Minutes reset every month, while storage usage does not. diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index 1f37109c3d..6e25f9953e 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -63,7 +63,13 @@ SARIF files support both rules and results. The information stored in these elem When you compare SARIF files generated by analyzing different codebases with the same tool and rules, you should see differences in the results of the analyses but not in the rules. -## Specifying the root for source files +## Specifying the location for source files + +Specifying source file locations ensures code scanning alerts are displayed accurately within the file containing the identified problem, allowing for targeted issue resolution. + +This precision enhances the efficiency of code review and resolution processes, streamlining development workflows by enabling developers to address issues directly in the context of their codebase. + +### Specifying the root for source files {% data variables.product.prodname_code_scanning_caps %} interprets results that are reported with relative paths as relative to the root of the repository analyzed. If a result contains an absolute URI, the URI is converted to a relative URI. The relative URI can then be matched against a file committed to the repository. @@ -86,6 +92,10 @@ file:///tmp/go-build/tmp.go -> file:///tmp/go-build/tmp.go The file is successfully uploaded as both absolute URIs use the same URI scheme as the source root. +### Resolving symlinks before generating SARIF results + +If the relative URI for a result is matched against a file defined using a symlink, code scanning is unable to display the result. So you need to resolve any symlinked files, and report any results in those files using the resolved URI. + ## Validating your SARIF file diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites.md index 6ad7a92060..69be243fd0 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites.md +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites.md @@ -17,8 +17,8 @@ topics: With {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}, you can select a specific group of {% data variables.product.prodname_codeql %} queries, called a {% data variables.product.prodname_codeql %} query suite, to run against your code. The following built-in query suites are available through {% data variables.product.prodname_dotcom %}: -- the `default` query suite. -- the `security-extended` query suite. This suite is referred to as the "Extended" query suite on {% data variables.product.prodname_dotcom %}. +- `default` query suite. +- `security-extended` query suite. This suite is referred to as the "Extended" query suite on {% data variables.product.prodname_dotcom %}. Currently, both the `default` query suite and the `security-extended` query suite are available for default setup for {% data variables.product.prodname_code_scanning %}. {% ifversion bulk-code-scanning-query-suite %}Additionally, organization owners and security managers can recommend a query suite for use with default setup throughout their organization. For more information on configuring default setup for individual repositories, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)." For more information on configuring default setup at scale and recommending a query suite, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale)."{% else %}For more information on default setup, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)" and "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale)."{% endif %} @@ -40,6 +40,17 @@ The built-in {% data variables.product.prodname_codeql %} query suites, `default - Relative to the `default` query suite, the `security-extended` suite may return a greater number of false positive {% data variables.product.prodname_code_scanning %} results. - This query suite is available for use with default setup for {% data variables.product.prodname_code_scanning %}, and is referred to as the "Extended" query suite on {% data variables.product.prodname_dotcom %}. +## Queries included in the `default` and `security-extended` query suites + +- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries)" +- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries)" +- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries)" +- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries)" +- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries)" +- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries)" +- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries)" +- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries)" + ## Further reading - "[AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites)" diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries.md new file mode 100644 index 0000000000..76bfe62d9a --- /dev/null +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries.md @@ -0,0 +1,21 @@ +--- +title: C and C++ queries for CodeQL analysis +shortTitle: C and C++ CodeQL queries +intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in C or C++ when you select the `default` or the `security-extended` query suite.' +product: '{% data reusables.gated-features.code-scanning %}' +allowTitleToDifferFromFilename: true +versions: + feature: code-scanning-without-workflow +type: reference +topics: + - Code scanning + - CodeQL +--- + +{% data variables.product.prodname_codeql %} includes many queries for analyzing C and C++ code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} + +## Built-in queries for C and C++ analysis + +{% data reusables.code-scanning.codeql-query-tables.codeql-version-info %} + +{% data reusables.code-scanning.codeql-query-tables.cpp %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries.md new file mode 100644 index 0000000000..d42527574e --- /dev/null +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries.md @@ -0,0 +1,21 @@ +--- +title: C# queries for CodeQL analysis +shortTitle: C# CodeQL queries +intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in C# when you select the `default` or the `security-extended` query suite.' +product: '{% data reusables.gated-features.code-scanning %}' +allowTitleToDifferFromFilename: true +versions: + feature: code-scanning-without-workflow +type: reference +topics: + - Code scanning + - CodeQL +--- + +{% data variables.product.prodname_codeql %} includes many queries for analyzing C# code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} + +## Built-in queries for C# analysis + +{% data reusables.code-scanning.codeql-query-tables.codeql-version-info %} + +{% data reusables.code-scanning.codeql-query-tables.csharp %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries.md new file mode 100644 index 0000000000..690db9157d --- /dev/null +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries.md @@ -0,0 +1,21 @@ +--- +title: Go queries for CodeQL analysis +shortTitle: Go CodeQL queries +intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in Go (Golang) when you select the `default` or the `security-extended` query suite.' +product: '{% data reusables.gated-features.code-scanning %}' +allowTitleToDifferFromFilename: true +versions: + feature: code-scanning-without-workflow +type: reference +topics: + - Code scanning + - CodeQL +--- + +{% data variables.product.prodname_codeql %} includes many queries for analyzing Go code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} + +## Built-in queries for Go analysis + +{% data reusables.code-scanning.codeql-query-tables.codeql-version-info %} + +{% data reusables.code-scanning.codeql-query-tables.go %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md index 28eaa06949..929248f29f 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md @@ -17,4 +17,12 @@ children: - /editing-your-configuration-of-default-setup - /built-in-codeql-query-suites - /viewing-code-scanning-logs + - /c-cpp-built-in-queries + - /csharp-built-in-queries + - /go-built-in-queries + - /java-kotlin-built-in-queries + - /javascript-typescript-built-in-queries + - /python-built-in-queries + - /ruby-built-in-queries + - /swift-built-in-queries --- diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries.md new file mode 100644 index 0000000000..9c95c36d1b --- /dev/null +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries.md @@ -0,0 +1,23 @@ +--- +title: Java and Kotlin queries for CodeQL analysis +shortTitle: Java and Kotlin CodeQL queries +intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in Java or Kotlin when you select the `default` or the `security-extended` query suite.' +product: '{% data reusables.gated-features.code-scanning %}' +allowTitleToDifferFromFilename: true +versions: + feature: code-scanning-without-workflow +type: reference +topics: + - Code scanning + - CodeQL +--- + +{% data variables.product.prodname_codeql %} includes many queries for analyzing Java and Kotlin code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} + +{% data reusables.code-scanning.beta-kotlin-support %} + +## Built-in queries for Java and Kotlin analysis + +{% data reusables.code-scanning.codeql-query-tables.codeql-version-info %} + +{% data reusables.code-scanning.codeql-query-tables.java %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries.md new file mode 100644 index 0000000000..866eb04b5b --- /dev/null +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries.md @@ -0,0 +1,21 @@ +--- +title: JavaScript and TypeScript queries for CodeQL analysis +shortTitle: JavaScript and TypeScript queries +intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in JavaScript or TypeScript when you select the `default` or the `security-extended` query suite.' +product: '{% data reusables.gated-features.code-scanning %}' +allowTitleToDifferFromFilename: true +versions: + feature: code-scanning-without-workflow +type: reference +topics: + - Code scanning + - CodeQL +--- + +{% data variables.product.prodname_codeql %} includes many queries for analyzing JavaScript and TypeScript code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} + +## Built-in queries for JavaScript and TypeScript analysis + +{% data reusables.code-scanning.codeql-query-tables.codeql-version-info %} + +{% data reusables.code-scanning.codeql-query-tables.javascript %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries.md new file mode 100644 index 0000000000..5905d440fd --- /dev/null +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries.md @@ -0,0 +1,21 @@ +--- +title: Python queries for CodeQL analysis +shortTitle: Python CodeQL queries +intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in Python when you select the `default` or the `security-extended` query suite.' +product: '{% data reusables.gated-features.code-scanning %}' +allowTitleToDifferFromFilename: true +versions: + feature: code-scanning-without-workflow +type: reference +topics: + - Code scanning + - CodeQL +--- + +{% data variables.product.prodname_codeql %} includes many queries for analyzing Python code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} + +## Built-in queries for Python analysis + +{% data reusables.code-scanning.codeql-query-tables.codeql-version-info %} + +{% data reusables.code-scanning.codeql-query-tables.cpp %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries.md new file mode 100644 index 0000000000..c017d136e7 --- /dev/null +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries.md @@ -0,0 +1,23 @@ +--- +title: Ruby queries for CodeQL analysis +shortTitle: Ruby CodeQL queries +intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in Ruby when you select the `default` or the `security-extended` query suite.' +product: '{% data reusables.gated-features.code-scanning %}' +allowTitleToDifferFromFilename: true +versions: + feature: code-scanning-without-workflow +type: reference +topics: + - Code scanning + - CodeQL +--- + +{% data variables.product.prodname_codeql %} includes many queries for analyzing Ruby code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} + +{% data reusables.code-scanning.beta-ruby-support %} + +## Built-in queries for Ruby analysis + +{% data reusables.code-scanning.codeql-query-tables.codeql-version-info %} + +{% data reusables.code-scanning.codeql-query-tables.ruby %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries.md new file mode 100644 index 0000000000..ffcbd44839 --- /dev/null +++ b/content/code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries.md @@ -0,0 +1,23 @@ +--- +title: Swift queries for CodeQL analysis +shortTitle: Swift CodeQL queries +intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code written in Swift when you select the `default` or the `security-extended` query suite.' +product: '{% data reusables.gated-features.code-scanning %}' +allowTitleToDifferFromFilename: true +versions: + feature: code-scanning-without-workflow +type: reference +topics: + - Code scanning + - CodeQL +--- + +{% data variables.product.prodname_codeql %} includes many queries for analyzing Swift code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} + +{% data reusables.code-scanning.beta-swift-support %} + +## Built-in queries for Swift analysis + +{% data reusables.code-scanning.codeql-query-tables.codeql-version-info %} + +{% data reusables.code-scanning.codeql-query-tables.swift %} diff --git a/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md b/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md index 9cd0d6ca22..f6354bc039 100644 --- a/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md +++ b/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md @@ -63,6 +63,16 @@ When you merge a pull request that contains a security update, the corresponding {% data reusables.dependabot.automated-tests-note %} +{% ifversion dependabot-grouped-security-updates %} + +## About grouped security updates + +{% data reusables.dependabot.dependabot-grouped-security-updates-beta-note %} + +To further reduce the number of pull requests you may be seeing, you can enable grouped security updates to group sets of dependencies together (per package ecosystem). {% data variables.product.prodname_dependabot %} then raises a single pull request to update as many vulnerable dependencies as possible in the group to secure versions at the same time. For security updates, {% data variables.product.prodname_dependabot %} **will** group dependencies from different directories. {% data variables.product.prodname_dependabot %} **will not** group dependencies from different package ecosystems together, and it **will not** group security updates with version updates. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#grouping-dependabot-security-updates-into-a-single-pull-request)." + +{% endif %} + {% ifversion fpt or ghec %} ## About compatibility scores diff --git a/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md b/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md index a4a8b69940..b49db90459 100644 --- a/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md +++ b/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md @@ -59,10 +59,53 @@ You can also enable or disable {% data variables.product.prodname_dependabot_sec {% data reusables.repositories.navigate-to-code-security-and-analysis %} 1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot %} security updates", click **Enable** to enable the feature or **Disable** to disable it. {% ifversion fpt or ghec %}For public repositories, the button is disabled if the feature is always enabled.{% endif %} +{% ifversion dependabot-grouped-security-updates %} + +## Grouping {% data variables.product.prodname_dependabot_security_updates %} into a single pull request + +{% data reusables.dependabot.dependabot-grouped-security-updates-beta-note %} + +To reduce the number of pull requests you may be seeing, you can enable grouped security updates for your repository or organization. When this is enabled, {% data variables.product.prodname_dependabot %} will group security updates into one pull request for each package ecosystem. In order to use grouped security updates, you must first enable the following features: + +- **Dependency graph**. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph)." +- **{% data variables.product.prodname_dependabot_alerts %}**. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts)." +- **{% data variables.product.prodname_dependabot_security_updates %}**. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates)." + +{% note %} + +**Note:** When grouped security updates are first enabled, {% data variables.product.prodname_dependabot %} will immediately try to create grouped pull requests. You may notice {% data variables.product.prodname_dependabot %} closing old pull requests and opening new ones. + +{% endnote %} + +### Enabling or disabling grouped {% data variables.product.prodname_dependabot_security_updates %} for an individual repository + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.navigate-to-code-security-and-analysis %} +1. Under "Code security and analysis", to the right of "Grouped security updates", click **Enable** to enable the feature or **Disable** to disable it. + +### Enabling or disabling grouped {% data variables.product.prodname_dependabot_security_updates %} for an organization + +Organization owners can enable or disable grouped security updates for all repositories in their organization. However, individual repositories can update their settings to override the default organization settings. + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.organizations.security-and-analysis %} +1. Under "Code security and analysis", to the right of "Grouped security updates", click **Disable all** or **Enable all**. +1. Optionally, to enable grouped {% data variables.product.prodname_dependabot_security_updates %} for new repositories in your organization, select **Automatically enable for new repositories**. + +{% endif %} + ## Overriding the default behavior with a configuration file You can override the default behavior of {% data variables.product.prodname_dependabot_security_updates %} by adding a `dependabot.yml` file to your repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)." +{% ifversion dependabot-grouped-security-updates %}{% note %} + +**Note:** If you use grouped security updates, you cannot use the configuration file to customize the default grouping behavior for {% data variables.product.prodname_dependabot_security_updates %}. The `groups` option in the `dependabot.yml` file only applies to grouped version updates. + +{% endnote %}{% endif %} + If you only require security updates and want to exclude version updates, you can set `open-pull-requests-limit` to `0` in order to prevent version updates for a given `package-ecosystem`. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#open-pull-requests-limit)." ```yaml diff --git a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 01b8561709..a43846333d 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -337,7 +337,7 @@ If you use the same configuration as in the example above, bumping the `requests ### `groups` -{% data reusables.dependabot.dependabot-version-updates-groups-supported %} +{% ifversion dependabot-grouped-security-updates %}{% data reusables.dependabot.dependabot-security-updates-groups-supported %}{% else %}{% data reusables.dependabot.dependabot-version-updates-groups-supported %}{% endif %} {% data reusables.dependabot.dependabot-version-updates-groups-about %} diff --git a/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md b/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md index 13adcec617..06b7560dc5 100644 --- a/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md @@ -46,6 +46,12 @@ If you customize the `dependabot.yml` file, you may notice some changes to the p For an example, see "[Setting custom labels](#setting-custom-labels)" below. +{% ifversion dependabot-grouped-security-updates %}{% note %} + +**Note:** If you use grouped security updates, the grouped pull requests will also inherit relevant configuration settings from the `dependabot.yml` file. However, they will not inherit any customizations made with the `groups` option, which only applies to version updates. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates)." + +{% endnote %}{% endif %} + ## Modifying scheduling When you set a `daily` update schedule, by default, {% data variables.product.prodname_dependabot %} checks for new versions at 05:00 UTC. You can use `schedule.time` to specify an alternative time of day to check for updates (format: `hh:mm`). @@ -150,7 +156,7 @@ updates: {% data reusables.dependabot.dependabot-version-updates-groups-match-first %} -{% data reusables.dependabot.dependabot-version-updates-groups-supported %} +{% ifversion dependabot-grouped-security-updates %}{% data reusables.dependabot.dependabot-security-updates-groups-supported %}{% else %}{% data reusables.dependabot.dependabot-version-updates-groups-supported %}{% endif %} You must configure groups per package ecosystem. diff --git a/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md b/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md index 33fd3fa7b9..c61cc6a0f5 100644 --- a/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md +++ b/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md @@ -126,8 +126,8 @@ registries: - Image names may not always be detected in Containerfiles, Helm files, or yaml files. - Dockerfiles may only receive a version update to the first `FROM` directive. -- Dockerfiles do not receive updates to images specified with the `ARG` directive. There is a workaround available for the `COPY` directive. For more information, see https://github.com/dependabot/dependabot-core/issues/5103#issuecomment-1692420920. -- {% data variables.product.prodname_dependabot %} doesn't support multi-stage Docker builds. For more information, see https://github.com/dependabot/dependabot-core/issues/7640. +- Dockerfiles do not receive updates to images specified with the `ARG` directive. There is a workaround available for the `COPY` directive. For more information, see "[{% data variables.product.prodname_dependabot %} ignores image references in COPY Dockerfile statement](https://github.com/dependabot/dependabot-core/issues/5103#issuecomment-1692420920)" in the `github/dependabot/dependabot-core` repository. +- {% data variables.product.prodname_dependabot %} doesn't support multi-stage Docker builds. For more information, see "[Support for Docker multi-stage builds](https://github.com/dependabot/dependabot-core/issues/7640)" in the `github/dependabot/dependabot-core` repository. ### Gradle @@ -510,7 +510,7 @@ If the `yarn.lock` file doesn't list the private registry as the dependency sour - Manually set the private registry to the `.yarnrc` file by adding the registry to a `.yarnrc.yml` file in the project root with the key `npmRegistryServer`, or - Perform the same action by running `yarn config set npmRegistryServer ` in your terminal. - Example of a `.yarnrc.yml` file with a private registry configured: + Example of a `.yarnrc.yml` file with a private registry configured: `npmRegistryServer: "https://nexus.example.com/repository/yarn-all"` For more information, see [npmRegistryServer](https://yarnpkg.com/configuration/yarnrc#npmRegistryServer) in the Yarn documentation. diff --git a/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md b/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md index fea581d92a..884b7cd759 100644 --- a/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md +++ b/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md @@ -30,7 +30,7 @@ shortTitle: Manage Dependabot PRs When {% data variables.product.prodname_dependabot %} raises a pull request, you're notified by your chosen method for the repository. Each pull request contains detailed information about the proposed change, taken from the package manager. These pull requests follow the normal checks and tests defined in your repository. {% ifversion fpt or ghec %}In addition, where enough information is available, you'll see a compatibility score. This may also help you decide whether or not to merge the change. For information about this score, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)."{% endif %} -If you have many dependencies to manage, you may want to customize the configuration for each package manager so that pull requests have specific reviewers, assignees, and labels. {% ifversion dependabot-version-updates-groups %} You may also want to group sets of dependencies together, so that multiple dependencies are updated in a single pull request.{% endif %} For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates)." +If you have many dependencies to manage, you may want to customize the configuration for each package manager so that pull requests have specific reviewers, assignees, and labels. {% ifversion dependabot-version-updates-groups %} You may also want to group sets of dependencies together, so that multiple dependencies are updated in a single pull request.{% endif %} For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates){% ifversion dependabot-grouped-security-updates %} and "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#grouping-dependabot-security-updates-into-a-single-pull-request)."{% else %}."{% endif %} {% ifversion dependabot-updates-paused %} @@ -88,6 +88,12 @@ For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-vers In {% data variables.product.prodname_dependabot %} pull requests for grouped version updates, you can use comment commands to ignore and un-ignore updates for specific dependencies and versions. You can use any of the following commands to manage ignore conditions for grouped version updates. +{% ifversion dependabot-grouped-security-updates %}{% note %} + +**Note:** The following comment commands do not work for grouped {% data variables.product.prodname_dependabot_security_updates %}. + +{% endnote %}{% endif %} + - `@dependabot ignore DEPENDENCY_NAME` closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency. - `@dependabot ignore DEPENDENCY_NAME major version` closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency's major version. - `@dependabot ignore DEPENDENCY_NAME minor version` closes the pull request and prevents {% data variables.product.prodname_dependabot %} from updating this dependency's minor version. diff --git a/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md b/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md index 6031e2b8e8..e198ec11fe 100644 --- a/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md +++ b/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md @@ -155,11 +155,11 @@ To allow {% data variables.product.prodname_dependabot %} to update the dependen {% ifversion dependabot-version-updates-groups %} -### {% data variables.product.prodname_dependabot %} fails to group a set of dependencies into a single pull request +### {% data variables.product.prodname_dependabot %} fails to group a set of dependencies into a single pull request for {% data variables.product.prodname_dependabot_version_updates %} -{% data reusables.dependabot.dependabot-version-updates-groups-supported %} +{% ifversion dependabot-grouped-security-updates %}The [`groups`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups) configuration settings in the `dependabot.yml` file only apply to version updates.{% else %}{% data reusables.dependabot.dependabot-version-updates-groups-supported %}{% endif %} -You must configure groups per package ecosystem. To debug the problem, we recommend you look at the logs. For information about accessing the logs for a manifest, see "[Investigating errors with {% data variables.product.prodname_dependabot_version_updates %}](#investigating-errors-with-dependabot-version-updates)" above. +When you configure grouped version updates, you must configure groups per package ecosystem. To debug the problem, we recommend you look at the logs. For information about accessing the logs for a manifest, see "[Investigating errors with {% data variables.product.prodname_dependabot_version_updates %}](#investigating-errors-with-dependabot-version-updates)" above. You may have unintentionally created empty groups. This happens, for example, when you set a `dependency-type` in the `allow` key for the overall job. @@ -183,9 +183,30 @@ You need to ensure that configuration settings don't cancel each other, and upda For more information on how to configure groups for {% data variables.product.prodname_dependabot_version_updates %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups)." +{% ifversion dependabot-grouped-security-updates %} + +### {% data variables.product.prodname_dependabot %} fails to group a set of dependencies into a single pull request for {% data variables.product.prodname_dependabot_security_updates %} + +The [`groups`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups) configuration settings in the `dependabot.yml` file only apply to version updates. + +For grouped security updates, {% data variables.product.prodname_dependabot %} uses the following guidelines to create grouped pull requests. + +- {% data variables.product.prodname_dependabot %} **will** group dependencies from the same package ecosystem that are located in different directories. +- {% data variables.product.prodname_dependabot %} **will** apply other relevant customization options from the `dependabot.yml` file to pull requests for grouped security updates. +- {% data variables.product.prodname_dependabot %} **will not** group dependencies from different package ecosystems together. +- {% data variables.product.prodname_dependabot %} **will not** group security updates with version updates. + +For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates#impact-of-configuration-changes-on-security-updates)" and "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates)." + +{% endif %} + ### {% data variables.product.prodname_dependabot %} fails to update one of the dependencies in a grouped pull request -**Version updates only.**{% data variables.product.prodname_dependabot %} will show the failed update in your logs, as well as in the job summary at the end of your logs. You should use the `@dependabot recreate` comment on the pull request to build the group again. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)." +{% ifversion dependabot-grouped-security-updates %}There are different troubleshooting techniques you can use for failed version updates and failed security updates. + +#### Handling failures in grouped version updates{% endif %} + +**Version updates only.** {% data variables.product.prodname_dependabot %} will show the failed update in your logs, as well as in the job summary at the end of your logs. You should use the `@dependabot recreate` comment on the pull request to build the group again. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)." If the dependency still fails to update, you should use the `exclude-patterns` configuration so that the dependency is excluded from the group. {% data variables.product.prodname_dependabot %} will then raise a separate pull request to update the dependency. @@ -193,6 +214,14 @@ If the dependency still fails to update, there may be a problem with the depende {% data reusables.dependabot.dependabot-ignore-dependencies %} +{% ifversion dependabot-grouped-security-updates %} + +#### Handling failures in grouped security updates + +**Security updates only.** If a grouped pull request for security updates fails or is unable to be merged, we recommend you manually open pull requests to bump the versions of breaking changes. When you manually update a package that is included in a grouped pull request, {% data variables.product.prodname_dependabot %} will rebase the pull request so it does not include the manually updated package. + +{% endif %} + ### Continuous integration (CI) fails on my grouped pull request **Version updates only.** If the failure is due to a single dependency, you should use the `exclude-patterns` configuration so that the dependency is excluded from the group. {% data variables.product.prodname_dependabot %} will then raise a separate pull request to update the dependency. diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md index 4b37629eed..e109bd74b4 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md +++ b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md @@ -1,6 +1,6 @@ --- title: Browsing security advisories in the GitHub Advisory Database -intro: 'You can browse the {% data variables.product.prodname_advisory_database %} to find advisories for security risks in open source projects that are hosted on {% data variables.product.company_short %}.' +intro: 'You can browse the {% data variables.product.prodname_advisory_database %} to find CVEs and {% data variables.product.prodname_dotcom %}-originated advisories affecting the open source world.' shortTitle: Browse Advisory Database redirect_from: - /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database diff --git a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index 016eaaa27c..6d30eccb2a 100644 --- a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -26,9 +26,27 @@ Sometimes you may not be able to access a codespace from your browser. If this h - If the codespace is not listed on that page, check that you are the owner of the codespace you are trying to connect to. You can only open a codespace that you created. - If the codespace is listed but you cannot connect from that page, check whether you can connect using a different browser. -Your company network may be blocking the connection. If possible, check any logging for rejected connections on your device. +### Diagnose by error message -If you still cannot connect, {% data reusables.codespaces.contact-support %} +#### "Oh no, it looks like you are offline" + +Check that you have a stable internet connection and that your company network is not blocking the connection. If possible, check logging for rejected connections on your device. + +If you see rejected connections, make sure the domains documented by the `/meta` REST API endpoint are not blocked by your firewall. For more information, see "[AUTOTITLE](/rest/meta/meta?apiVersion=2022-11-28#get-github-meta-information)." + +To get the list of domains required by {% data variables.product.prodname_github_codespaces %}, execute the following command using {% data variables.product.prodname_cli %}: + +`gh api meta | jq .domains.codespaces` + +### "We are having trouble fetching your codespace information" + +This is a transitional error. Wait for a few minutes and try again. + +### "We were unable to authenticate your connection" + +This indicates that something went wrong with authentication. Try clearing up your local storage and cookies and try again. + +If you still can't connect and the message you're seeing isn't in this list, check the service availability of {% data variables.product.prodname_codespaces %} at [githubstatus.com](https://www.githubstatus.com/). If the {% data variables.product.prodname_codespaces %} service is available, {% data reusables.codespaces.contact-support %} ## Unable to connect to your codespace in JupyterLab diff --git a/content/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md b/content/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md index 584f526758..de8dcb324a 100644 --- a/content/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md +++ b/content/copilot/github-copilot-enterprise/copilot-chat-in-github/using-github-copilot-chat-in-githubcom.md @@ -26,7 +26,7 @@ On {% data variables.product.prodname_dotcom_the_website %}, you can use {% data The following limitations apply to this beta release of {% data variables.product.prodname_copilot_chat_dotcom %}: - {% data reusables.copilot.chat-limited-docset-availability %} -- Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Owners of organizations {% ifversion ghec %}or enterprises {% endif %} can index up to 10 repositories for each organization. +- Chat responses may be suboptimal if you ask questions about a specific repository that you've selected as a context, and the repository has not been indexed for semantic code search. Owners of organizations {% ifversion ghec %}or enterprises {% endif %} can index up to {% data variables.copilot.max-chat-indexed-repos %} repositories for each organization. - The quality of the results from {% data variables.product.prodname_copilot_chat_short %} may, in some situations, be degraded if very large files, or a large number of files, are used as a context for a question. ## Prerequisites @@ -92,7 +92,7 @@ You can choose a specific context, such as a particular repository or a document {% data variables.product.prodname_copilot_short %}'s ability to answer natural language questions like these in a repository context is improved when the repository has been indexed for semantic code search. The indexing status of the repository is displayed when you start a conversation that has a repository context. - If you are an organization owner{% ifversion ghec %}, or an enterprise owner,{% endif %} and the repository has not been indexed, an **Index this repository** button is displayed. Click this button to start the indexing process. You can index up to 10 repositories in an organization. + If you are an organization owner{% ifversion ghec %}, or an enterprise owner,{% endif %} and the repository has not been indexed, an **Index this repository** button is displayed. Click this button to start the indexing process. You can index up to {% data variables.copilot.max-chat-indexed-repos %} repositories in an organization. ![Screenshot showing the 'Index this repository' button highlighted with a dark orange outline.](/assets/images/help/copilot/index-this-repo.png) diff --git a/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md b/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md index 11c9208a36..6d9b4a230a 100644 --- a/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md +++ b/content/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise.md @@ -16,9 +16,9 @@ topics: ## About the {% data variables.product.prodname_copilot_enterprise_short %} beta -{% data variables.product.prodname_copilot_enterprise %} is a {% data variables.product.prodname_copilot_short %} plan available for organizations and enterprises that use {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.prodname_copilot_enterprise_short %} is currently in beta and available to a limited number of customers. +{% data variables.product.prodname_copilot_enterprise %} is a {% data variables.product.prodname_copilot_short %} plan available for enterprises that use {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.prodname_copilot_enterprise_short %} is currently in beta and available to a limited number of customers. -If {% data variables.product.prodname_copilot_enterprise_short %} is enabled for an organization or enterprise, members get access to the following {% data variables.product.prodname_copilot_short %} features on {% data variables.product.prodname_dotcom_the_website %}. +If {% data variables.product.prodname_copilot_enterprise_short %} is enabled for an enterprise, members get access to the following {% data variables.product.prodname_copilot_short %} features on {% data variables.product.prodname_dotcom_the_website %}. - {% data variables.product.prodname_copilot_chat_short %} (see "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat)") - {% data variables.product.prodname_copilot_for_prs %} (see "[AUTOTITLE](/copilot/github-copilot-enterprise/copilot-pull-request-summaries/about-copilot-pull-request-summaries)") @@ -27,8 +27,8 @@ These features are in beta and subject to change. Additional features will be ad ## Signing up for the {% data variables.product.prodname_copilot_enterprise_short %} beta -You can nominate an organization or enterprise that you're a member of for the [{% data variables.product.prodname_copilot_enterprise_short %} waitlist](https://github.com/github-copilot/copilot_enterprise_waitlist_signup/join). To join the waitlist, the organization or enterprise must use {% data variables.product.prodname_ghe_cloud %} and have an active {% data variables.product.prodname_copilot_for_business %} subscription. +You can nominate an enterprise that you're a member of for the [{% data variables.product.prodname_copilot_enterprise_short %} waitlist](https://github.com/github-copilot/copilot_enterprise_waitlist_signup/join). To join the waitlist, the enterprise must use {% data variables.product.prodname_ghe_cloud %} and have an active {% data variables.product.prodname_copilot_for_business %} subscription. -Nominating an organization or enterprise for the waitlist does not guarantee access. By signing up to the waitlist, you are agreeing to the pre-release license terms. For more information, see "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-license-terms)." +Nominating an enterprise for the waitlist does not guarantee access. By signing up to the waitlist, you are agreeing to the pre-release license terms. For more information, see "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-license-terms)." -If an organization or enterprise is granted access to the {% data variables.product.prodname_copilot_enterprise_short %} beta, an administrator must enable the features before members can start using them. For more information, see {% ifversion ghec %}"[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise)."{% elsif fpt %}"[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +If an enterprise is granted access to the {% data variables.product.prodname_copilot_enterprise_short %} beta, an administrator must enable the features before members can start using them. For more information, see {% ifversion ghec %}"[AUTOTITLE](/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise)."{% elsif fpt %}"[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/overview/enabling-github-copilot-enterprise)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} diff --git a/content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md b/content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md index 917147c84b..e519ad42b6 100644 --- a/content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md +++ b/content/desktop/installing-and-authenticating-to-github-desktop/installing-github-desktop.md @@ -9,6 +9,9 @@ redirect_from: versions: feature: desktop --- + +{% data reusables.desktop.desktop-cta-button %} + ## About {% data variables.product.prodname_desktop %} installation You can install {% data variables.product.prodname_desktop %} on supported operating systems, which currently include {% data variables.desktop.mac-osx-versions %} and {% data variables.desktop.windows-versions %}. If you have an account on {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %}, you can connect your account to {% data variables.product.prodname_desktop %}.{% ifversion fpt or ghec %} For more information about creating an account, see "[AUTOTITLE](/get-started/quickstart/creating-an-account-on-github)."{% endif %}{% ifversion ghec %} If you're part of an organization that uses {% data variables.product.prodname_emus %} and you do not have an account, contact your enterprise administrator.{% elsif ghes or ghae %} If you're a member of an organization that uses {% data variables.product.product_name %} and you do not have an account, contact your {% data variables.product.prodname_enterprise %} site administrator.{% endif %} diff --git a/content/desktop/overview/about-github-desktop.md b/content/desktop/overview/about-github-desktop.md index e989bd732c..9d2345909c 100644 --- a/content/desktop/overview/about-github-desktop.md +++ b/content/desktop/overview/about-github-desktop.md @@ -11,21 +11,28 @@ redirect_from: - /get-started/using-github/github-desktop --- +{% data reusables.desktop.desktop-cta-button %} + ## About {% data variables.product.prodname_desktop %} {% data variables.product.prodname_desktop %} is a free, open source application that helps you to work with files hosted on {% data variables.product.prodname_dotcom %} or other Git hosting services. -You can use {% data variables.product.prodname_desktop %} alongside any tools you need to contribute to a project. For example, a typical workflow would be to use {% data variables.product.prodname_desktop %} to download a {% data variables.product.prodname_dotcom %} repository to your computer and create a new branch, use an editor such as {% data variables.product.prodname_vscode %} to make changes to the code, then return to {% data variables.product.prodname_desktop %} to commit and push the changes to {% data variables.product.prodname_dotcom %}. +## Benefits of {% data variables.product.prodname_desktop %} -## About the benefits of {% data variables.product.prodname_desktop %} +{% data variables.product.prodname_desktop %} is useful for beginning and advanced users. Benefits include: -Like any tool for contributing changes to repositories on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_desktop %} is built around the version control software Git. If you're new to Git and {% data variables.product.prodname_dotcom %}, you may find it easier to get started with {% data variables.product.prodname_desktop %} than you would using Git on the command line. Because {% data variables.product.prodname_desktop %} has a graphical user interface, it simplifies many of the aspects of Git that can be challenging for new users, such as memorizing commands and visualizing the changes you're making. +- **Get started easily.** If you're new to Git and {% data variables.product.prodname_dotcom %}, you may find it easier to use {% data variables.product.prodname_desktop %} than to use Git on the command line. {% data variables.product.prodname_desktop %} has a graphical user interface that simplifies commands and helps you visualize changes. +- **Find commands.** Because {% data variables.product.prodname_desktop %} has a visual interface, you can easily access less-common Git commands, such as choosing which changed lines to include in a commit or adding a co-author to a commit, without needing to memorize or look up syntax. +- **Follow best practices.** {% data variables.product.prodname_desktop %} encourages best practices. For example, it helps you to create an accurate and easy-to-follow commit history so other collaborators on a project can easily review your work. +- **Integrate with {% data variables.product.prodname_dotcom %}.** {% data variables.product.prodname_desktop %} is specifically designed for use with {% data variables.product.prodname_dotcom %}. For example, you can authenticate to {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_server %} quickly, without needing to use a separate credential manager. You can also check out a pull request to run checks without needing to open your browser. -Even if you have experience with command-line Git, you may benefit from incorporating {% data variables.product.prodname_desktop %} into your work. If you frequently need to look up syntax for less common Git commands, such as choosing which changed lines to include in a commit or adding a co-author to a commit, you may benefit from switching to {% data variables.product.prodname_desktop %} to perform these commands. +## {% data variables.product.prodname_desktop %} workflow -Because {% data variables.product.prodname_desktop %} makes commands like these easy to find, and helps you visualize the changes you're introducing with an integrated diff view, it encourages best practices and helps you to create an accurate and easy-to-follow commit history so other collaborators on a project can easily review your work. +You can use {% data variables.product.prodname_desktop %} alongside any tools you need to contribute to a project. For example, a typical workflow is: -Unlike other Git clients, {% data variables.product.prodname_desktop %} is specifically designed for use with {% data variables.product.prodname_dotcom %}, so it can make you more productive when working with repositories on {% data variables.product.prodname_dotcom %}. For example, you can authenticate to {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_server %} quickly, without needing to use a separate credential manager, and you can check out a pull request to run checks without needing to open your browser. +- Use {% data variables.product.prodname_desktop %} to download a {% data variables.product.prodname_dotcom %} repository to your computer and create a new branch +- Use an editor such as {% data variables.product.prodname_vscode %} to make changes to the code +- Return to {% data variables.product.prodname_desktop %} to commit and push the changes to {% data variables.product.prodname_dotcom %} ## Getting started diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index d90341ae90..e1f75f6356 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -346,7 +346,7 @@ Footnotes are not supported in wikis. Alerts are an extension of the blockquote syntax that you can use to emphasize critical information. On {% data variables.product.product_name %}, they are displayed with distinctive colors and icons to indicate the importance of the content. Alert syntax is supported in: - Issues -- Pull requestes +- Pull requests - Markdown files - Discussions - Gists diff --git a/content/graphql/guides/forming-calls-with-graphql.md b/content/graphql/guides/forming-calls-with-graphql.md index 1305db7558..2659ddd8ff 100644 --- a/content/graphql/guides/forming-calls-with-graphql.md +++ b/content/graphql/guides/forming-calls-with-graphql.md @@ -407,7 +407,7 @@ For more information on the difference between enums and strings, see the [offic There is a _lot_ more you can do when forming GraphQL calls. Here are some places to look next: -- [Pagination](https://graphql.org/learn/pagination/) +- [AUTOTITLE](/graphql/guides/using-pagination-in-the-graphql-api) - [Fragments](https://graphql.org/learn/queries/#fragments) - [Inline fragments](https://graphql.org/learn/queries/#inline-fragments) - [Directives](https://graphql.org/learn/queries/#directives) diff --git a/content/graphql/guides/index.md b/content/graphql/guides/index.md index 7311e5cf39..d745f87d6f 100644 --- a/content/graphql/guides/index.md +++ b/content/graphql/guides/index.md @@ -16,8 +16,8 @@ children: - /using-global-node-ids - /migrating-from-rest-to-graphql - /using-the-explorer + - /using-pagination-in-the-graphql-api - /managing-enterprise-accounts - /using-the-graphql-api-for-discussions - /migrating-graphql-global-node-ids --- - diff --git a/content/graphql/guides/introduction-to-graphql.md b/content/graphql/guides/introduction-to-graphql.md index 14b05bdf9c..661ff5d5fb 100644 --- a/content/graphql/guides/introduction-to-graphql.md +++ b/content/graphql/guides/introduction-to-graphql.md @@ -71,7 +71,7 @@ It's helpful to picture a graph: dots connected by lines. The dots are nodes, th ## Edge -Edges represent connections between nodes. When you query a connection, you traverse its edges to get to its nodes. Every `edges` field has a `node` field and a `cursor` field. Cursors are used for [pagination](https://graphql.github.io/learn/pagination/). +Edges represent connections between nodes. When you query a connection, you traverse its edges to get to its nodes. Every `edges` field has a `node` field and a `cursor` field. Cursors are used for pagination. For more information, see "[AUTOTITLE](/graphql/guides/using-pagination-in-the-graphql-api)." ## Node diff --git a/content/graphql/guides/using-pagination-in-the-graphql-api.md b/content/graphql/guides/using-pagination-in-the-graphql-api.md new file mode 100644 index 0000000000..896cc7dfe7 --- /dev/null +++ b/content/graphql/guides/using-pagination-in-the-graphql-api.md @@ -0,0 +1,101 @@ +--- +title: Using pagination in the GraphQL API +intro: Learn how to traverse data sets using cursor based pagination with the GraphQL API. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +shortTitle: Pagination +--- + +## About pagination + +{% data variables.product.company_short %}'s GraphQL API limits the number of items that you can fetch in a single request in order to protect against excessive or abusive requests to GitHub's servers. When you use the GraphQL API, you must supply a `first` or `last` argument on any connection. The value of these arguments must be between 1 and 100. The GraphQL API will return the number of connections specified by the `first` or `last` argument. + +If the data that you are accessing has more connections than the number of items specified by the `first` or `last` argument, the response is divided into smaller "pages" of the specified size. These pages can be fetched one at a time until the entire data set has been retrieved. Each page contains the number of items specified by the `first` or `last` argument, unless it is the last page, which may contain a lower number of items. + +This guide demonstrates how to request additional pages of results for paginated responses, how to change the number of results returned on each page, and how to write a script to fetch multiple pages of results. + +## Requesting a `cursor` in your query + +When using the GraphQL API, you use cursors to traverse through a paginated data set. The cursor represents a specific position in the data set. You can get the first and last cursor on a page by querying the `pageInfo` object. For example: + +```graphql +query($owner: String!, $name: String!) { + repository(owner: $owner, name: $name) { + pullRequests(first: 100, after: null) { + nodes { + createdAt + number + title + } + pageInfo { + endCursor + startCursor + hasNextPage + hasPreviousPage + } + } + } +} +``` + +In this example, `pageInfo.startCursor` gives the cursor for the first item on the page. `pageInfo.endCursor` gives the cursor for the last item on the page. `pageInfo.hasNextPage` and `pageInfo.hasPreviousPage` indicate whether there is a page before and after the page that was returned. + +## Changing the number of items per page + +The `first` and `last` arguments control how many items are returned. The maximum number of items you can fetch using the `first` or `last` argument is 100. You may need to request fewer than 100 items if your query touches a lot of data in order to avoid hitting a rate or node limit. For more information, see "[AUTOTITLE](/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api)." + +## Traversing the data set using pagination + +Once you return a cursor from a query, you can use the cursor to request the next page of results. To do so, you will use the `after` or `before` argument and the cursor. + +For example, assuming the `pageInfo.endCursor` value from the previous example was `Y3Vyc29yOnYyOpHOUH8B7g==`, you can use this query to request the next page of results: + +```graphql +query($owner: String!, $name: String!) { + repository(owner: $owner, name: $name) { + pullRequests(first: 1, after: "Y3Vyc29yOnYyOpHOUH8B7g==") { + nodes { + createdAt + number + title + } + pageInfo { + endCursor + hasNextPage + hasPreviousPage + } + } + } +} +``` + +You can continue to send queries with the new `pageInfo.endCursor` value returned in the response until there are no pages left to traverse, indicated by `pageInfo.hasNextPage` returning `false`. + +If you specified the `last` instead of the `first` argument, the last page of results will be returned first. In this case, you will use the `pageInfo.startCursor` value and the `before` argument to get the previous page of results. Once `pageInfo.hasPreviousPage` returns `false`, you have reached the last page. For example: + +```graphql +query($owner: String!, $name: String!) { + repository(owner: $owner, name: $name) { + pullRequests(last: 1, before: "R3Vyc29yOnYyOpHOHcfoOg==") { + nodes { + createdAt + number + title + } + pageInfo { + startCursor + hasPreviousPage + } + } + } +} +``` + +## Next steps + +You can use {% data variables.product.company_short %}'s Octokit SDK and the `octokit/plugin-paginate-graphql` plugin to support pagination in your scripts. For more information, see "[plugin-paginate-graphql.js](https://github.com/octokit/plugin-paginate-graphql.js)." diff --git a/content/graphql/index.md b/content/graphql/index.md index 73d31225ef..4502d00d5c 100644 --- a/content/graphql/index.md +++ b/content/graphql/index.md @@ -13,7 +13,7 @@ featuredLinks: - /graphql/overview/explorer - /graphql/overview/public-schema - /graphql/overview/schema-previews - - /graphql/guides/using-the-graphql-api-for-discussions + - /graphql/guides/using-pagination-in-the-graphql-api guideCards: - /graphql/guides/migrating-from-rest-to-graphql - /graphql/guides/managing-enterprise-accounts @@ -33,4 +33,3 @@ children: - /reference - /guides --- - diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md index 49dac203d7..56df0abf80 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects.md @@ -56,7 +56,7 @@ You can also add teams, external collaborators, and individual organization memb {% ifversion projects-v2-add-to-team %} -If you grant a team read permissions or greater for a project, the project is also displayed on the team's projects page. You can also add projects to a team on the team's projects page. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team)." +If you grant a team read permissions or greater for a project, the project is also displayed on the team's projects page. You can also add projects to a team on the team's projects page. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team)." {% endif %} @@ -93,7 +93,7 @@ You can only invite an individual user to collaborate on your organization-level {% note %} -This only affects collaborators for your project, not for repositories in your project. To view an item on the project, someone must have the required permissions for the repository that the item belongs to. If your project includes items from a private repository, people who are not collaborators in the repository will not be able to view items from that repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." +This only affects collaborators for your project, not for repositories in your project. To view an item on the project, someone must have the required permissions for the repository that the item belongs to. Only people with access to a private repository will be able to view project items from that private repository. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." {% endnote %} diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md index f3af0c566f..bd37f164a5 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization.md @@ -17,24 +17,13 @@ allowTitleToDifferFromFilename: true You can {% ifversion projects-v2-org-templates-improvements %}create a template, or {% endif %}set a project as a template{% ifversion projects-v2-org-templates-improvements %},{% endif %} to share a pre-configured project with other people in your organization which they can then use as the base for their projects. -The projects you have marked as templates are made available in the "Select a template" pop-up window when other people create projects in your organization. +The projects you mark as templates are shown in the "Create a project" dialog when anyone creates a project in your organization. {% ifversion projects-v2-org-templates-GA-updates %}You can also configure up to six templates to recommend to your organization's members.{% endif %} When someone creates a project from a template, the {% data reusables.projects.what-gets-copied %} are copied from the template to the new project. {% ifversion projects-v2-org-templates-improvements %}You can find the template that a project used from the project's settings page, under the "Templates" section.{% endif %} {% ifversion projects-v2-org-templates-improvements %} -## Creating templates - -{% else %} - -## Setting a project as a template - -{% endif %} - -{% ifversion projects-v2-org-templates-improvements %} -You can either create a new template directly, or you can set a project as a template. - -### Creating a new template +## Creating a new template {% data reusables.profile.access_org %} {% data reusables.user-settings.access_org %} @@ -42,9 +31,10 @@ You can either create a new template directly, or you can set a project as a tem {% data reusables.projects.templates-tab %} 1. Click **New template**. -### Setting a project as a template - {% endif %} + +## Setting a project as a template + If you have admin permissions for a project in your organization, you can set the project as a template and make it available for others in your organization to use. {% data reusables.projects.project-settings %} @@ -83,6 +73,39 @@ If you have write or admin permissions for a project in your organization, you c {% data reusables.projects.project-settings %} 1. In the "Templates" section, click {% octicon "duplicate" aria-hidden="true" %} **Copy as template**. +{% ifversion projects-v2-org-templates-GA-updates %} + +## Configuring recommended templates + +If you are an organization owner, you can select up to six templates to recommend to your organization's members. These recommended templates are suggested first when an organization member creates a new project. + +### Choosing which templates to recommend + +You can add up to six templates to your organization's recommended templates. + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +1. In the "Code, planning, and automation" section of the sidebar, click **{% octicon "table" aria-label="The table icon" %} Projects**. +1. Under "Recommended templates", click **Customize recommended templates**. +1. In the list of templates owned by your organization, select up to six templates that you want to recommend to your members. + + ![Screenshot of the recommended template selection modal.](/assets/images/help/projects-v2/rec-template-select.png) + +1. Click **Save**. + +### Arranging your recommended templates + +You can change the display order of your recommended templates in the "Create project" dialog. + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +1. In the "Code planning, and automation" section of the sidebar, click **{% octicon "table" aria-label="The table icon" %} Projects**. +1. Under "Recommended templates", find the template you want to reposition, click on {% octicon "grabber" aria-label="Drag to reorder" %}, and drag the template to the new position. + + ![Screenshot of an organization's recommended templates settings. The 'Drag to reorder' handle is highlighted with an orange outline.](/assets/images/help/projects-v2/rec-template-handle.png) + +{% endif %} + ## Further reading - "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)" diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md index 952680a45e..f92ec50f1c 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md @@ -17,7 +17,7 @@ permissions: Organization owners can manage the visibility of project boards in Projects can be public or private. For public projects, everyone on the internet can view the project. For private projects, only users granted at least read access can see the project. -Only the project visibility is affected; to view an item on the project, someone must have the required permissions for the repository that the item belongs to. If your project includes items from a private repository, people who are not collaborators in the repository will not be able to view items from that repository. +Only the project visibility is affected; to view an item on the project, someone must have the required permissions for the repository that the item belongs to. Only people with access to a private repository will be able to view project items from that private repository. ![Screenshot showing a project using a table layout. One of the items is marked with a padlock icon, indicating it's hidden, and highlighted with an orange outline.](/assets/images/help/projects-v2/hidden-items.png) diff --git a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migration-support-for-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migration-support-for-github-enterprise-importer.md index 3f7ffcaacd..b492a85127 100644 --- a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migration-support-for-github-enterprise-importer.md +++ b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migration-support-for-github-enterprise-importer.md @@ -64,7 +64,7 @@ When you migrate an organization, a new organization is created within the desti - Repositories - Team access to repositories - Member privileges -- Organization-level webhooks +- Organization-level webhooks (must be re-enabled after your migration, see "[Enabling webhooks](/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer#enabling-webhooks)") - Default branch name for new repositories created in the organization All repositories are migrated with private visibility. If you want to set a repository's visibility to public or internal, you can do this after the migration using the UI or API. @@ -87,7 +87,7 @@ When you migrate a repository, either directly or as part of an organization mig - Projects (classic) at the repository level - {% data variables.product.prodname_actions %} workflows - Commit comments -- Active webhooks +- Active webhooks (must be re-enabled after your migration, see "[Enabling webhooks](/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer#enabling-webhooks)") - Repository topics - Repository settings - Branch protections (see "[Branch protections](#branch-protections)" for more details) diff --git a/content/organizations/organizing-members-into-teams/about-teams.md b/content/organizations/organizing-members-into-teams/about-teams.md index dbdc750a7b..1efe1c9d15 100644 --- a/content/organizations/organizing-members-into-teams/about-teams.md +++ b/content/organizations/organizing-members-into-teams/about-teams.md @@ -16,7 +16,7 @@ topics: ## About teams -You can use teams to manage access for people in an organization, and for sending notifications. Organization owners and team maintainers can give teams admin, read, or write access to organization repositories. Organization members can send a notification to an entire team by mentioning the team's name. +You can use teams to manage access for people in an organization, and for sending notifications. Organization owners and team maintainers can give teams admin, read, or write access to organization repositories. Organization members can send a notification to an entire team by mentioning the team's name. Teams can only be made up of members of your organization, outside collaborators are unable to be on a team. {% ifversion team-mentions-setting %}Organization owners and team maintainers can disable team notifications. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/configuring-team-notifications)."{% endif %} diff --git a/content/search-github/searching-on-github/finding-files-on-github.md b/content/search-github/searching-on-github/finding-files-on-github.md index 16e13db394..a9dd511383 100644 --- a/content/search-github/searching-on-github/finding-files-on-github.md +++ b/content/search-github/searching-on-github/finding-files-on-github.md @@ -26,10 +26,10 @@ topics: {% ifversion code-search-code-view %} {% data reusables.repositories.navigate-to-repo %} -1. In the file tree view, click the {% octicon "filter" aria-hidden="true" %} **Jump to file** search bar. You can also find the {% octicon "filter" aria-hidden="true" %} **Jump to file** search bar at the top of the integrated file editor. - - ![Screenshot of the file tree view for a repository. A search bar, labeled "Jump to file", is outlined in dark orange.](/assets/images/help/repository/file-tree-view-jump-to-file.png) -1. In the search bar, type the name of the file or directory you'd like to find. +1. In the “Go to file” search bar, type the name of the file or directory you'd like to find. + ![Screenshot of the main view for a repository. A search bar, labeled "Go to file", is outlined in dark orange.](/assets/images/help/repository/repository-main-page-go-to-file.png) +1. Alternatively, if there is no "Go to file" search bar, click **Go to file**, then type the name of the file or directory you'd like to find. + ![Screenshot of the main view for a repository. A "Go to file" button is outlined in dark orange.](/assets/images/help/repository/repository-main-page-go-to-file-no-search-bar.png) 1. In the list of results, click the file or directory you wanted to find. You can view the file path for a directory or file below each search result. {% else %} {% data reusables.repositories.navigate-to-repo %} diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index a16cbf9775..306179ff32 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -160,6 +160,15 @@ You can use the `involves` qualifier to find issues that in some way involve a c | involves:USERNAME | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** matches issues either @defunkt or @jlord are involved in. | `in:body` involves:USERNAME | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) matches issues @mdo is involved in that do not contain the word "bootstrap" in the body. +## Search for my issues and pull requests + +You can search for issues and pull requests you have created or have interacted with by following the desired qualifier with `@me`. Any qualifier that works with a username allows you to limit your search to issues and pull requests you created, are assigned, mentioned on, or are requested as a reviewer of. + +| Qualifier | Example +| ------------- | ------------- +| author:@me | **[author:@me](https://github.com/search?q=author%3A%40me)** matches issues and pull requests you have authored. +| is:pr commenter:@me | **[is:pr commenter:@me](https://github.com/search?q=is%3Apr+commenter%3A%40me&type=pullrequests)** matches pull requests you have commented on. + ## Search for linked issues and pull requests You can narrow your results to only include issues that are linked to a pull request by a closing reference, or pull requests that are linked to an issue that the pull request may close. diff --git a/data/features/dependabot-grouped-security-updates.yml b/data/features/dependabot-grouped-security-updates.yml new file mode 100644 index 0000000000..3f032aafdc --- /dev/null +++ b/data/features/dependabot-grouped-security-updates.yml @@ -0,0 +1,4 @@ +# Reference: Issue #12592 Dependabot Grouped Security Updates +versions: + fpt: '*' + ghec: '*' diff --git a/data/features/projects-v2-org-templates-GA-updates.yml b/data/features/projects-v2-org-templates-GA-updates.yml new file mode 100644 index 0000000000..bd7ef2c129 --- /dev/null +++ b/data/features/projects-v2-org-templates-GA-updates.yml @@ -0,0 +1,5 @@ +# Issue 11855 +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.12' diff --git a/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md b/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md new file mode 100644 index 0000000000..c5c0762388 --- /dev/null +++ b/data/reusables/code-scanning/codeql-query-tables/codeql-version-info.md @@ -0,0 +1,11 @@ +This table lists the queries available with the latest release of the {% data variables.product.prodname_codeql %} action and {% data variables.product.prodname_codeql_cli %}. For more information, see [{% data variables.product.prodname_codeql %} change logs](https://codeql.github.com/docs/codeql-overview/codeql-changelog/) in the {% data variables.product.prodname_codeql %} documentation site. + +{% ifversion ghes %} + +{% note %} + +**Note:** The initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }} included {% data variables.product.prodname_codeql %} action and {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %}, which may not include all of these queries. Your site administrator can update your {% data variables.product.prodname_codeql %} version to a newer release. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." + +{% endnote %} + +{% endif %} diff --git a/data/reusables/code-scanning/codeql-query-tables/cpp.md b/data/reusables/code-scanning/codeql-query-tables/cpp.md index e69de29bb2..db106e82ef 100644 --- a/data/reusables/code-scanning/codeql-query-tables/cpp.md +++ b/data/reusables/code-scanning/codeql-query-tables/cpp.md @@ -0,0 +1,86 @@ +{% rowheaders %} + +| Query name | Related CWEs | Default | Extended | +| --- | --- | --- | --- | +| [Array offset used before range check](https://codeql.github.com/codeql-query-help/cpp/cpp-offset-use-before-range-check/) | 120, 125 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Authentication bypass by spoofing](https://codeql.github.com/codeql-query-help/cpp/cpp-user-controlled-bypass/) | 290 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Bad check for overflow of integer addition](https://codeql.github.com/codeql-query-help/cpp/cpp-bad-addition-overflow-check/) | 190, 192 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Badly bounded write](https://codeql.github.com/codeql-query-help/cpp/cpp-badly-bounded-write/) | 120, 787, 805 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Call to `memset` may be deleted](https://codeql.github.com/codeql-query-help/cpp/cpp-memset-may-be-deleted/) | 14 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Call to alloca in a loop](https://codeql.github.com/codeql-query-help/cpp/cpp-alloca-in-loop/) | 770 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Call to function with fewer arguments than declared parameters](https://codeql.github.com/codeql-query-help/cpp/cpp-too-few-arguments/) | 234, 685 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cast between HRESULT and a Boolean type](https://codeql.github.com/codeql-query-help/cpp/cpp-hresult-boolean-conversion/) | 253 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cast from char* to wchar_t*](https://codeql.github.com/codeql-query-help/cpp/cpp-incorrect-string-type-conversion/) | 704 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Certificate not checked](https://codeql.github.com/codeql-query-help/cpp/cpp-certificate-not-checked/) | 295 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Certificate result conflation](https://codeql.github.com/codeql-query-help/cpp/cpp-certificate-result-conflation/) | 295 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [CGI script vulnerable to cross-site scripting](https://codeql.github.com/codeql-query-help/cpp/cpp-cgi-xss/) | 079 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information in an SQLite database](https://codeql.github.com/codeql-query-help/cpp/cpp-cleartext-storage-database/) | 313 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information in buffer](https://codeql.github.com/codeql-query-help/cpp/cpp-cleartext-storage-buffer/) | 312 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information in file](https://codeql.github.com/codeql-query-help/cpp/cpp-cleartext-storage-file/) | 260, 313 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext transmission of sensitive information](https://codeql.github.com/codeql-query-help/cpp/cpp-cleartext-transmission/) | 319, 359 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Comma before misleading indentation](https://codeql.github.com/codeql-query-help/cpp/cpp-comma-before-misleading-indentation/) | 1078, 670 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Comparison of narrow type with wide type in loop condition](https://codeql.github.com/codeql-query-help/cpp/cpp-comparison-with-wider-type/) | 190, 197, 835 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Dangerous use of 'cin'](https://codeql.github.com/codeql-query-help/cpp/cpp-dangerous-cin/) | 676 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Exposure of system data to an unauthorized control sphere](https://codeql.github.com/codeql-query-help/cpp/cpp-system-data-exposure/) | 497 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Failure to use HTTPS URLs](https://codeql.github.com/codeql-query-help/cpp/cpp-non-https-url/) | 319, 345 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [File created without restricting permissions](https://codeql.github.com/codeql-query-help/cpp/cpp-world-writable-file-creation/) | 732 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [File opened with O_CREAT flag but without mode argument](https://codeql.github.com/codeql-query-help/cpp/cpp-open-call-with-mode-argument/) | 732 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incorrect 'not' operator usage](https://codeql.github.com/codeql-query-help/cpp/cpp-incorrect-not-operator-usage/) | 480 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Incorrect allocation-error handling](https://codeql.github.com/codeql-query-help/cpp/cpp-incorrect-allocation-error-handling/) | 570, 252, 755 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Invalid pointer dereference](https://codeql.github.com/codeql-query-help/cpp/cpp-invalid-pointer-deref/) | 119, 125, 193, 787 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Likely overrunning write](https://codeql.github.com/codeql-query-help/cpp/cpp-very-likely-overrunning-write/) | 120, 787, 805 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Mismatching new/free or malloc/delete](https://codeql.github.com/codeql-query-help/cpp/cpp-new-free-mismatch/) | 401 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing return-value check for a 'scanf'-like function](https://codeql.github.com/codeql-query-help/cpp/cpp-missing-check-scanf/) | 252, 253 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Multiplication result converted to larger type](https://codeql.github.com/codeql-query-help/cpp/cpp-integer-multiplication-cast-to-long/) | 190, 192, 197, 681 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [No space for zero terminator](https://codeql.github.com/codeql-query-help/cpp/cpp-no-space-for-terminator/) | 131, 120, 122 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Non-constant format string](https://codeql.github.com/codeql-query-help/cpp/cpp-non-constant-format/) | 134 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Not enough memory allocated for array of pointer type](https://codeql.github.com/codeql-query-help/cpp/cpp-suspicious-allocation-size/) | 131, 122 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Not enough memory allocated for pointer type](https://codeql.github.com/codeql-query-help/cpp/cpp-allocation-too-small/) | 131, 122 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [NULL application name with an unquoted path in call to CreateProcess](https://codeql.github.com/codeql-query-help/cpp/cpp-unsafe-create-process-call/) | 428 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Overflow in uncontrolled allocation size](https://codeql.github.com/codeql-query-help/cpp/cpp-uncontrolled-allocation-size/) | 190, 789 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Overrunning write](https://codeql.github.com/codeql-query-help/cpp/cpp-overrun-write/) | 119, 131 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Pointer overflow check](https://codeql.github.com/codeql-query-help/cpp/cpp-pointer-overflow-check/) | 758 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Possibly wrong buffer size in string copy](https://codeql.github.com/codeql-query-help/cpp/cpp-bad-strncpy-size/) | 676, 119, 251 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Potential double free](https://codeql.github.com/codeql-query-help/cpp/cpp-double-free/) | 415 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Potential exposure of sensitive system data to an unauthorized control sphere](https://codeql.github.com/codeql-query-help/cpp/cpp-potential-system-data-exposure/) | 497 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Potential use after free](https://codeql.github.com/codeql-query-help/cpp/cpp-use-after-free/) | 416 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Potentially overflowing call to snprintf](https://codeql.github.com/codeql-query-help/cpp/cpp-overflowing-snprintf/) | 190, 253 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Potentially overrunning write](https://codeql.github.com/codeql-query-help/cpp/cpp-overrunning-write/) | 120, 787, 805 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Potentially overrunning write with float to string conversion](https://codeql.github.com/codeql-query-help/cpp/cpp-overrunning-write-with-float/) | 120, 787, 805 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Potentially uninitialized local variable](https://codeql.github.com/codeql-query-help/cpp/cpp-uninitialized-local/) | 665, 457 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Potentially unsafe call to strncat](https://codeql.github.com/codeql-query-help/cpp/cpp-unsafe-strncat/) | 788, 676, 119, 251 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Potentially unsafe use of strcat](https://codeql.github.com/codeql-query-help/cpp/cpp-unsafe-strcat/) | 676, 120, 251 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Redundant null check due to previous dereference](https://codeql.github.com/codeql-query-help/cpp/cpp-redundant-null-check-simple/) | 476 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Returning stack-allocated memory](https://codeql.github.com/codeql-query-help/cpp/cpp-return-stack-allocated-memory/) | 825 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Setting a DACL to NULL in a SECURITY_DESCRIPTOR](https://codeql.github.com/codeql-query-help/cpp/cpp-unsafe-dacl-security-descriptor/) | 732 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Signed overflow check](https://codeql.github.com/codeql-query-help/cpp/cpp-signed-overflow-check/) | 128, 190 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Static array access may cause overflow](https://codeql.github.com/codeql-query-help/cpp/cpp-static-buffer-overflow/) | 119, 131 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Suspicious 'sizeof' use](https://codeql.github.com/codeql-query-help/cpp/cpp-suspicious-sizeof/) | 467 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Suspicious add with sizeof](https://codeql.github.com/codeql-query-help/cpp/cpp-suspicious-add-sizeof/) | 468 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Suspicious pointer scaling](https://codeql.github.com/codeql-query-help/cpp/cpp-suspicious-pointer-scaling/) | 468 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Suspicious pointer scaling to void](https://codeql.github.com/codeql-query-help/cpp/cpp-suspicious-pointer-scaling-void/) | 468 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Time-of-check time-of-use filesystem race condition](https://codeql.github.com/codeql-query-help/cpp/cpp-toctou-race-condition/) | 367 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Too few arguments to formatting function](https://codeql.github.com/codeql-query-help/cpp/cpp-wrong-number-format-arguments/) | 234, 685 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unbounded write](https://codeql.github.com/codeql-query-help/cpp/cpp-unbounded-write/) | 120, 787, 805 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data in arithmetic expression](https://codeql.github.com/codeql-query-help/cpp/cpp-uncontrolled-arithmetic/) | 190, 191 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data in SQL query](https://codeql.github.com/codeql-query-help/cpp/cpp-sql-injection/) | 089 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in OS command](https://codeql.github.com/codeql-query-help/cpp/cpp-command-line-injection/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/cpp/cpp-path-injection/) | 022, 023, 036, 073 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled format string](https://codeql.github.com/codeql-query-help/cpp/cpp-tainted-format-string/) | 134 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled process operation](https://codeql.github.com/codeql-query-help/cpp/cpp-uncontrolled-process-operation/) | 114 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe use of this in constructor](https://codeql.github.com/codeql-query-help/cpp/cpp-unsafe-use-of-this/) | 670 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsigned difference expression compared to zero](https://codeql.github.com/codeql-query-help/cpp/cpp-unsigned-difference-expression-compared-zero/) | 191 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Unterminated variadic call](https://codeql.github.com/codeql-query-help/cpp/cpp-unterminated-variadic-call/) | 121 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Untrusted input for a condition](https://codeql.github.com/codeql-query-help/cpp/cpp-tainted-permissions-check/) | 807 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Upcast array used in pointer arithmetic](https://codeql.github.com/codeql-query-help/cpp/cpp-upcast-array-pointer-arithmetic/) | 119, 843 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a broken or risky cryptographic algorithm](https://codeql.github.com/codeql-query-help/cpp/cpp-weak-cryptographic-algorithm/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a cryptographic algorithm with insufficient key size](https://codeql.github.com/codeql-query-help/cpp/cpp-insufficient-key-size/) | 326 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a version of OpenSSL with Heartbleed](https://codeql.github.com/codeql-query-help/cpp/cpp-openssl-heartbleed/) | 327, 788 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of dangerous function](https://codeql.github.com/codeql-query-help/cpp/cpp-dangerous-function-overflow/) | 242, 676 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of expired stack-address](https://codeql.github.com/codeql-query-help/cpp/cpp-using-expired-stack-address/) | 825 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of potentially dangerous function](https://codeql.github.com/codeql-query-help/cpp/cpp-potentially-dangerous-function/) | 676 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of string after lifetime ends](https://codeql.github.com/codeql-query-help/cpp/cpp-use-of-string-after-lifetime-ends/) | 416, 664 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Wrong type of arguments to formatting function](https://codeql.github.com/codeql-query-help/cpp/cpp-wrong-type-format-argument/) | 686 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XML external entity expansion](https://codeql.github.com/codeql-query-help/cpp/cpp-external-entity-expansion/) | 611 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | + +{% endrowheaders %} diff --git a/data/reusables/code-scanning/codeql-query-tables/csharp.md b/data/reusables/code-scanning/codeql-query-tables/csharp.md index e69de29bb2..fc4bccf3e9 100644 --- a/data/reusables/code-scanning/codeql-query-tables/csharp.md +++ b/data/reusables/code-scanning/codeql-query-tables/csharp.md @@ -0,0 +1,64 @@ +{% rowheaders %} + +| Query name | Related CWEs | Default | Extended | +| --- | --- | --- | --- | +| ['requireSSL' attribute is not set to true](https://codeql.github.com/codeql-query-help/csharp/cs-web-requiressl-not-set/) | 319, 614 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Arbitrary file access during archive extraction ("Zip Slip")](https://codeql.github.com/codeql-query-help/csharp/cs-zipslip/) | 022 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [ASP.NET config file enables directory browsing](https://codeql.github.com/codeql-query-help/csharp/cs-web-directory-browse-enabled/) | 548 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Assembly path injection](https://codeql.github.com/codeql-query-help/csharp/cs-assembly-path-injection/) | 114 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear text storage of sensitive information](https://codeql.github.com/codeql-query-help/csharp/cs-cleartext-storage-of-sensitive-information/) | 312, 315, 359 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cookie security: overly broad domain](https://codeql.github.com/codeql-query-help/csharp/cs-web-broad-cookie-domain/) | 287 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cookie security: overly broad path](https://codeql.github.com/codeql-query-help/csharp/cs-web-broad-cookie-path/) | 287 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cookie security: persistent cookie](https://codeql.github.com/codeql-query-help/csharp/cs-web-persistent-cookie/) | 539 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Creating an ASP.NET debug binary may reveal sensitive information](https://codeql.github.com/codeql-query-help/csharp/cs-web-debug-binary/) | 11, 532 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cross-site scripting](https://codeql.github.com/codeql-query-help/csharp/cs-web-xss/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Denial of Service from comparison of user input against expensive regex](https://codeql.github.com/codeql-query-help/csharp/cs-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Deserialization of untrusted data](https://codeql.github.com/codeql-query-help/csharp/cs-unsafe-deserialization-untrusted-input/) | 502 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Deserialized delegate](https://codeql.github.com/codeql-query-help/csharp/cs-deserialized-delegate/) | 502 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Empty password in configuration file](https://codeql.github.com/codeql-query-help/csharp/cs-empty-password-in-configuration/) | 258, 862 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Encryption using ECB](https://codeql.github.com/codeql-query-help/csharp/cs-ecb-encryption/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Exposure of private information](https://codeql.github.com/codeql-query-help/csharp/cs-exposure-of-sensitive-information/) | 359 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Failure to abandon session](https://codeql.github.com/codeql-query-help/csharp/cs-session-reuse/) | 384 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded connection string with credentials](https://codeql.github.com/codeql-query-help/csharp/cs-hardcoded-connection-string-credentials/) | 259, 321, 798 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded credentials](https://codeql.github.com/codeql-query-help/csharp/cs-hardcoded-credentials/) | 259, 321, 798 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Header checking disabled](https://codeql.github.com/codeql-query-help/csharp/cs-web-disabled-header-checking/) | 113 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Improper control of generation of code](https://codeql.github.com/codeql-query-help/csharp/cs-code-injection/) | 094, 095, 096 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Information exposure through an exception](https://codeql.github.com/codeql-query-help/csharp/cs-information-exposure-through-exception/) | 209, 497 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Information exposure through transmitted data](https://codeql.github.com/codeql-query-help/csharp/cs-sensitive-data-transmission/) | 201 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure Direct Object Reference](https://codeql.github.com/codeql-query-help/csharp/cs-web-insecure-direct-object-reference/) | 639 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure randomness](https://codeql.github.com/codeql-query-help/csharp/cs-insecure-randomness/) | 338 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure SQL connection](https://codeql.github.com/codeql-query-help/csharp/cs-insecure-sql-connection/) | 327 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [LDAP query built from stored user-controlled sources](https://codeql.github.com/codeql-query-help/csharp/cs-stored-ldap-injection/) | 090 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [LDAP query built from user-controlled sources](https://codeql.github.com/codeql-query-help/csharp/cs-ldap-injection/) | 090 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Log entries created from user input](https://codeql.github.com/codeql-query-help/csharp/cs-log-forging/) | 117 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing cross-site request forgery token validation](https://codeql.github.com/codeql-query-help/csharp/cs-web-missing-token-validation/) | 352 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing function level access control](https://codeql.github.com/codeql-query-help/csharp/cs-web-missing-function-level-access-control/) | 285, 284, 862 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing global error handler](https://codeql.github.com/codeql-query-help/csharp/cs-web-missing-global-error-handler/) | 12, 248 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing X-Frame-Options HTTP header](https://codeql.github.com/codeql-query-help/csharp/cs-web-missing-x-frame-options/) | 451, 829 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing XML validation](https://codeql.github.com/codeql-query-help/csharp/cs-xml-missing-validation/) | 112 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Password in configuration file](https://codeql.github.com/codeql-query-help/csharp/cs-password-in-configuration/) | 13, 256, 313 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Regular expression injection](https://codeql.github.com/codeql-query-help/csharp/cs-regex-injection/) | 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Resource injection](https://codeql.github.com/codeql-query-help/csharp/cs-resource-injection/) | 099 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Serialization check bypass](https://codeql.github.com/codeql-query-help/csharp/cs-serialization-check-bypass/) | 20 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [SQL query built from stored user-controlled sources](https://codeql.github.com/codeql-query-help/csharp/cs-second-order-sql-injection/) | 089 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [SQL query built from user-controlled sources](https://codeql.github.com/codeql-query-help/csharp/cs-sql-injection/) | 089 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Stored cross-site scripting](https://codeql.github.com/codeql-query-help/csharp/cs-web-stored-xss/) | 079, 116 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Stored XPath injection](https://codeql.github.com/codeql-query-help/csharp/cs-xml-stored-xpath-injection/) | 643 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Thread-unsafe capturing of an ICryptoTransform object](https://codeql.github.com/codeql-query-help/csharp/cs-thread-unsafe-icryptotransform-captured-in-lambda/) | 362 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Thread-unsafe use of a static ICryptoTransform field](https://codeql.github.com/codeql-query-help/csharp/cs-thread-unsafe-icryptotransform-field-in-class/) | 362 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled command line](https://codeql.github.com/codeql-query-help/csharp/cs-command-line-injection/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled command line from stored user input](https://codeql.github.com/codeql-query-help/csharp/cs-stored-command-line-injection/) | 078, 088 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/csharp/cs-path-injection/) | 022, 023, 036, 073, 099 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled format string](https://codeql.github.com/codeql-query-help/csharp/cs-uncontrolled-format-string/) | 134 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Untrusted XML is read insecurely](https://codeql.github.com/codeql-query-help/csharp/cs-xml-insecure-dtd-handling/) | 611, 827, 776 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unvalidated local pointer arithmetic](https://codeql.github.com/codeql-query-help/csharp/cs-unvalidated-local-pointer-arithmetic/) | 119, 120, 122, 788 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [URL redirection from remote source](https://codeql.github.com/codeql-query-help/csharp/cs-web-unvalidated-url-redirection/) | 601 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of file upload](https://codeql.github.com/codeql-query-help/csharp/cs-web-file-upload/) | 434 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [User-controlled bypass of sensitive method](https://codeql.github.com/codeql-query-help/csharp/cs-user-controlled-bypass/) | 807, 247, 350 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Weak encryption](https://codeql.github.com/codeql-query-help/csharp/cs-weak-encryption/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Weak encryption: inadequate RSA padding](https://codeql.github.com/codeql-query-help/csharp/cs-inadequate-rsa-padding/) | 327, 780 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Weak encryption: Insufficient key size](https://codeql.github.com/codeql-query-help/csharp/cs-insufficient-key-size/) | 326 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XML injection](https://codeql.github.com/codeql-query-help/csharp/cs-xml-injection/) | 091 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XPath injection](https://codeql.github.com/codeql-query-help/csharp/cs-xml-xpath-injection/) | 643 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | + +{% endrowheaders %} diff --git a/data/reusables/code-scanning/codeql-query-tables/go.md b/data/reusables/code-scanning/codeql-query-tables/go.md index e69de29bb2..3dab14cc78 100644 --- a/data/reusables/code-scanning/codeql-query-tables/go.md +++ b/data/reusables/code-scanning/codeql-query-tables/go.md @@ -0,0 +1,34 @@ +{% rowheaders %} + +| Query name | Related CWEs | Default | Extended | +| --- | --- | --- | --- | +| [Arbitrary file access during archive extraction ("Zip Slip")](https://codeql.github.com/codeql-query-help/go/go-zipslip/) | 022 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Arbitrary file write extracting an archive containing symbolic links](https://codeql.github.com/codeql-query-help/go/go-unsafe-unzip-symlink/) | 022 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Bad redirect check](https://codeql.github.com/codeql-query-help/go/go-bad-redirect-check/) | 601 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear-text logging of sensitive information](https://codeql.github.com/codeql-query-help/go/go-clear-text-logging/) | 312, 315, 359 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Command built from user-controlled sources](https://codeql.github.com/codeql-query-help/go/go-command-injection/) | 078 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Database query built from user-controlled sources](https://codeql.github.com/codeql-query-help/go/go-sql-injection/) | 089 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Disabled TLS certificate check](https://codeql.github.com/codeql-query-help/go/go-disabled-certificate-check/) | 295 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Email content injection](https://codeql.github.com/codeql-query-help/go/go-email-injection/) | 640 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded credentials](https://codeql.github.com/codeql-query-help/go/go-hardcoded-credentials/) | 259, 321, 798 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete regular expression for hostnames](https://codeql.github.com/codeql-query-help/go/go-incomplete-hostname-regexp/) | 20 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete URL scheme check](https://codeql.github.com/codeql-query-help/go/go-incomplete-url-scheme-check/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incorrect conversion between integer types](https://codeql.github.com/codeql-query-help/go/go-incorrect-integer-conversion/) | 190, 681 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Information exposure through a stack trace](https://codeql.github.com/codeql-query-help/go/go-stack-trace-exposure/) | 209, 497 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure TLS configuration](https://codeql.github.com/codeql-query-help/go/go-insecure-tls/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Log entries created from user input](https://codeql.github.com/codeql-query-help/go/go-log-injection/) | 117 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing regular expression anchor](https://codeql.github.com/codeql-query-help/go/go-regex-missing-regexp-anchor/) | 20 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Open URL redirect](https://codeql.github.com/codeql-query-help/go/go-unvalidated-url-redirection/) | 601 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Potentially unsafe quoting](https://codeql.github.com/codeql-query-help/go/go-unsafe-quoting/) | 078, 089, 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Reflected cross-site scripting](https://codeql.github.com/codeql-query-help/go/go-reflected-xss/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Size computation for allocation may overflow](https://codeql.github.com/codeql-query-help/go/go-allocation-size-overflow/) | 190 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Suspicious characters in a regular expression](https://codeql.github.com/codeql-query-help/go/go-suspicious-character-in-regex/) | 20 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in network request](https://codeql.github.com/codeql-query-help/go/go-request-forgery/) | 918 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/go/go-path-injection/) | 022, 023, 036, 073, 099 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a weak cryptographic key](https://codeql.github.com/codeql-query-help/go/go-weak-crypto-key/) | 326 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of constant `state` value in OAuth 2.0 URL](https://codeql.github.com/codeql-query-help/go/go-constant-oauth2-state/) | 352 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of insecure HostKeyCallback implementation](https://codeql.github.com/codeql-query-help/go/go-insecure-hostkeycallback/) | 322 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of insufficient randomness as the key of a cryptographic algorithm](https://codeql.github.com/codeql-query-help/go/go-insecure-randomness/) | 338 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XPath injection](https://codeql.github.com/codeql-query-help/go/go-xml-xpath-injection/) | 643 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | + +{% endrowheaders %} diff --git a/data/reusables/code-scanning/codeql-query-tables/java.md b/data/reusables/code-scanning/codeql-query-tables/java.md index e69de29bb2..dfbcaf7a29 100644 --- a/data/reusables/code-scanning/codeql-query-tables/java.md +++ b/data/reusables/code-scanning/codeql-query-tables/java.md @@ -0,0 +1,105 @@ +{% rowheaders %} + +| Query name | Related CWEs | Default | Extended | +| --- | --- | --- | --- | +| [`TrustManager` that accepts all certificates](https://codeql.github.com/codeql-query-help/java/java-insecure-trustmanager/) | 295 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Access Java object methods through JavaScript exposure](https://codeql.github.com/codeql-query-help/java/java-android-webview-addjavascriptinterface/) | 079 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Android `WebView` that accepts all certificates](https://codeql.github.com/codeql-query-help/java/java-improper-webview-certificate-validation/) | 295 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Android APK installation](https://codeql.github.com/codeql-query-help/java/java-android-arbitrary-apk-installation/) | 094 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Android debuggable attribute enabled](https://codeql.github.com/codeql-query-help/java/java-android-debuggable-attribute-enabled/) | 489 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Android fragment injection](https://codeql.github.com/codeql-query-help/java/java-android-fragment-injection/) | 470 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Android fragment injection in PreferenceActivity](https://codeql.github.com/codeql-query-help/java/java-android-fragment-injection-preference-activity/) | 470 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Android Intent redirection](https://codeql.github.com/codeql-query-help/java/java-android-intent-redirection/) | 926, 940 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Android missing certificate pinning](https://codeql.github.com/codeql-query-help/java/java-android-missing-certificate-pinning/) | 295 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Android sensitive keyboard cache](https://codeql.github.com/codeql-query-help/java/java-android-sensitive-keyboard-cache/) | 524 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Android WebSettings file access](https://codeql.github.com/codeql-query-help/java/java-android-websettings-file-access/) | 200 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Android Webview debugging enabled](https://codeql.github.com/codeql-query-help/java/java-android-webview-debugging-enabled/) | 489 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Android WebView JavaScript settings](https://codeql.github.com/codeql-query-help/java/java-android-websettings-javascript-enabled/) | 079 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Android WebView settings allows access to content links](https://codeql.github.com/codeql-query-help/java/java-android-websettings-allow-content-access/) | 200 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Application backup allowed](https://codeql.github.com/codeql-query-help/java/java-android-backup-enabled/) | 312 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Arbitrary file access during archive extraction ("Zip Slip")](https://codeql.github.com/codeql-query-help/java/java-zipslip/) | 022 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Building a command line with string concatenation](https://codeql.github.com/codeql-query-help/java/java-concatenated-command-line/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information in cookie](https://codeql.github.com/codeql-query-help/java/java-cleartext-storage-in-cookie/) | 315 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information in the Android filesystem](https://codeql.github.com/codeql-query-help/java/java-android-cleartext-storage-filesystem/) | 312 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information using 'Properties' class](https://codeql.github.com/codeql-query-help/java/java-cleartext-storage-in-properties/) | 313 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information using `SharedPreferences` on Android](https://codeql.github.com/codeql-query-help/java/java-android-cleartext-storage-shared-prefs/) | 312 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information using a local database on Android](https://codeql.github.com/codeql-query-help/java/java-android-cleartext-storage-database/) | 312 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Comparison of narrow type with wide type in loop condition](https://codeql.github.com/codeql-query-help/java/java-comparison-with-wider-type/) | 190, 197 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Cross-site scripting](https://codeql.github.com/codeql-query-help/java/java-xss/) | 079 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Depending upon JCenter/Bintray as an artifact repository](https://codeql.github.com/codeql-query-help/java/java-maven-dependency-upon-bintray/) | 1104 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Deserialization of user-controlled data](https://codeql.github.com/codeql-query-help/java/java-unsafe-deserialization/) | 502 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Detect JHipster Generator Vulnerability CVE-2019-16303](https://codeql.github.com/codeql-query-help/java/java-jhipster-prng/) | 338 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Disabled Netty HTTP header validation](https://codeql.github.com/codeql-query-help/java/java-netty-http-request-or-response-splitting/) | 93, 113 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Disabled Spring CSRF protection](https://codeql.github.com/codeql-query-help/java/java-spring-disabled-csrf-protection/) | 352 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Executing a command with a relative path](https://codeql.github.com/codeql-query-help/java/java-relative-path-command/) | 078, 088 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Expression language injection (JEXL)](https://codeql.github.com/codeql-query-help/java/java-jexl-expression-injection/) | 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Expression language injection (MVEL)](https://codeql.github.com/codeql-query-help/java/java-mvel-expression-injection/) | 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Expression language injection (Spring)](https://codeql.github.com/codeql-query-help/java/java-spel-expression-injection/) | 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Failure to use HTTPS or SFTP URL in Maven artifact upload/download](https://codeql.github.com/codeql-query-help/java/java-maven-non-https-url/) | 300, 319, 494, 829 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Failure to use secure cookies](https://codeql.github.com/codeql-query-help/java/java-insecure-cookie/) | 614 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Groovy Language injection](https://codeql.github.com/codeql-query-help/java/java-groovy-injection/) | 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded credential in API call](https://codeql.github.com/codeql-query-help/java/java-hardcoded-credential-api-call/) | 798 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [HTTP response splitting](https://codeql.github.com/codeql-query-help/java/java-http-response-splitting/) | 113 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Implicit narrowing conversion in compound assignment](https://codeql.github.com/codeql-query-help/java/java-implicit-cast-in-compound-assignment/) | 190, 192, 197, 681 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Implicitly exported Android component](https://codeql.github.com/codeql-query-help/java/java-android-implicitly-exported-component/) | 926 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Improper validation of user-provided array index](https://codeql.github.com/codeql-query-help/java/java-improper-validation-of-array-index/) | 129 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Improper validation of user-provided size used for array construction](https://codeql.github.com/codeql-query-help/java/java-improper-validation-of-array-construction/) | 129 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Improper verification of intent by broadcast receiver](https://codeql.github.com/codeql-query-help/java/java-improper-intent-verification/) | 925 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Inefficient regular expression](https://codeql.github.com/codeql-query-help/java/java-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Information exposure through a stack trace](https://codeql.github.com/codeql-query-help/java/java-stack-trace-exposure/) | 209, 497 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure basic authentication](https://codeql.github.com/codeql-query-help/java/java-insecure-basic-auth/) | 522, 319 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure Bean Validation](https://codeql.github.com/codeql-query-help/java/java-insecure-bean-validation/) | 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure JavaMail SSL Configuration](https://codeql.github.com/codeql-query-help/java/java-insecure-smtp-ssl/) | 297 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure LDAP authentication](https://codeql.github.com/codeql-query-help/java/java-insecure-ldap-auth/) | 522, 319 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insertion of sensitive information into log files](https://codeql.github.com/codeql-query-help/java/java-sensitive-log/) | 532 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Intent URI permission manipulation](https://codeql.github.com/codeql-query-help/java/java-android-intent-uri-permission-manipulation/) | 266, 926 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [JNDI lookup with user-controlled name](https://codeql.github.com/codeql-query-help/java/java-jndi-injection/) | 074 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [LDAP query built from user-controlled sources](https://codeql.github.com/codeql-query-help/java/java-ldap-injection/) | 090 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Leaking sensitive information through a ResultReceiver](https://codeql.github.com/codeql-query-help/java/java-android-sensitive-result-receiver/) | 927 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Leaking sensitive information through an implicit Intent](https://codeql.github.com/codeql-query-help/java/java-android-sensitive-communication/) | 927 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Local information disclosure in a temporary directory](https://codeql.github.com/codeql-query-help/java/java-local-temp-file-or-directory-information-disclosure/) | 200, 732 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Log Injection](https://codeql.github.com/codeql-query-help/java/java-log-injection/) | 117 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Loop with unreachable exit condition](https://codeql.github.com/codeql-query-help/java/java-unreachable-exit-in-loop/) | 835 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing JWT signature check](https://codeql.github.com/codeql-query-help/java/java-missing-jwt-signature-check/) | 347 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing read or write permission in a content provider](https://codeql.github.com/codeql-query-help/java/java-android-incomplete-provider-permissions/) | 926 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [OGNL Expression Language statement with user-controlled input](https://codeql.github.com/codeql-query-help/java/java-ognl-injection/) | 917 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Overly permissive regular expression range](https://codeql.github.com/codeql-query-help/java/java-overly-large-range/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Partial path traversal vulnerability](https://codeql.github.com/codeql-query-help/java/java-partial-path-traversal/) | 023 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Partial path traversal vulnerability from remote](https://codeql.github.com/codeql-query-help/java/java-partial-path-traversal-from-remote/) | 023 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Polynomial regular expression used on uncontrolled data](https://codeql.github.com/codeql-query-help/java/java-polynomial-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Query built by concatenation with a possibly-untrusted string](https://codeql.github.com/codeql-query-help/java/java-concatenated-sql-query/) | 089, 564 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Query built from user-controlled sources](https://codeql.github.com/codeql-query-help/java/java-sql-injection/) | 089, 564 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Race condition in socket authentication](https://codeql.github.com/codeql-query-help/java/java-socket-auth-race-condition/) | 421 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Reading from a world writable file](https://codeql.github.com/codeql-query-help/java/java-world-writable-file-read/) | 732 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Regular expression injection](https://codeql.github.com/codeql-query-help/java/java-regex-injection/) | 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Resolving XML external entity in user-controlled data](https://codeql.github.com/codeql-query-help/java/java-xxe/) | 611, 776, 827 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Server-side request forgery](https://codeql.github.com/codeql-query-help/java/java-ssrf/) | 918 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Server-side template injection](https://codeql.github.com/codeql-query-help/java/java-server-side-template-injection/) | 1336, 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Time-of-check time-of-use race condition](https://codeql.github.com/codeql-query-help/java/java-toctou-race-condition/) | 367 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Trust boundary violation](https://codeql.github.com/codeql-query-help/java/java-trust-boundary-violation/) | 501 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled command line](https://codeql.github.com/codeql-query-help/java/java-command-line-injection/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data in arithmetic expression](https://codeql.github.com/codeql-query-help/java/java-uncontrolled-arithmetic/) | 190, 191 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in content resolution](https://codeql.github.com/codeql-query-help/java/java-android-unsafe-content-uri-resolution/) | 441, 610 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/java/java-path-injection/) | 022, 023, 036, 073 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unreleased lock](https://codeql.github.com/codeql-query-help/java/java-unreleased-lock/) | 764, 833 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe certificate trust](https://codeql.github.com/codeql-query-help/java/java-unsafe-cert-trust/) | 273 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe hostname verification](https://codeql.github.com/codeql-query-help/java/java-unsafe-hostname-verification/) | 297 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe resource fetching in Android WebView](https://codeql.github.com/codeql-query-help/java/java-android-unsafe-android-webview-fetch/) | 749, 079 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [URL redirection from remote source](https://codeql.github.com/codeql-query-help/java/java-unvalidated-url-redirection/) | 601 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a broken or risky cryptographic algorithm](https://codeql.github.com/codeql-query-help/java/java-weak-cryptographic-algorithm/) | 327, 328 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a cryptographic algorithm with insufficient key size](https://codeql.github.com/codeql-query-help/java/java-insufficient-key-size/) | 326 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a potentially broken or risky cryptographic algorithm](https://codeql.github.com/codeql-query-help/java/java-potentially-weak-cryptographic-algorithm/) | 327, 328 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a potentially dangerous function](https://codeql.github.com/codeql-query-help/java/java-potentially-dangerous-function/) | 676 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a predictable seed in a secure random number generator](https://codeql.github.com/codeql-query-help/java/java-predictable-seed/) | 335, 337 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of externally-controlled format string](https://codeql.github.com/codeql-query-help/java/java-tainted-format-string/) | 134 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of implicit PendingIntents](https://codeql.github.com/codeql-query-help/java/java-android-implicit-pendingintents/) | 927 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of RSA algorithm without OAEP](https://codeql.github.com/codeql-query-help/java/java-rsa-without-oaep/) | 780 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [User-controlled bypass of sensitive method](https://codeql.github.com/codeql-query-help/java/java-user-controlled-bypass/) | 807, 290 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [User-controlled data in arithmetic expression](https://codeql.github.com/codeql-query-help/java/java-tainted-arithmetic/) | 190, 191 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [User-controlled data in numeric cast](https://codeql.github.com/codeql-query-help/java/java-tainted-numeric-cast/) | 197, 681 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [User-controlled data used in permissions check](https://codeql.github.com/codeql-query-help/java/java-tainted-permissions-check/) | 807, 290 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Using a static initialization vector for encryption](https://codeql.github.com/codeql-query-help/java/java-static-initialization-vector/) | 329, 1204 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XPath injection](https://codeql.github.com/codeql-query-help/java/java-xml-xpath-injection/) | 643 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XSLT transformation with user-controlled stylesheet](https://codeql.github.com/codeql-query-help/java/java-xslt-injection/) | 074 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | + +{% endrowheaders %} diff --git a/data/reusables/code-scanning/codeql-query-tables/javascript.md b/data/reusables/code-scanning/codeql-query-tables/javascript.md index e69de29bb2..830b5b9d8e 100644 --- a/data/reusables/code-scanning/codeql-query-tables/javascript.md +++ b/data/reusables/code-scanning/codeql-query-tables/javascript.md @@ -0,0 +1,107 @@ +{% rowheaders %} + +| Query name | Related CWEs | Default | Extended | +| --- | --- | --- | --- | +| [Arbitrary file access during archive extraction ("Zip Slip")](https://codeql.github.com/codeql-query-help/javascript/js-zipslip/) | 022 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Bad HTML filtering regexp](https://codeql.github.com/codeql-query-help/javascript/js-bad-tag-filter/) | 020, 080, 116, 184, 185, 186 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Case-sensitive middleware path](https://codeql.github.com/codeql-query-help/javascript/js-case-sensitive-middleware-path/) | 178 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear text storage of sensitive information](https://codeql.github.com/codeql-query-help/javascript/js-clear-text-storage-of-sensitive-data/) | 312, 315, 359 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear text transmission of sensitive cookie](https://codeql.github.com/codeql-query-help/javascript/js-clear-text-cookie/) | 614, 311, 312, 319 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear-text logging of sensitive information](https://codeql.github.com/codeql-query-help/javascript/js-clear-text-logging/) | 312, 359, 532 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Client-side cross-site scripting](https://codeql.github.com/codeql-query-help/javascript/js-xss/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Client-side request forgery](https://codeql.github.com/codeql-query-help/javascript/js-client-side-request-forgery/) | 918 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Client-side URL redirect](https://codeql.github.com/codeql-query-help/javascript/js-client-side-unvalidated-url-redirection/) | 079, 116, 601 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Code injection](https://codeql.github.com/codeql-query-help/javascript/js-code-injection/) | 094, 095, 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [CORS misconfiguration for credentials transfer](https://codeql.github.com/codeql-query-help/javascript/js-cors-misconfiguration-for-credentials/) | 346, 639, 942 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Creating biased random numbers from a cryptographically secure source](https://codeql.github.com/codeql-query-help/javascript/js-biased-cryptographic-random/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cross-window communication with unrestricted target origin](https://codeql.github.com/codeql-query-help/javascript/js-cross-window-information-leak/) | 201, 359 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Database query built from user-controlled sources](https://codeql.github.com/codeql-query-help/javascript/js-sql-injection/) | 089, 090, 943 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Dependency download using unencrypted communication channel](https://codeql.github.com/codeql-query-help/javascript/js-insecure-dependency/) | 300, 319, 494, 829 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Deserialization of user-controlled data](https://codeql.github.com/codeql-query-help/javascript/js-unsafe-deserialization/) | 502 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Disabling certificate validation](https://codeql.github.com/codeql-query-help/javascript/js-disabling-certificate-validation/) | 295, 297 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Disabling Electron webSecurity](https://codeql.github.com/codeql-query-help/javascript/js-disabling-electron-websecurity/) | 79 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Disabling SCE](https://codeql.github.com/codeql-query-help/javascript/js-angular-disabling-sce/) | 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [DOM text reinterpreted as HTML](https://codeql.github.com/codeql-query-help/javascript/js-xss-through-dom/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Double compilation](https://codeql.github.com/codeql-query-help/javascript/js-angular-double-compilation/) | 1176 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Double escaping or unescaping](https://codeql.github.com/codeql-query-help/javascript/js-double-escaping/) | 116, 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Download of sensitive file through insecure connection](https://codeql.github.com/codeql-query-help/javascript/js-insecure-download/) | 829 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Empty password in configuration file](https://codeql.github.com/codeql-query-help/javascript/js-empty-password-in-configuration-file/) | 258, 862 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Enabling Electron allowRunningInsecureContent](https://codeql.github.com/codeql-query-help/javascript/js-enabling-electron-insecure-content/) | 494 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Exception text reinterpreted as HTML](https://codeql.github.com/codeql-query-help/javascript/js-xss-through-exception/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Exposure of private files](https://codeql.github.com/codeql-query-help/javascript/js-exposure-of-private-files/) | 200, 219, 548 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Expression injection in Actions](https://codeql.github.com/codeql-query-help/javascript/js-actions-command-injection/) | 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Failure to abandon session](https://codeql.github.com/codeql-query-help/javascript/js-session-fixation/) | 384 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [File data in outbound network request](https://codeql.github.com/codeql-query-help/javascript/js-file-access-to-http/) | 200 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded credentials](https://codeql.github.com/codeql-query-help/javascript/js-hardcoded-credentials/) | 259, 321, 798 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded data interpreted as code](https://codeql.github.com/codeql-query-help/javascript/js-hardcoded-data-interpreted-as-code/) | 506 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Host header poisoning in email generation](https://codeql.github.com/codeql-query-help/javascript/js-host-header-forgery-in-email-generation/) | 640 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Improper code sanitization](https://codeql.github.com/codeql-query-help/javascript/js-bad-code-sanitization/) | 094, 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Inclusion of functionality from an untrusted source](https://codeql.github.com/codeql-query-help/javascript/js-functionality-from-untrusted-source/) | 830 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete HTML attribute sanitization](https://codeql.github.com/codeql-query-help/javascript/js-incomplete-html-attribute-sanitization/) | 079, 116, 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete multi-character sanitization](https://codeql.github.com/codeql-query-help/javascript/js-incomplete-multi-character-sanitization/) | 020, 080, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete regular expression for hostnames](https://codeql.github.com/codeql-query-help/javascript/js-incomplete-hostname-regexp/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete string escaping or encoding](https://codeql.github.com/codeql-query-help/javascript/js-incomplete-sanitization/) | 020, 080, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete URL scheme check](https://codeql.github.com/codeql-query-help/javascript/js-incomplete-url-scheme-check/) | 020, 184 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete URL substring sanitization](https://codeql.github.com/codeql-query-help/javascript/js-incomplete-url-substring-sanitization/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incorrect suffix check](https://codeql.github.com/codeql-query-help/javascript/js-incorrect-suffix-check/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Indirect uncontrolled command line](https://codeql.github.com/codeql-query-help/javascript/js-indirect-command-line-injection/) | 078, 088 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Inefficient regular expression](https://codeql.github.com/codeql-query-help/javascript/js-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Information exposure through a stack trace](https://codeql.github.com/codeql-query-help/javascript/js-stack-trace-exposure/) | 209, 497 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure randomness](https://codeql.github.com/codeql-query-help/javascript/js-insecure-randomness/) | 338 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure temporary file](https://codeql.github.com/codeql-query-help/javascript/js-insecure-temporary-file/) | 377, 378 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure URL whitelist](https://codeql.github.com/codeql-query-help/javascript/js-angular-insecure-url-whitelist/) | 183, 625 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [JWT missing secret or public key verification](https://codeql.github.com/codeql-query-help/javascript/js-jwt-missing-verification/) | 347 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Log injection](https://codeql.github.com/codeql-query-help/javascript/js-log-injection/) | 117 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Loop bound injection](https://codeql.github.com/codeql-query-help/javascript/js-loop-bound-injection/) | 834, 730 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing CSRF middleware](https://codeql.github.com/codeql-query-help/javascript/js-missing-token-validation/) | 352 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing origin verification in `postMessage` handler](https://codeql.github.com/codeql-query-help/javascript/js-missing-origin-check/) | 020, 940 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing rate limiting](https://codeql.github.com/codeql-query-help/javascript/js-missing-rate-limiting/) | 770, 307, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing regular expression anchor](https://codeql.github.com/codeql-query-help/javascript/js-regex-missing-regexp-anchor/) | 020 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Network data written to file](https://codeql.github.com/codeql-query-help/javascript/js-http-to-file-access/) | 912, 434 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Overly permissive regular expression range](https://codeql.github.com/codeql-query-help/javascript/js-overly-large-range/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Password in configuration file](https://codeql.github.com/codeql-query-help/javascript/js-password-in-configuration-file/) | 256, 260, 313, 522 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Polynomial regular expression used on uncontrolled data](https://codeql.github.com/codeql-query-help/javascript/js-polynomial-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Potential file system race condition](https://codeql.github.com/codeql-query-help/javascript/js-file-system-race/) | 367 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Potentially unsafe external link](https://codeql.github.com/codeql-query-help/javascript/js-unsafe-external-link/) | 200, 1022 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Prototype-polluting assignment](https://codeql.github.com/codeql-query-help/javascript/js-prototype-polluting-assignment/) | 078, 079, 094, 400, 471, 915 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Prototype-polluting function](https://codeql.github.com/codeql-query-help/javascript/js-prototype-pollution-utility/) | 078, 079, 094, 400, 471, 915 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Prototype-polluting merge call](https://codeql.github.com/codeql-query-help/javascript/js-prototype-pollution/) | 078, 079, 094, 400, 471, 915 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Reflected cross-site scripting](https://codeql.github.com/codeql-query-help/javascript/js-reflected-xss/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Regular expression injection](https://codeql.github.com/codeql-query-help/javascript/js-regex-injection/) | 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Remote property injection](https://codeql.github.com/codeql-query-help/javascript/js-remote-property-injection/) | 250, 400 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Replacement of a substring with itself](https://codeql.github.com/codeql-query-help/javascript/js-identity-replacement/) | 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Resource exhaustion](https://codeql.github.com/codeql-query-help/javascript/js-resource-exhaustion/) | 400, 770 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Resources exhaustion from deep object traversal](https://codeql.github.com/codeql-query-help/javascript/js-resource-exhaustion-from-deep-object-traversal/) | 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Second order command injection](https://codeql.github.com/codeql-query-help/javascript/js-second-order-command-line-injection/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Sensitive cookie without SameSite restrictions](https://codeql.github.com/codeql-query-help/javascript/js-samesite-none-cookie/) | 1275 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Sensitive data read from GET request](https://codeql.github.com/codeql-query-help/javascript/js-sensitive-get-query/) | 598 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Sensitive server cookie exposed to the client](https://codeql.github.com/codeql-query-help/javascript/js-client-exposed-cookie/) | 1004 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Server crash](https://codeql.github.com/codeql-query-help/javascript/js-server-crash/) | 248, 730 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Server-side request forgery](https://codeql.github.com/codeql-query-help/javascript/js-request-forgery/) | 918 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Server-side URL redirect](https://codeql.github.com/codeql-query-help/javascript/js-server-side-unvalidated-url-redirection/) | 601 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Shell command built from environment values](https://codeql.github.com/codeql-query-help/javascript/js-shell-command-injection-from-environment/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Storage of sensitive information in build artifact](https://codeql.github.com/codeql-query-help/javascript/js-build-artifact-leak/) | 312, 315, 359 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Stored cross-site scripting](https://codeql.github.com/codeql-query-help/javascript/js-stored-xss/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Template Object Injection](https://codeql.github.com/codeql-query-help/javascript/js-template-object-injection/) | 073, 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Type confusion through parameter tampering](https://codeql.github.com/codeql-query-help/javascript/js-type-confusion-through-parameter-tampering/) | 843 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled command line](https://codeql.github.com/codeql-query-help/javascript/js-command-line-injection/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/javascript/js-path-injection/) | 022, 023, 036, 073, 099 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unnecessary use of `cat` process](https://codeql.github.com/codeql-query-help/javascript/js-unnecessary-use-of-cat/) | 078 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe code constructed from library input](https://codeql.github.com/codeql-query-help/javascript/js-unsafe-code-construction/) | 094, 079, 116 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe dynamic method access](https://codeql.github.com/codeql-query-help/javascript/js-unsafe-dynamic-method-access/) | 094 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe expansion of self-closing HTML tag](https://codeql.github.com/codeql-query-help/javascript/js-unsafe-html-expansion/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe HTML constructed from library input](https://codeql.github.com/codeql-query-help/javascript/js-html-constructed-from-input/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe jQuery plugin](https://codeql.github.com/codeql-query-help/javascript/js-unsafe-jquery-plugin/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe shell command constructed from library input](https://codeql.github.com/codeql-query-help/javascript/js-shell-command-constructed-from-input/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unvalidated dynamic method call](https://codeql.github.com/codeql-query-help/javascript/js-unvalidated-dynamic-method-call/) | 754 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a broken or weak cryptographic algorithm](https://codeql.github.com/codeql-query-help/javascript/js-weak-cryptographic-algorithm/) | 327, 328 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a weak cryptographic key](https://codeql.github.com/codeql-query-help/javascript/js-insufficient-key-size/) | 326 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of externally-controlled format string](https://codeql.github.com/codeql-query-help/javascript/js-tainted-format-string/) | 134 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of password hash with insufficient computational effort](https://codeql.github.com/codeql-query-help/javascript/js-insufficient-password-hash/) | 916 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Useless regular-expression character escape](https://codeql.github.com/codeql-query-help/javascript/js-useless-regexp-character-escape/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [User-controlled bypass of security check](https://codeql.github.com/codeql-query-help/javascript/js-user-controlled-bypass/) | 807, 290 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [XML external entity expansion](https://codeql.github.com/codeql-query-help/javascript/js-xxe/) | 611, 827 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XML internal entity expansion](https://codeql.github.com/codeql-query-help/javascript/js-xml-bomb/) | 776, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XPath injection](https://codeql.github.com/codeql-query-help/javascript/js-xpath-injection/) | 643 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | + +{% endrowheaders %} diff --git a/data/reusables/code-scanning/codeql-query-tables/python.md b/data/reusables/code-scanning/codeql-query-tables/python.md index e69de29bb2..a0fa0ad049 100644 --- a/data/reusables/code-scanning/codeql-query-tables/python.md +++ b/data/reusables/code-scanning/codeql-query-tables/python.md @@ -0,0 +1,47 @@ +{% rowheaders %} + +| Query name | Related CWEs | Default | Extended | +| --- | --- | --- | --- | +| [Accepting unknown SSH host keys when using Paramiko](https://codeql.github.com/codeql-query-help/python/py-paramiko-missing-host-key-validation/) | 295 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Arbitrary file write during tarfile extraction](https://codeql.github.com/codeql-query-help/python/py-tarslip/) | 022 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Bad HTML filtering regexp](https://codeql.github.com/codeql-query-help/python/py-bad-tag-filter/) | 116, 020, 185, 186 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Binding a socket to all network interfaces](https://codeql.github.com/codeql-query-help/python/py-bind-socket-all-network-interfaces/) | 200 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear-text logging of sensitive information](https://codeql.github.com/codeql-query-help/python/py-clear-text-logging-sensitive-data/) | 312, 359, 532 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear-text storage of sensitive information](https://codeql.github.com/codeql-query-help/python/py-clear-text-storage-sensitive-data/) | 312, 315, 359 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Code injection](https://codeql.github.com/codeql-query-help/python/py-code-injection/) | 094, 095, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [CSRF protection weakened or disabled](https://codeql.github.com/codeql-query-help/python/py-csrf-protection-disabled/) | 352 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Default version of SSL/TLS may be insecure](https://codeql.github.com/codeql-query-help/python/py-insecure-default-protocol/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Deserialization of user-controlled data](https://codeql.github.com/codeql-query-help/python/py-unsafe-deserialization/) | 502 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Flask app is run in debug mode](https://codeql.github.com/codeql-query-help/python/py-flask-debug/) | 215, 489 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Full server-side request forgery](https://codeql.github.com/codeql-query-help/python/py-full-ssrf/) | 918 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded credentials](https://codeql.github.com/codeql-query-help/python/py-hardcoded-credentials/) | 259, 321, 798 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete regular expression for hostnames](https://codeql.github.com/codeql-query-help/python/py-incomplete-hostname-regexp/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete URL substring sanitization](https://codeql.github.com/codeql-query-help/python/py-incomplete-url-substring-sanitization/) | 20 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Inefficient regular expression](https://codeql.github.com/codeql-query-help/python/py-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Information exposure through an exception](https://codeql.github.com/codeql-query-help/python/py-stack-trace-exposure/) | 209, 497 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure temporary file](https://codeql.github.com/codeql-query-help/python/py-insecure-temporary-file/) | 377 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Jinja2 templating with autoescape=False](https://codeql.github.com/codeql-query-help/python/py-jinja2-autoescape-false/) | 079 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [LDAP query built from user-controlled sources](https://codeql.github.com/codeql-query-help/python/py-ldap-injection/) | 090 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Log Injection](https://codeql.github.com/codeql-query-help/python/py-log-injection/) | 117 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Overly permissive file permissions](https://codeql.github.com/codeql-query-help/python/py-overly-permissive-file/) | 732 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Overly permissive regular expression range](https://codeql.github.com/codeql-query-help/python/py-overly-large-range/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [PAM authorization bypass due to incorrect usage](https://codeql.github.com/codeql-query-help/python/py-pam-auth-bypass/) | 285 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Partial server-side request forgery](https://codeql.github.com/codeql-query-help/python/py-partial-ssrf/) | 918 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Polynomial regular expression used on uncontrolled data](https://codeql.github.com/codeql-query-help/python/py-polynomial-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Reflected server-side cross-site scripting](https://codeql.github.com/codeql-query-help/python/py-reflective-xss/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Regular expression injection](https://codeql.github.com/codeql-query-help/python/py-regex-injection/) | 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Request without certificate validation](https://codeql.github.com/codeql-query-help/python/py-request-without-cert-validation/) | 295 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [SQL query built from user-controlled sources](https://codeql.github.com/codeql-query-help/python/py-sql-injection/) | 089 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled command line](https://codeql.github.com/codeql-query-help/python/py-command-line-injection/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/python/py-path-injection/) | 022, 023, 036, 073, 099 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe shell command constructed from library input](https://codeql.github.com/codeql-query-help/python/py-shell-command-constructed-from-input/) | 078, 088, 073 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [URL redirection from remote source](https://codeql.github.com/codeql-query-help/python/py-url-redirection/) | 601 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a broken or weak cryptographic algorithm](https://codeql.github.com/codeql-query-help/python/py-weak-cryptographic-algorithm/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a broken or weak cryptographic hashing algorithm on sensitive data](https://codeql.github.com/codeql-query-help/python/py-weak-sensitive-data-hashing/) | 327, 328, 916 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of insecure SSL/TLS version](https://codeql.github.com/codeql-query-help/python/py-insecure-protocol/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of weak cryptographic key](https://codeql.github.com/codeql-query-help/python/py-weak-crypto-key/) | 326 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XML external entity expansion](https://codeql.github.com/codeql-query-help/python/py-xxe/) | 611, 827 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XML internal entity expansion](https://codeql.github.com/codeql-query-help/python/py-xml-bomb/) | 776, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XPath query built from user-controlled sources](https://codeql.github.com/codeql-query-help/python/py-xpath-injection/) | 643 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | + +{% endrowheaders %} diff --git a/data/reusables/code-scanning/codeql-query-tables/query-suite-behavior.md b/data/reusables/code-scanning/codeql-query-tables/query-suite-behavior.md new file mode 100644 index 0000000000..646d5c64f1 --- /dev/null +++ b/data/reusables/code-scanning/codeql-query-tables/query-suite-behavior.md @@ -0,0 +1 @@ +All queries in the `default` query suite are run by default. If you choose to use the `security-extended` query suite, additional queries are run. For more information, see "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites)." diff --git a/data/reusables/code-scanning/codeql-query-tables/ruby.md b/data/reusables/code-scanning/codeql-query-tables/ruby.md index e69de29bb2..fe60c116c5 100644 --- a/data/reusables/code-scanning/codeql-query-tables/ruby.md +++ b/data/reusables/code-scanning/codeql-query-tables/ruby.md @@ -0,0 +1,47 @@ +{% rowheaders %} + +| Query name | Related CWEs | Default | Extended | +| --- | --- | --- | --- | +| [Bad HTML filtering regexp](https://codeql.github.com/codeql-query-help/ruby/rb-bad-tag-filter/) | 116, 020, 185, 186 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Badly anchored regular expression](https://codeql.github.com/codeql-query-help/ruby/rb-regex-badly-anchored-regexp/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear-text logging of sensitive information](https://codeql.github.com/codeql-query-help/ruby/rb-clear-text-logging-sensitive-data/) | 312, 359, 532 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Clear-text storage of sensitive information](https://codeql.github.com/codeql-query-help/ruby/rb-clear-text-storage-sensitive-data/) | 312, 359, 532 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Code injection](https://codeql.github.com/codeql-query-help/ruby/rb-code-injection/) | 094, 095, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [CSRF protection weakened or disabled](https://codeql.github.com/codeql-query-help/ruby/rb-csrf-protection-disabled/) | 352 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Dependency download using unencrypted communication channel](https://codeql.github.com/codeql-query-help/ruby/rb-insecure-dependency/) | 300, 319, 494, 829 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Deserialization of user-controlled data](https://codeql.github.com/codeql-query-help/ruby/rb-unsafe-deserialization/) | 502 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Download of sensitive file through insecure connection](https://codeql.github.com/codeql-query-help/ruby/rb-insecure-download/) | 829 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded credentials](https://codeql.github.com/codeql-query-help/ruby/rb-hardcoded-credentials/) | 259, 321, 798 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded data interpreted as code](https://codeql.github.com/codeql-query-help/ruby/rb-hardcoded-data-interpreted-as-code/) | 506 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete multi-character sanitization](https://codeql.github.com/codeql-query-help/ruby/rb-incomplete-multi-character-sanitization/) | 020, 080, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete regular expression for hostnames](https://codeql.github.com/codeql-query-help/ruby/rb-incomplete-hostname-regexp/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete string escaping or encoding](https://codeql.github.com/codeql-query-help/ruby/rb-incomplete-sanitization/) | 020, 080, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete URL substring sanitization](https://codeql.github.com/codeql-query-help/ruby/rb-incomplete-url-substring-sanitization/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Inefficient regular expression](https://codeql.github.com/codeql-query-help/ruby/rb-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Information exposure through an exception](https://codeql.github.com/codeql-query-help/ruby/rb-stack-trace-exposure/) | 209, 497 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Log injection](https://codeql.github.com/codeql-query-help/ruby/rb-log-injection/) | 117 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing regular expression anchor](https://codeql.github.com/codeql-query-help/ruby/rb-regex-missing-regexp-anchor/) | 020 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Network data written to file](https://codeql.github.com/codeql-query-help/ruby/rb-http-to-file-access/) | 912, 434 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Overly permissive regular expression range](https://codeql.github.com/codeql-query-help/ruby/rb-overly-large-range/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Polynomial regular expression used on uncontrolled data](https://codeql.github.com/codeql-query-help/ruby/rb-polynomial-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Reflected server-side cross-site scripting](https://codeql.github.com/codeql-query-help/ruby/rb-reflected-xss/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Regular expression injection](https://codeql.github.com/codeql-query-help/ruby/rb-regexp-injection/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Request without certificate validation](https://codeql.github.com/codeql-query-help/ruby/rb-request-without-cert-validation/) | 295 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Sensitive data read from GET request](https://codeql.github.com/codeql-query-help/ruby/rb-sensitive-get-query/) | 598 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Server-side request forgery](https://codeql.github.com/codeql-query-help/ruby/rb-request-forgery/) | 918 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [SQL query built from user-controlled sources](https://codeql.github.com/codeql-query-help/ruby/rb-sql-injection/) | 089 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Stored cross-site scripting](https://codeql.github.com/codeql-query-help/ruby/rb-stored-xss/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled command line](https://codeql.github.com/codeql-query-help/ruby/rb-command-line-injection/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/ruby/rb-path-injection/) | 022, 023, 036, 073, 099 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe code constructed from library input](https://codeql.github.com/codeql-query-help/ruby/rb-unsafe-code-construction/) | 094, 079, 116 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe HTML constructed from library input](https://codeql.github.com/codeql-query-help/ruby/rb-html-constructed-from-input/) | 079, 116 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe shell command constructed from library input](https://codeql.github.com/codeql-query-help/ruby/rb-shell-command-constructed-from-input/) | 078, 088, 073 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [URL redirection from remote source](https://codeql.github.com/codeql-query-help/ruby/rb-url-redirection/) | 601 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of `Kernel.open` or `IO.read` or similar sinks with a non-constant value](https://codeql.github.com/codeql-query-help/ruby/rb-non-constant-kernel-open/) | 078, 088, 073 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of `Kernel.open`, `IO.read` or similar sinks with user-controlled input](https://codeql.github.com/codeql-query-help/ruby/rb-kernel-open/) | 078, 088, 073 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a broken or weak cryptographic algorithm](https://codeql.github.com/codeql-query-help/ruby/rb-weak-cryptographic-algorithm/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of externally-controlled format string](https://codeql.github.com/codeql-query-help/ruby/rb-tainted-format-string/) | 134 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Weak cookie configuration](https://codeql.github.com/codeql-query-help/ruby/rb-weak-cookie-configuration/) | 732, 1275 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [XML external entity expansion](https://codeql.github.com/codeql-query-help/ruby/rb-xxe/) | 611, 776, 827 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | + +{% endrowheaders %} diff --git a/data/reusables/code-scanning/codeql-query-tables/swift.md b/data/reusables/code-scanning/codeql-query-tables/swift.md index e69de29bb2..259ffa24ff 100644 --- a/data/reusables/code-scanning/codeql-query-tables/swift.md +++ b/data/reusables/code-scanning/codeql-query-tables/swift.md @@ -0,0 +1,32 @@ +{% rowheaders %} + +| Query name | Related CWEs | Default | Extended | +| --- | --- | --- | --- | +| [Bad HTML filtering regexp](https://codeql.github.com/codeql-query-help/swift/swift-bad-tag-filter/) | 116, 020, 185, 186 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext logging of sensitive information](https://codeql.github.com/codeql-query-help/swift/swift-cleartext-logging/) | 312, 359, 532 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information in a local database](https://codeql.github.com/codeql-query-help/swift/swift-cleartext-storage-database/) | 312 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext storage of sensitive information in an application preference store](https://codeql.github.com/codeql-query-help/swift/swift-cleartext-storage-preferences/) | 312 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Cleartext transmission of sensitive information](https://codeql.github.com/codeql-query-help/swift/swift-cleartext-transmission/) | 319 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Constant password](https://codeql.github.com/codeql-query-help/swift/swift-constant-password/) | 259 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Database query built from user-controlled sources](https://codeql.github.com/codeql-query-help/swift/swift-sql-injection/) | 089 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Encryption using ECB](https://codeql.github.com/codeql-query-help/swift/swift-ecb-encryption/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Hard-coded encryption key](https://codeql.github.com/codeql-query-help/swift/swift-hardcoded-key/) | 321 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Incomplete regular expression for hostnames](https://codeql.github.com/codeql-query-help/swift/swift-incomplete-hostname-regexp/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Inefficient regular expression](https://codeql.github.com/codeql-query-help/swift/swift-redos/) | 1333, 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insecure TLS configuration](https://codeql.github.com/codeql-query-help/swift/swift-insecure-tls/) | 757 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Insufficient hash iterations](https://codeql.github.com/codeql-query-help/swift/swift-insufficient-hash-iterations/) | 916 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [JavaScript Injection](https://codeql.github.com/codeql-query-help/swift/swift-unsafe-js-eval/) | 094, 095, 749 | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| [Missing regular expression anchor](https://codeql.github.com/codeql-query-help/swift/swift-missing-regexp-anchor/) | 020 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Predicate built from user-controlled sources](https://codeql.github.com/codeql-query-help/swift/swift-predicate-injection/) | 943 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Regular expression injection](https://codeql.github.com/codeql-query-help/swift/swift-regex-injection/) | 730, 400 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Resolving XML external entity in user-controlled data](https://codeql.github.com/codeql-query-help/swift/swift-xxe/) | 611, 776, 827 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Static initialization vector for encryption](https://codeql.github.com/codeql-query-help/swift/swift-static-initialization-vector/) | 329, 1204 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [String length conflation](https://codeql.github.com/codeql-query-help/swift/swift-string-length-conflation/) | 135 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [System command built from user-controlled sources](https://codeql.github.com/codeql-query-help/swift/swift-command-line-injection/) | 078, 088 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/swift/swift-path-injection/) | 022, 023, 036, 073, 099 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Uncontrolled format string](https://codeql.github.com/codeql-query-help/swift/swift-uncontrolled-format-string/) | 134 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Unsafe WebView fetch](https://codeql.github.com/codeql-query-help/swift/swift-unsafe-webview-fetch/) | 079, 095, 749 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of a broken or weak cryptographic hashing algorithm on sensitive data](https://codeql.github.com/codeql-query-help/swift/swift-weak-sensitive-data-hashing/) | 327, 328 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| [Use of constant salts](https://codeql.github.com/codeql-query-help/swift/swift-constant-salt/) | 760 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | + +{% endrowheaders %} diff --git a/data/reusables/dependabot/dependabot-grouped-security-updates-beta-note.md b/data/reusables/dependabot/dependabot-grouped-security-updates-beta-note.md new file mode 100644 index 0000000000..2cfad0395e --- /dev/null +++ b/data/reusables/dependabot/dependabot-grouped-security-updates-beta-note.md @@ -0,0 +1,5 @@ +{% note %} + +**Note:** Grouped pull requests for {% data variables.product.prodname_dependabot_security_updates %} are in beta and subject to change. + +{% endnote %} diff --git a/data/reusables/dependabot/dependabot-security-updates-groups-supported.md b/data/reusables/dependabot/dependabot-security-updates-groups-supported.md new file mode 100644 index 0000000000..45132c5aa5 --- /dev/null +++ b/data/reusables/dependabot/dependabot-security-updates-groups-supported.md @@ -0,0 +1,7 @@ +You can only use the `dependabot.yml` file to create groups for {% data variables.product.prodname_dependabot_version_updates %}. Grouped {% data variables.product.prodname_dependabot_security_updates %} are enabled or disabled in your repository or organization settings and do not support customization. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates)." + +{% note %} + +**Note:** If a grouped pull request for {% data variables.product.prodname_dependabot_version_updates %} contains a vulnerable package, {% data variables.product.prodname_dependabot_security_updates %} will still attempt to create a _separate_ pull request to update the vulnerable package to a secure version. Creating a separate pull request for security updates ensures you have visibility into package vulnerabilities. + +{% endnote %} diff --git a/data/reusables/desktop/desktop-cta-button.md b/data/reusables/desktop/desktop-cta-button.md new file mode 100644 index 0000000000..e9462c5193 --- /dev/null +++ b/data/reusables/desktop/desktop-cta-button.md @@ -0,0 +1 @@ +Download {% data variables.product.prodname_desktop %} {% octicon "link-external" height:16 %} diff --git a/data/reusables/projects/create-project.md b/data/reusables/projects/create-project.md index 97de3caff3..53502504eb 100644 --- a/data/reusables/projects/create-project.md +++ b/data/reusables/projects/create-project.md @@ -4,9 +4,18 @@ ![Screenshot showing profile tabs. The 'Projects' tab is highlighted with an orange outline.](/assets/images/help/projects-v2/tab-projects.png) 1. Click **New project**. +{%- ifversion projects-v2-org-templates-GA-updates %} +1. Select which type of project or template you want to use. + - To create a blank project, under "Start from scratch", click **Table**{% ifversion projects-v2-roadmaps %}, **Roadmap**,{% endif %} or **Board**. + - To create a project from a template, click the template you want to use. You can select from the built-in templates curated by {% data variables.product.company_short %}, the templates created by your organization, and the recommended templates that have been chosen by your organization. +1. Optionally, if you selected a template, review the fields, views, workflows, and insights that will be created. +1. In the text box under "Project name", type a name for your new project. +1. Click **Create project**. +{%- else %} 1. Optionally, in the text box under "Project name", type a name for your new project. ![Screenshot showing the template selection modal. The title field is highlighted with an orange outline.](/assets/images/help/projects-v2/projects-select-template-title.png) -1. Click a {% ifversion projects-v2-org-templates %}built-in template, a template from your organization{% else %}template{% endif %} or, to start with an empty project, click **Table** or **Board**. +1. Click a {% ifversion projects-v2-org-templates %}built-in template, a template from your organization{% else %}template{% endif %} or, to start with an empty project, click **Table**{% ifversion projects-v2-roadmaps %}, **Roadmap**,{% endif %} or **Board**. 1. Click **Create**. +{%- endif %} diff --git a/data/reusables/projects/create-user-project.md b/data/reusables/projects/create-user-project.md index 6ad7a3f1d2..6bf18cb527 100644 --- a/data/reusables/projects/create-user-project.md +++ b/data/reusables/projects/create-user-project.md @@ -4,9 +4,18 @@ ![Screenshot showing profile tabs. The 'Projects' tab is highlighted with an orange outline.](/assets/images/help/projects-v2/tab-projects.png) 1. Click **New project**. +{%- ifversion projects-v2-org-templates-GA-updates %} +1. Select which type of project or template you want to use. + - To create a blank project, under "Start from scratch", click **Table**{% ifversion projects-v2-roadmaps %}, **Roadmap**,{% endif %} or **Board**. + - To create a project from a template, click the built-in template that you want to use. +1. Optionally, if you selected a template, review the fields, views, workflows, and insights that will be created. +1. In the text box under "Project name", type a name for your new project. +1. Click **Create project**. +{%- else %} 1. Optionally, in the text box under "Project name", type a name for your new project. ![Screenshot showing the template selection modal. The title field is highlighted with an orange outline.](/assets/images/help/projects-v2/projects-select-template-title.png) -1. Click a template or, to start with an empty project, click **Table** or **Board**. +1. Click a {% ifversion projects-v2-org-templates %}built-in template, a template from your organization{% else %}template{% endif %} or, to start with an empty project, click **Table**{% ifversion projects-v2-roadmaps %}, **Roadmap**,{% endif %} or **Board**. 1. Click **Create**. +{%- endif %} diff --git a/data/reusables/projects/org-templates-release-stage.md b/data/reusables/projects/org-templates-release-stage.md index de91a586a0..3583a9591c 100644 --- a/data/reusables/projects/org-templates-release-stage.md +++ b/data/reusables/projects/org-templates-release-stage.md @@ -1,5 +1,9 @@ +{% ifversion ghes = 3.10 or ghes = 3.11 %} + {% note %} **Note:** Project templates for organizations is currently in public beta and subject to change. {% endnote %} + +{% endif %} diff --git a/data/reusables/projects/org-templates.md b/data/reusables/projects/org-templates.md index e277b6256f..6b12748362 100644 --- a/data/reusables/projects/org-templates.md +++ b/data/reusables/projects/org-templates.md @@ -1 +1 @@ -You can also set projects in your organization as templates that other organization members can then use as the base for the projects they create. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization)." +You can also set projects in your organization as templates{% ifversion projects-v2-org-templates-GA-updates %}, and curate a list of recommended templates to highlight, {% endif %} that other organization members can then use as the base for the projects they create. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization)." diff --git a/data/reusables/scim/ghec-open-scim-beta-note.md b/data/reusables/scim/ghec-open-scim-beta-note.md index bcdafca53a..66985627be 100644 --- a/data/reusables/scim/ghec-open-scim-beta-note.md +++ b/data/reusables/scim/ghec-open-scim-beta-note.md @@ -2,7 +2,10 @@ {% note %} -**Note**: Support for provisioning users with {% data variables.product.company_short %}'s public SCIM schema is in public beta and subject to change. {% data variables.product.company_short %} recommends that you test provisioning in an environment that's isolated from the production data on your IdP and {% data variables.location.product_location %}. +**Notes**: + +- Support for provisioning users with {% data variables.product.company_short %}'s public SCIM schema is in private beta and subject to change. To request access to the beta, contact your account manager on {% data variables.contact.contact_enterprise_sales %}. +- {% data variables.product.company_short %} recommends that you test provisioning in an environment that's isolated from the production data on your IdP and {% data variables.location.product_location %}. {% endnote %} diff --git a/data/reusables/secret-scanning/secret-scanning-configure-notifications.md b/data/reusables/secret-scanning/secret-scanning-configure-notifications.md index f7de794cda..e6a8110a79 100644 --- a/data/reusables/secret-scanning/secret-scanning-configure-notifications.md +++ b/data/reusables/secret-scanning/secret-scanning-configure-notifications.md @@ -1,7 +1,7 @@ When a new secret is detected, {% data variables.product.product_name %} notifies all users with access to security alerts for the repository according to their notification preferences. These users include: - Repository administrators - Security managers -- Users with with custom roles with read/write access +- Users with custom roles with read/write access - Organization owners and enterprise owners, if they are administrators of repositories where secrets were leaked {% note %} diff --git a/data/secret-scanning.yml b/data/secret-scanning.yml index 7d4fcf19ab..9b63e3b851 100644 --- a/data/secret-scanning.yml +++ b/data/secret-scanning.yml @@ -1849,7 +1849,7 @@ isPublic: false isPrivateWithGhas: true hasPushProtection: false - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' - provider: 'Notion' supportedSecret: 'Notion OAuth Client Secret' @@ -2731,7 +2731,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: false - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' - provider: 'Stripe' supportedSecret: 'Stripe Webhook Signing Secret' diff --git a/data/variables/copilot.yml b/data/variables/copilot.yml index 884945a8ec..7abfa59978 100644 --- a/data/variables/copilot.yml +++ b/data/variables/copilot.yml @@ -8,3 +8,6 @@ cfi_price_per_year: '$100 USD' # Copilot billing: price per month for Copilot for Business cfb_price_per_month: '$19 USD' + +# Copilot Chat in GitHub.com: maximum number of repos that can be indexed for an org +max-chat-indexed-repos: '50' diff --git a/package-lock.json b/package-lock.json index f09606993f..9464034466 100644 --- a/package-lock.json +++ b/package-lock.json @@ -95,13 +95,13 @@ "devDependencies": { "@actions/core": "^1.10.0", "@actions/github": "^6.0.0", - "@axe-core/playwright": "^4.8.1", + "@axe-core/playwright": "^4.8.2", "@github/markdownlint-github": "^0.4.1", "@graphql-inspector/core": "^5.0.0", "@graphql-tools/load": "^8.0.0", "@jest/globals": "29.7.0", "@octokit/rest": "^20.0.2", - "@playwright/test": "1.39.0", + "@playwright/test": "1.40.1", "@types/imurmurhash": "^0.1.4", "@types/js-cookie": "^3.0.6", "@types/lodash": "^4.14.201", @@ -152,6 +152,7 @@ "sass": "^1.52.3", "start-server-and-test": "^2.0.3", "ts-jest": "29.1.1", + "tsx": "4.6.2", "typescript": "^5.2.2", "unist-util-remove": "^4.0.0", "unist-util-visit-parents": "6.0.1", @@ -224,9 +225,9 @@ } }, "node_modules/@axe-core/playwright": { - "version": "4.8.1", - "resolved": "https://registry.npmjs.org/@axe-core/playwright/-/playwright-4.8.1.tgz", - "integrity": "sha512-KC1X++UdRAwMLRvB+BIKFheyLHUnbJTL0t0Wbv6TJMozn2V2QyEtAcN6jyUiudtGiLUGhHCtj/eWorBnVZ4dAA==", + "version": "4.8.2", + "resolved": "https://registry.npmjs.org/@axe-core/playwright/-/playwright-4.8.2.tgz", + "integrity": "sha512-9KOhX2tNuvqn9DzpBNyqoqNKRZBrexeSiN9irQ0sEdq8zH13JnatepCJxobuXn4UopNy6iIpP4342beMiH+MSQ==", "dev": true, "dependencies": { "axe-core": "~4.8.2" @@ -930,6 +931,358 @@ "version": "0.7.5", "license": "MIT" }, + "node_modules/@esbuild/android-arm": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.18.20.tgz", + "integrity": "sha512-fyi7TDI/ijKKNZTUJAQqiG5T7YjJXgnzkURqmGj13C6dCqckZBLdl4h7bkhHt/t0WP+zO9/zwroDvANaOqO5Sw==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.18.20.tgz", + "integrity": "sha512-Nz4rJcchGDtENV0eMKUNa6L12zz2zBDXuhj/Vjh18zGqB44Bi7MBMSXjgunJgjRhCmKOjnPuZp4Mb6OKqtMHLQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.18.20.tgz", + "integrity": "sha512-8GDdlePJA8D6zlZYJV/jnrRAi6rOiNaCC/JclcXpB+KIuvfBN4owLtgzY2bsxnx666XjJx2kDPUmnTtR8qKQUg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.18.20.tgz", + "integrity": "sha512-bxRHW5kHU38zS2lPTPOyuyTm+S+eobPUnTNkdJEfAddYgEcll4xkT8DB9d2008DtTbl7uJag2HuE5NZAZgnNEA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.18.20.tgz", + "integrity": "sha512-pc5gxlMDxzm513qPGbCbDukOdsGtKhfxD1zJKXjCCcU7ju50O7MeAZ8c4krSJcOIJGFR+qx21yMMVYwiQvyTyQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.18.20.tgz", + "integrity": "sha512-yqDQHy4QHevpMAaxhhIwYPMv1NECwOvIpGCZkECn8w2WFHXjEwrBn3CeNIYsibZ/iZEUemj++M26W3cNR5h+Tw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.18.20.tgz", + "integrity": "sha512-tgWRPPuQsd3RmBZwarGVHZQvtzfEBOreNuxEMKFcd5DaDn2PbBxfwLcj4+aenoh7ctXcbXmOQIn8HI6mCSw5MQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.18.20.tgz", + "integrity": "sha512-/5bHkMWnq1EgKr1V+Ybz3s1hWXok7mDFUMQ4cG10AfW3wL02PSZi5kFpYKrptDsgb2WAJIvRcDm+qIvXf/apvg==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.18.20.tgz", + "integrity": "sha512-2YbscF+UL7SQAVIpnWvYwM+3LskyDmPhe31pE7/aoTMFKKzIc9lLbyGUpmmb8a8AixOL61sQ/mFh3jEjHYFvdA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.18.20.tgz", + "integrity": "sha512-P4etWwq6IsReT0E1KHU40bOnzMHoH73aXp96Fs8TIT6z9Hu8G6+0SHSw9i2isWrD2nbx2qo5yUqACgdfVGx7TA==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.18.20.tgz", + "integrity": "sha512-nXW8nqBTrOpDLPgPY9uV+/1DjxoQ7DoB2N8eocyq8I9XuqJ7BiAMDMf9n1xZM9TgW0J8zrquIb/A7s3BJv7rjg==", + "cpu": [ + "loong64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.18.20.tgz", + "integrity": "sha512-d5NeaXZcHp8PzYy5VnXV3VSd2D328Zb+9dEq5HE6bw6+N86JVPExrA6O68OPwobntbNJ0pzCpUFZTo3w0GyetQ==", + "cpu": [ + "mips64el" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.18.20.tgz", + "integrity": "sha512-WHPyeScRNcmANnLQkq6AfyXRFr5D6N2sKgkFo2FqguP44Nw2eyDlbTdZwd9GYk98DZG9QItIiTlFLHJHjxP3FA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.18.20.tgz", + "integrity": "sha512-WSxo6h5ecI5XH34KC7w5veNnKkju3zBRLEQNY7mv5mtBmrP/MjNBCAlsM2u5hDBlS3NGcTQpoBvRzqBcRtpq1A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.18.20.tgz", + "integrity": "sha512-+8231GMs3mAEth6Ja1iK0a1sQ3ohfcpzpRLH8uuc5/KVDFneH6jtAJLFGafpzpMRO6DzJ6AvXKze9LfFMrIHVQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.18.20.tgz", + "integrity": "sha512-UYqiqemphJcNsFEskc73jQ7B9jgwjWrSayxawS6UVFZGWrAAtkzjxSqnoclCXxWtfwLdzU+vTpcNYhpn43uP1w==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.18.20.tgz", + "integrity": "sha512-iO1c++VP6xUBUmltHZoMtCUdPlnPGdBom6IrO4gyKPFFVBKioIImVooR5I83nTew5UOYrk3gIJhbZh8X44y06A==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.18.20.tgz", + "integrity": "sha512-e5e4YSsuQfX4cxcygw/UCPIEP6wbIL+se3sxPdCiMbFLBWu0eiZOJ7WoD+ptCLrmjZBK1Wk7I6D/I3NglUGOxg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.18.20.tgz", + "integrity": "sha512-kDbFRFp0YpTQVVrqUd5FTYmWo45zGaXe0X8E1G/LKFC0v8x0vWrhOWSLITcCn63lmZIxfOMXtCfti/RxN/0wnQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.18.20.tgz", + "integrity": "sha512-ddYFR6ItYgoaq4v4JmQQaAI5s7npztfV4Ag6NrhiaW0RrnOXqBkgwZLofVTlq1daVTQNhtI5oieTvkRPfZrePg==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.18.20.tgz", + "integrity": "sha512-Wv7QBi3ID/rROT08SABTS7eV4hX26sVduqDOTe1MvGMjNd3EjOz4b7zeexIR62GTIEKrfJXKL9LFxTYgkyeu7g==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.18.20.tgz", + "integrity": "sha512-kTdfRcSiDfQca/y9QIkng02avJ+NCaQvrMejlsB3RRv5sE9rRoeBPISaZpKxHELzRxZyLvNts1P27W3wV+8geQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=12" + } + }, "node_modules/@eslint-community/eslint-utils": { "version": "4.4.0", "dev": true, @@ -2256,12 +2609,12 @@ "dev": true }, "node_modules/@playwright/test": { - "version": "1.39.0", - "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.39.0.tgz", - "integrity": "sha512-3u1iFqgzl7zr004bGPYiN/5EZpRUSFddQBra8Rqll5N0/vfpqlP9I9EXqAoGacuAbX6c9Ulg/Cjqglp5VkK6UQ==", + "version": "1.40.1", + "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.40.1.tgz", + "integrity": "sha512-EaaawMTOeEItCRvfmkI9v6rBkF1svM8wjl/YPRrg2N2Wmp+4qJYkWtJsbew1szfKKDm6fPLy4YAanBhIlf9dWw==", "dev": true, "dependencies": { - "playwright": "1.39.0" + "playwright": "1.40.1" }, "bin": { "playwright": "cli.js" @@ -5252,6 +5605,43 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/esbuild": { + "version": "0.18.20", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.18.20.tgz", + "integrity": "sha512-ceqxoedUrcayh7Y7ZX6NdbbDzGROiyVBgC4PriJThBKSVPWnnFHZAkfI1lJT8QFkOwH4qOS2SJkS4wvpGl8BpA==", + "dev": true, + "hasInstallScript": true, + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=12" + }, + "optionalDependencies": { + "@esbuild/android-arm": "0.18.20", + "@esbuild/android-arm64": "0.18.20", + "@esbuild/android-x64": "0.18.20", + "@esbuild/darwin-arm64": "0.18.20", + "@esbuild/darwin-x64": "0.18.20", + "@esbuild/freebsd-arm64": "0.18.20", + "@esbuild/freebsd-x64": "0.18.20", + "@esbuild/linux-arm": "0.18.20", + "@esbuild/linux-arm64": "0.18.20", + "@esbuild/linux-ia32": "0.18.20", + "@esbuild/linux-loong64": "0.18.20", + "@esbuild/linux-mips64el": "0.18.20", + "@esbuild/linux-ppc64": "0.18.20", + "@esbuild/linux-riscv64": "0.18.20", + "@esbuild/linux-s390x": "0.18.20", + "@esbuild/linux-x64": "0.18.20", + "@esbuild/netbsd-x64": "0.18.20", + "@esbuild/openbsd-x64": "0.18.20", + "@esbuild/sunos-x64": "0.18.20", + "@esbuild/win32-arm64": "0.18.20", + "@esbuild/win32-ia32": "0.18.20", + "@esbuild/win32-x64": "0.18.20" + } + }, "node_modules/escalade": { "version": "3.1.1", "license": "MIT", @@ -6764,9 +7154,9 @@ "license": "MIT" }, "node_modules/get-tsconfig": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.7.0.tgz", - "integrity": "sha512-pmjiZ7xtB8URYm74PlGJozDNyhvsVLUcpBa8DZBG3bWHwaHa9bPiRpiSfovw+fjhwONSCWKRyk+JQHEGZmMrzw==", + "version": "4.7.2", + "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.7.2.tgz", + "integrity": "sha512-wuMsz4leaj5hbGgg4IvDU0bqJagpftG5l5cXIAvo8uZrqn0NJqwtfupTN00VnkQJPcIRrxYrm1Ue24btpCha2A==", "dev": true, "dependencies": { "resolve-pkg-maps": "^1.0.0" @@ -12015,12 +12405,12 @@ } }, "node_modules/playwright": { - "version": "1.39.0", - "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.39.0.tgz", - "integrity": "sha512-naE5QT11uC/Oiq0BwZ50gDmy8c8WLPRTEWuSSFVG2egBka/1qMoSqYQcROMT9zLwJ86oPofcTH2jBY/5wWOgIw==", + "version": "1.40.1", + "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.40.1.tgz", + "integrity": "sha512-2eHI7IioIpQ0bS1Ovg/HszsN/XKNwEG1kbzSDDmADpclKc7CyqkHw7Mg2JCz/bbCxg25QUPcjksoMW7JcIFQmw==", "dev": true, "dependencies": { - "playwright-core": "1.39.0" + "playwright-core": "1.40.1" }, "bin": { "playwright": "cli.js" @@ -12033,9 +12423,9 @@ } }, "node_modules/playwright-core": { - "version": "1.39.0", - "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.39.0.tgz", - "integrity": "sha512-+k4pdZgs1qiM+OUkSjx96YiKsXsmb59evFoqv8SKO067qBA+Z2s/dCzJij/ZhdQcs2zlTAgRKfeiiLm8PQ2qvw==", + "version": "1.40.1", + "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.40.1.tgz", + "integrity": "sha512-+hkOycxPiV534c4HhpfX6yrlawqVUzITRKwHAmYfmsVreltEl6fAZJ3DPfLMOODw0H3s1Itd6MDCWmP1fl/QvQ==", "dev": true, "bin": { "playwright-core": "cli.js" @@ -14913,6 +15303,39 @@ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.5.3.tgz", "integrity": "sha512-mSxlJJwl3BMEQCUNnxXBU9jP4JBktcEGhURcPR6VQVlnP0FdDEsIaz0C35dXNGLyRfrATNofF0F5p2KPxQgB+w==" }, + "node_modules/tsx": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/tsx/-/tsx-4.6.2.tgz", + "integrity": "sha512-QPpBdJo+ZDtqZgAnq86iY/PD2KYCUPSUGIunHdGwyII99GKH+f3z3FZ8XNFLSGQIA4I365ui8wnQpl8OKLqcsg==", + "dev": true, + "dependencies": { + "esbuild": "~0.18.20", + "get-tsconfig": "^4.7.2" + }, + "bin": { + "tsx": "dist/cli.mjs" + }, + "engines": { + "node": ">=18.0.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + } + }, + "node_modules/tsx/node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, "node_modules/tunnel": { "version": "0.0.6", "dev": true, diff --git a/package.json b/package.json index 09b591afe8..df86c7f317 100644 --- a/package.json +++ b/package.json @@ -16,28 +16,41 @@ }, "exports": "./src/frame/server.js", "scripts": { + "analyze-text": "node src/search/scripts/analyze-text.js", + "archive-version": "node src/ghes-releases/scripts/archive-version.js", "build": "next build", + "check-github-github-links": "node src/links/scripts/check-github-github-links.js", + "copy-fixture-data": "node src/tests/scripts/copy-fixture-data.js", + "create-translation-health-report": "node src/languages/scripts/create-translation-health-report.js", "debug": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon --inspect src/frame/server.js", + "delete-orphan-translation-files": "tsx src/workflows/delete-orphan-translation-files.ts", "dev": "cross-env npm start", + "find-orphaned-assets": "node src/assets/scripts/find-orphaned-assets.js", "fixture-dev": "cross-env ROOT=src/fixtures/fixtures npm start", "fixture-test": "cross-env ROOT=src/fixtures/fixtures npm test -- src/fixtures/tests", "index-test-fixtures": "node src/search/scripts/index-elasticsearch.js -l en -l ja -V ghae -V dotcom --index-prefix tests -- src/search/tests/fixtures/search-indexes", "lint": "eslint '**/*.{js,mjs,ts,tsx}'", "lint-content": "node src/content-linter/scripts/lint-content.js", "lint-translation": "cross-env NODE_OPTIONS=--experimental-vm-modules jest src/content-linter/tests/lint-files.js", + "generate-code-scanning-query-list": "tsx src/code-scanning/scripts/generate-code-scanning-query-list.ts", "move-content": "node src/content-render/scripts/move-content.js", "openapi-docs": "node src/rest/docs.js", "playwright-test": "playwright test --config src/fixtures/playwright.config.ts --project=\"Google Chrome\"", + "post-lints": "node src/content-linter/scripts/post-lints.js", "postinstall": "cp package-lock.json .installed.package-lock.json && echo \"Updated .installed.package-lock.json\" # see husky/post-checkout and husky/post-merge", "prepare": "husky install src/workflows/husky", "prettier": "prettier -w \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"", "prettier-check": "prettier -c \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"", "prevent-pushes-to-main": "node src/workflows/prevent-pushes-to-main.js", + "release-banner": "node src/ghes-releases/scripts/release-banner.js", + "remove-version-markup": "node src/ghes-releases/scripts/remove-version-markup.js", + "rendered-content-link-checker-cli": "node src/links/scripts/rendered-content-link-checker-cli.js", "rest-dev": "node src/rest/scripts/update-files.js", "show-action-deps": "echo 'Action Dependencies:' && rg '^[\\s|-]*(uses:.*)$' .github -I -N --no-heading -r '$1$2' | sort | uniq | cut -c 7-", "start": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon src/frame/server.js", "start-all-languages": "cross-env NODE_ENV=development nodemon src/frame/server.js", "start-for-playwright": "cross-env ROOT=src/fixtures/fixtures TRANSLATIONS_FIXTURE_ROOT=src/fixtures/fixtures/translations ENABLED_LANGUAGES=en,ja NODE_ENV=test node src/frame/server.js", + "symlink-from-local-repo": "node src/early-access/scripts/symlink-from-local-repo.js", "sync-rest": "node src/rest/scripts/update-files.js", "sync-search": "cross-env NODE_OPTIONS='--max_old_space_size=8192' start-server-and-test sync-search-server 4002 sync-search-indices", "sync-search-ghes-release": "cross-env GHES_RELEASE=1 start-server-and-test sync-search-server 4002 sync-search-indices", @@ -45,8 +58,15 @@ "sync-search-server": "cross-env NODE_ENV=production PORT=4002 MINIMAL_RENDER=true CHANGELOG_DISABLED=true node src/frame/server.js", "sync-webhooks": "src/rest/scripts/update-files.js -o webhooks", "test": "cross-env NODE_OPTIONS='--max_old_space_size=4096 --experimental-vm-modules' jest --logHeapUsage", + "test-local-dev": "node src/workflows/test-local-dev.js", + "test-moved-content": "tsx src/content-render/scripts/test-moved-content.ts", "test-watch": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --watch --notify --notifyMode=change --coverage", - "tsc": "tsc --noEmit" + "toggle-ghae-feature-flags": "node src/versions/scripts/toggle-ghae-feature-flags.js", + "tsc": "tsc --noEmit", + "update-data-and-image-paths": "node src/early-access/scripts/update-data-and-image-paths.js", + "update-internal-links": "node src/links/scripts/update-internal-links.js", + "validate-asset-images": "node src/assets/scripts/validate-asset-images.js", + "warmup-remotejson": "node src/archives/scripts/warmup-remotejson.js" }, "lint-staged": { "*.{js,mjs,ts,tsx}": "eslint --cache --fix", @@ -171,6 +191,7 @@ ] }, "jest": { + "testTimeout": 30000, "coverageThreshold": { "global": { "branches": 95, @@ -292,13 +313,13 @@ "devDependencies": { "@actions/core": "^1.10.0", "@actions/github": "^6.0.0", - "@axe-core/playwright": "^4.8.1", + "@axe-core/playwright": "^4.8.2", "@github/markdownlint-github": "^0.4.1", "@graphql-inspector/core": "^5.0.0", "@graphql-tools/load": "^8.0.0", "@jest/globals": "29.7.0", "@octokit/rest": "^20.0.2", - "@playwright/test": "1.39.0", + "@playwright/test": "1.40.1", "@types/imurmurhash": "^0.1.4", "@types/js-cookie": "^3.0.6", "@types/lodash": "^4.14.201", @@ -349,6 +370,7 @@ "sass": "^1.52.3", "start-server-and-test": "^2.0.3", "ts-jest": "29.1.1", + "tsx": "4.6.2", "typescript": "^5.2.2", "unist-util-remove": "^4.0.0", "unist-util-visit-parents": "6.0.1", diff --git a/src/audit-logs/data/ghec/enterprise.json b/src/audit-logs/data/ghec/enterprise.json index 0c93324edf..c73ae6ccb2 100644 --- a/src/audit-logs/data/ghec/enterprise.json +++ b/src/audit-logs/data/ghec/enterprise.json @@ -109,11 +109,6 @@ "description": "A billing manager was added to an enterprise.", "docs_reference_links": "N/A" }, - { - "action": "business.add_billing_viewer", - "description": "N/A", - "docs_reference_links": "N/A" - }, { "action": "business.add_organization", "description": "An organization was added to an enterprise.", @@ -164,11 +159,6 @@ "description": "An invitation for someone to be an billing manager of an enterprise was canceled.", "docs_reference_links": "N/A" }, - { - "action": "business.cancel_billing_viewer_invitation", - "description": "N/A", - "docs_reference_links": "N/A" - }, { "action": "business.cancel_trial", "description": "The trial of GitHub Enterprise Cloud was cancelled.", @@ -304,11 +294,6 @@ "description": "An invitation for someone to be an billing manager of an enterprise was sent.", "docs_reference_links": "N/A" }, - { - "action": "business.invite_billing_viewer", - "description": "N/A", - "docs_reference_links": "N/A" - }, { "action": "business.members_can_update_protected_branches.clear", "description": "An enterprise owner unset a policy for whether members of an enterprise can update protected branches on repositories for individual organizations. Organization owners can choose whether to allow updating protected branches settings.", @@ -364,11 +349,6 @@ "description": "A billing manager was removed from an enterprise.", "docs_reference_links": "N/A" }, - { - "action": "business.remove_billing_viewer", - "description": "N/A", - "docs_reference_links": "N/A" - }, { "action": "business.remove_member", "description": "A member was removed from an enterprise.", diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 9c8b9b597c..8bad4abcc9 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -1,4 +1,4 @@ { "apiOnlyEventsAdditionalDescription": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "sha": "68fdc3e1d8457be8528802ace4eb3f87def140fe" + "sha": "913efe44fbf62baf32088f71698cc1d7efeffdef" } \ No newline at end of file diff --git a/src/code-scanning/generate-code-scanning-query-list.py b/src/code-scanning/generate-code-scanning-query-list.py deleted file mode 100644 index 3b0db1fa14..0000000000 --- a/src/code-scanning/generate-code-scanning-query-list.py +++ /dev/null @@ -1,244 +0,0 @@ -import subprocess -import json -import shutil -import sys -import os -import argparse - -""" -This script collects CodeQL queries that are part of code scanning query packs -and prints a markdown table to stdout that describes which packs contain which queries. - -Errors are printed to stderr. This script requires that 'git' and 'codeql' commands -are on the PATH. It'll try to automatically set the CodeQL search path correctly, -as long as you run the script from one of the following locations: - - anywhere from within a clone of the CodeQL Git repo - - from the parent directory of a clone of the CodeQL Git repo (assuming 'codeql' - directory exists) -""" - -parser = argparse.ArgumentParser(__name__) -parser.add_argument( - "--ignore-missing-query-packs", - action="store_true", - help="Don't fail if a query pack can't be found", -) -parser.add_argument( - "language", - help="The language to generate the query list for", -) -arguments = parser.parse_args() -assert hasattr(arguments, "ignore_missing_query_packs") -assert hasattr(arguments, "language") - -# Define which languages and query packs to consider -language = arguments.language - -packs = [ "code-scanning", "security-extended" ] - -class CodeQL: - def __init__(self): - pass - - def __enter__(self): - self.proc = subprocess.Popen(['codeql', 'execute','cli-server'], - executable=shutil.which('codeql'), - stdin=subprocess.PIPE, - stdout=subprocess.PIPE, - stderr=sys.stderr, - env=os.environ.copy(), - ) - return self - def __exit__(self, type, value, tb): - self.proc.stdin.write(b'["shutdown"]\0') - self.proc.stdin.close() - try: - self.proc.wait(5) - except: - self.proc.kill() - - def command(self, args): - data = json.dumps(args) - data_bytes = data.encode('utf-8') - self.proc.stdin.write(data_bytes) - self.proc.stdin.write(b'\0') - self.proc.stdin.flush() - res = b'' - while True: - b = self.proc.stdout.read(1) - if b == b'\0': - return res.decode('utf-8') - res += b - -def get_docs_link(language, query_id): - """ - Gets the documentation link for a query, given the query ID. - The documentation link contains the query language, followed by the ID, with slashes - replaced by dashes. - - For example: - cpp/external-entity-expansion - becomes: - https://codeql.github.com/codeql-query-help/cpp/cpp-external-entity-expansion/ - """ - return "https://codeql.github.com/codeql-query-help/%s/%s/" % (language, query_id.replace("/","-")) - -def single_spaces(input): - """ - Workaround for https://github.com/github/codeql-coreql-team/issues/470 which causes - some metadata strings to contain newlines and spaces without a good reason. - """ - return " ".join(input.split()) - - -def get_query_metadata(key, metadata, queryfile): - """Returns query metadata or prints a warning to stderr if a particular piece of metadata is not available.""" - if key in metadata: return single_spaces(metadata[key]) - query_id = metadata['id'] if 'id' in metadata else 'unknown' - return "" - -def get_query_cwes(tags): - """ - Returns a list of CWEs that are associated with a query, given its tags. - For example, if the list of tags is: - maintainability readability external/cwe/cwe-1078 external/cwe/cwe-670 security - - We return: - ["1078", "670"] - """ - cwes = [] - tags = tags.split() - for tag in tags: - if tag.startswith("external/cwe/cwe-"): - cwe = tag.split("-")[-1] - cwes.append(cwe) - return cwes - - -def subprocess_run(cmd): - """Runs a command through subprocess.run, with a few tweaks. Raises an Exception if exit code != 0.""" - return subprocess.run(cmd, capture_output=True, text=True, env=os.environ.copy(), check=True) - - - -try: # Check for `git` on path - subprocess_run(["git","--version"]) -except Exception as e: - print("Error: couldn't invoke 'git'. Is it on the path? Aborting.", file=sys.stderr) - raise e - -with CodeQL() as codeql: - try: # Check for `codeql` on path - codeql.command(["--version"]) - except Exception as e: - print("Error: couldn't invoke CodeQL CLI 'codeql'. Is it on the path? Aborting.", file=sys.stderr) - raise e - - # Define CodeQL search path so it'll find the CodeQL repositories: - # - anywhere in the current Git clone (including current working directory) - # - the 'codeql' subdirectory of the cwd - codeql_search_path = "./codeql:." # will be extended further down - - # Extend CodeQL search path by detecting root of the current Git repo (if any). This means that you - # can run this script from any location within the CodeQL git repository. - try: - git_toplevel_dir = subprocess_run(["git","rev-parse","--show-toplevel"]) - - # Current working directory is in a Git repo. Add it to the search path, just in case it's the CodeQL repo - git_toplevel_dir = git_toplevel_dir.stdout.strip() - codeql_search_path += ":" + git_toplevel_dir - except: - # git rev-parse --show-toplevel exited with non-zero exit code. We're not in a Git repo - pass - - # Write a markdown table to stdout - table_data = [] - - # Define the header row - table_data.append(["Query name", "Related CWEs", "Default", "Extended"]) - - # Iterate over all packs, and resolve which queries are part of those packs - queries_dict = {} - - for pack in packs: - # Get absolute paths to queries in this pack by using 'codeql resolve queries' - try: - queries_subp = codeql.command(["resolve","queries","--search-path", codeql_search_path, "%s-%s.qls" % (language, pack)]) - except Exception as e: - # Resolving queries might go wrong if the github/codeql repository is not - # on the search path. - level = "Warning" if arguments.ignore_missing_query_packs else "Error" - print( - "%s: couldn't find query pack '%s' for language '%s'. Do you have the right repositories in the right places (search path: '%s')?" % (level, pack, language, codeql_search_path), - file=sys.stderr - ) - if arguments.ignore_missing_query_packs: - continue - else: - sys.exit("You can use '--ignore-missing-query-packs' to ignore this error") - - # Investigate metadata for every query by using 'codeql resolve metadata' - for queryfile in queries_subp.strip().split("\n"): - query_metadata_json = codeql.command(["resolve","metadata",queryfile]).strip() - - # Turn an absolute path to a query file into an nwo-prefixed path (e.g. github/codeql/java/ql/src/....) - - meta = json.loads(query_metadata_json) - - # Format a markdown link from the query name and the docs link - query_id = get_query_metadata('id', meta, queryfile) - query_docs_link = get_docs_link(language, query_id) - - query_name = get_query_metadata('name', meta, queryfile) - query_name = query_name.replace('"', '"') # Replace quotation marks with HTML entities - query_markdown_link = "[%s](%s)" % (query_name, query_docs_link) - - # Get query CWEs - query_tags = get_query_metadata('tags', meta, queryfile) - query_cwes = get_query_cwes(query_tags) - - # Only include queries that have CWEs, since the other queries deal with code scanning - # metadata and metrics (e.g. counting lines of code or number of files) and have no docs link - if query_cwes: - if query_id not in queries_dict: - queries_dict[query_id] = { - 'query_markdown_link': query_markdown_link, - 'packs': [pack], - 'cwes': query_cwes - } - else: - queries_dict[query_id]['packs'].append(pack) - - # Sort the queries alphabetically - sorted_queries = sorted(queries_dict.items(), key=lambda item: item[1]['query_markdown_link']) - - # Write the sorted rows to the markdown table - for query_id, query_dict in sorted_queries: - default = '{% octicon "x" aria-label="Not included" %}' - extended = '{% octicon "x" aria-label="Not included" %}' - if "code-scanning" in query_dict['packs']: - default = '{% octicon "check" aria-label="Included" %}' - if "security-extended" in query_dict['packs']: - extended = '{% octicon "check" aria-label="Included" %}' - - table_data.append([ - query_dict['query_markdown_link'], - ', '.join(query_dict['cwes']), - default, - extended - ]) - - # Write "row headers" to make rows accessible - print("{% rowheaders %}") - - # Write 'table_data' as markdown - md_table = '\n| ' + ' | '.join(table_data[0]) + ' |\n' - md_table += '| ' + ' | '.join(['---'] * len(table_data[0])) + ' |\n' - - for row in table_data[1:]: - md_table += '| ' + ' | '.join(row) + ' |\n' - md_table = md_table.rstrip() - print(md_table) - - # Write end of "row headers" - print("\n{% endrowheaders %}") diff --git a/src/code-scanning/scripts/generate-code-scanning-query-list.ts b/src/code-scanning/scripts/generate-code-scanning-query-list.ts new file mode 100644 index 0000000000..d0c4041e04 --- /dev/null +++ b/src/code-scanning/scripts/generate-code-scanning-query-list.ts @@ -0,0 +1,239 @@ +#!/usr/bin/env node + +/** + * This script generates a block of Markdown that can be saved as a reusable. + * The reusable lists all the queries for one programming language, with CWEs, as a Markdown table. + * + * To be able to execute this script, you need to have the CodeQL CLI installed. + * To do that, you need two things: + * + * 1. The directory where the github/codeql repo is clone + * 2. The path to the executable `codeql` file. + * + * The directory where the github/codeql repo is cloned is needed because + * that's how it looks up files. You can set it up like this: + * + * cd /tmp + * git clone git@github.com:github/codeql.git + * cd codeql + * pwd + * + * To install the codeql executable, use `gh` like this: + * + * gh extension install github/gh-codeql + * gh codeql set-channel nightly + * gh codeql version + * + * Note that when you run the `gh codeql version` command, it will tell you + * where the executable is installed. For example: + * + * /Users/peterbe/.local/share/gh/extensions/gh-codeql/dist/nightly/codeql-bundle-20231204/codeql + * + * If you've git cloned github/codeql in /tmp/ now you can execute this script. + * For example, to generate the Markdown + * for Python: + * + * npm run generate-code-scanning-query-list -- \ + * --codeql-path ~/.local/share/gh/extensions/gh-codeql/dist/nightly/codeql-bundle-20231204/codeql \ + * --codeql-dir /tmp/codeql python | tee /tmp/python.md + * less /tmp/python.md + */ + +import fs from 'fs' +import { execFileSync } from 'child_process' + +import chalk from 'chalk' +import { program } from 'commander' + +program + .description('Generate a reusable Markdown for for a code scanning query language') + .option('--verbose', 'Verbose outputs') + .option('--codeql-path ', 'path to the codeql executable', 'codeql') + .option('--codeql-dir ', 'path to the codeql executable', '.codeql/') + .option('-o, --output-file ', 'path to the codeql executable', 'stdout') + .option('-p, --pack ', 'which packs to search for', ['code-scanning', 'security-extended']) + .argument('', 'for example java') + .parse(process.argv) + +type Options = { + codeqlPath: string + codeqlDir: string + outputFile: string + packs: string[] + verbose: boolean +} + +type QueryMetadata = { + id?: string + name?: string + tags?: string +} + +type Query = { + name: string + url: string + packs: string[] + cwes: string[] +} + +const opts = program.opts() +main( + { + codeqlPath: opts.codeqlPath, + codeqlDir: opts.codeqlDir, + outputFile: opts.outputFile, + packs: opts.pack, + verbose: Boolean(opts.verbose), + }, + program.args[0], +) + +async function main(options: Options, language: string) { + if (!options.packs.length) { + throw new Error("no packs specified, use '--pack code-scanning' or '--pack security-extended'") + } + + if (options.verbose && options.outputFile === 'stdout') { + console.warn(chalk.yellow('Verbose mode is on but output is going to stdout')) + } + + if (!testCodeQLPath(options)) { + process.exit(1) + } + + const queries: { + [id: string]: Query + } = {} + + for (const pack of options.packs) { + const languagePack = `${language}-${pack}.qls` + if (options.verbose) console.log(chalk.dim(`Searching for queries in ${languagePack}`)) + const res = execFileSync( + options.codeqlPath, + ['resolve', 'queries', `--search-path=${options.codeqlDir}`, languagePack], + { + encoding: 'utf-8', + }, + ) + for (const line of res.split('\n')) { + if (line.trim()) { + if (options.verbose) console.log('found', line) + const metadata = getMetadata(options, line) + const { id, name, tags } = metadata + if (id && name) { + const cwes = getCWEs(tags || '') + const url = getDocsLink(language, id) + + // Only include queries that have CWEs, since the other queries deal with code scanning + // metadata and metrics (e.g. counting lines of code or number of files) and have no docs link + if (cwes.length) { + if (!(id in queries)) { + queries[id] = { url, name, packs: [], cwes } + } + queries[id].packs.push(pack) + } else { + if (options.verbose) { + console.log(chalk.dim(`Skipping ${id} because it has no CWEs`)) + } + } + } + } + } + } + + const entries = Object.values(queries) + entries.sort((a, b) => a.name.localeCompare(b.name)) + printQueries(options, entries) +} + +function printQueries(options: Options, queries: Query[]) { + const markdown = [] + markdown.push('{% rowheaders %}') + markdown.push('') // blank line + const header = ['Query name', 'Related CWEs', 'Default', 'Extended'] + markdown.push(`| ${header.join(' | ')} |`) + markdown.push(`| ${header.map(() => '---').join(' | ')} |`) + + const notIncludedOcticon = '{% octicon "x" aria-label="Not included" %}' + const includedOcticon = '{% octicon "check" aria-label="Included" %}' + + for (const query of queries) { + const markdownLink = `[${query.name}](${query.url})` + let defaultIcon = notIncludedOcticon + let extendedIcon = notIncludedOcticon + if (query.packs.includes('code-scanning')) { + defaultIcon = includedOcticon + } + if (query.packs.includes('security-extended')) { + extendedIcon = includedOcticon + } + markdown.push( + `| ${markdownLink} | ${query.cwes.join(', ')} | ${defaultIcon} | ${extendedIcon} |`, + ) + } + markdown.push('') // blank line + markdown.push('{% endrowheaders %}') + markdown.push('') // always end with a blank line + + if (options.outputFile === 'stdout') { + console.log(markdown.join('\n')) + } else { + fs.writeFileSync(options.outputFile, markdown.join('\n'), 'utf-8') + } +} + +function getMetadata(options: Options, queryFile: string): QueryMetadata { + const metadataJson = execFileSync(options.codeqlPath, ['resolve', 'metadata', queryFile], { + encoding: 'utf-8', + }) + const parsed = JSON.parse(metadataJson) + return parsed +} + +/** + * + * @param language 'cpp' + * @param queryId 'external-entity-expansion' + * @returns https://codeql.github.com/codeql-query-help/cpp/cpp-external-entity-expansion/ + */ +function getDocsLink(language: string, queryId: string) { + return `https://codeql.github.com/codeql-query-help/${language}/${queryId.replaceAll('/', '-')}/` +} + +/** + * + * @param tags 'maintainability readability external/cwe/cwe-1078 external/cwe/cwe-670 security' + * @returns ['1078', '670'] + */ +function getCWEs(tags: string) { + const cwes: string[] = [] + for (const tag of tags.split(/\s+/g)) { + if (tag.startsWith('external/cwe/cwe-')) { + const cwe = tag.split('-').pop() || '' + if (cwe) cwes.push(cwe) + } + } + return cwes +} + +function testCodeQLPath(options: Options) { + try { + const output = execFileSync(options.codeqlPath, ['--version'], { encoding: 'utf-8' }) + if (options.verbose) { + const matched = output.match(/CodeQL command-line toolchain release ([\d.+]+)/) + if (matched) { + console.log('codeql version', chalk.green(matched[0])) + return true + } + } + return true + } catch (error) { + console.error('Could not find codeql executable at', options.codeqlPath) + if (options.verbose) { + throw error + } else { + console.log(chalk.yellow(`${options.codeqlPath} --version`), 'failed') + return false + } + } +} diff --git a/src/content-render/scripts/test-moved-content.js b/src/content-render/scripts/test-moved-content.ts similarity index 66% rename from src/content-render/scripts/test-moved-content.js rename to src/content-render/scripts/test-moved-content.ts index de69712de1..e823001439 100644 --- a/src/content-render/scripts/test-moved-content.js +++ b/src/content-render/scripts/test-moved-content.ts @@ -4,56 +4,58 @@ import path from 'path' import { program } from 'commander' -import readFrontmatter from '#src/frame/lib/read-frontmatter.js' +import readFrontmatter from 'src/frame/lib/read-frontmatter.js' const ROOT = process.env.ROOT || '.' const CONTENT_ROOT = path.resolve(path.join(ROOT, 'content')) program .description('Test that a file correctly got moved') - .arguments('old', 'old file or folder name') - .arguments('new', 'new file or folder name') + .arguments('old') + .arguments('new') .parse(process.argv) -main(program.args) +main([program.args[0], program.args[1]]) -async function main(nameTuple) { +async function main(nameTuple: [string, string]) { const [before, after] = nameTuple assert(!fs.existsSync(before), `File or folder ${before} exists`) assert(fs.existsSync(after), `File or folder ${after} exists`) if (after.endsWith('.md')) { const fileContent = fs.readFileSync(after, 'utf-8') - const { data } = readFrontmatter(fileContent) + const fm = readFrontmatter(fileContent) + const { data } = fm const oldHref = makeHref(CONTENT_ROOT, before) - assert(data.redirect_from.includes(oldHref), `Redirect from ${oldHref} not found`) + if (data) assert(data.redirect_from.includes(oldHref), `Redirect from ${oldHref} not found`) { const parentIndexMd = path.join(path.dirname(after), 'index.md') const fileContent = fs.readFileSync(parentIndexMd, 'utf-8') const { data } = readFrontmatter(fileContent) const afterShortname = '/' + after.split('/').slice(-1)[0].replace(/\.md$/, '') - assert(data.children.includes(afterShortname), `Child ${afterShortname} not found`) + if (data) assert(data.children.includes(afterShortname), `Child ${afterShortname} not found`) } } else { const fileContent = fs.readFileSync(path.join(after, 'index.md'), 'utf-8') const { data } = readFrontmatter(fileContent) const oldHref = makeHref(CONTENT_ROOT, before) - assert(data.redirect_from.includes(oldHref), `Redirect from ${oldHref} not found`) + if (data) assert(data.redirect_from.includes(oldHref), `Redirect from ${oldHref} not found`) { const parentIndexMd = path.join(path.dirname(after), 'index.md') const fileContent = fs.readFileSync(parentIndexMd, 'utf-8') const { data } = readFrontmatter(fileContent) const afterShortname = '/' + after.split('/').slice(-1) - assert(data.children.includes(afterShortname), `Child ${afterShortname} not found`) + if (data) assert(data.children.includes(afterShortname), `Child ${afterShortname} not found`) } } } -function makeHref(root, filePath) { +function makeHref(root: string, filePath: string) { const nameSplit = path.relative(root, filePath).split(path.sep) if (nameSplit.slice(-1)[0] === 'index.md') { nameSplit.pop() } else { - nameSplit.push(nameSplit.pop().replace(/\.md$/, '')) + const last = nameSplit.pop() + if (last) nameSplit.push(last.replace(/\.md$/, '')) } return '/' + nameSplit.join('/') } diff --git a/src/content-render/stylesheets/images.scss b/src/content-render/stylesheets/images.scss index 59fb8261be..352b83908e 100644 --- a/src/content-render/stylesheets/images.scss +++ b/src/content-render/stylesheets/images.scss @@ -1,7 +1,7 @@ .markdown-body .procedural-image-wrapper { display: block; padding: 1rem 0; - margin: 1rem auto 0 auto; + margin: 1rem 0; border: none; max-width: calc(100% - 2rem); diff --git a/src/data-directory/lib/get-data.js b/src/data-directory/lib/get-data.js index f595765260..b0650cd48e 100644 --- a/src/data-directory/lib/get-data.js +++ b/src/data-directory/lib/get-data.js @@ -205,7 +205,7 @@ function getDataByDir(dottedPath, dir, englishRoot) { throw error } } - content = correctTranslatedContentStrings(content, englishContent) + content = correctTranslatedContentStrings(content, englishContent, { dottedPath }) } return content } diff --git a/src/early-access/scripts/clone-locally b/src/early-access/scripts/clone-locally index 93443c3575..ac6d135c15 100755 --- a/src/early-access/scripts/clone-locally +++ b/src/early-access/scripts/clone-locally @@ -24,6 +24,6 @@ git clone https://github.com/github/docs-early-access.git popd > /dev/null # Symlink the local docs-early-access repo into this repo -node src/early-access/scripts/symlink-from-local-repo.js -p ../docs-early-access +npm run symlink-from-local-repo -- -p ../docs-early-access echo -e '\nDone!' diff --git a/src/events/components/events.ts b/src/events/components/events.ts index 5e120eab78..78c872b14b 100644 --- a/src/events/components/events.ts +++ b/src/events/components/events.ts @@ -296,45 +296,51 @@ function initPageAndExitEvent() { }) // Client-side routing - Router.events.on('routeChangeStart', (url) => { + Router.events.on('routeChangeStart', async (url) => { // Don't trigger page events on query string or hash changes previousPath = location.pathname // pathname set to "prior" url, arg "upcoming" url const newPath = url?.toString().split('?')[0].split('#')[0] const shouldSendEvents = newPath !== previousPath if (shouldSendEvents) { sendExit() - } - }) - - Router.events.on('routeChangeComplete', (url) => { - // Don't trigger page events on query string or hash changes - // Don't set `previousPath` here as location.pathname is now updated - const newPath = url?.toString().split('?')[0].split('#')[0] - const shouldSendEvents = newPath !== previousPath - if (shouldSendEvents) { + await waitForPageReady() resetPageParams() - waitForDomMutateStop(sendPage) + sendPage() } }) } -// The DOM still mutates after `routeChangeComplete` -// so we need to wait for it to stop mutating to get accurate data -function waitForDomMutateStop(fn: Function, minMs = 35, pollMs = 5) { - let lastMutate = Date.now() - const observer = new MutationObserver(() => { - lastMutate = Date.now() - }) - observer.observe(document.documentElement, { subtree: true, childList: true }) - function poll() { - if (Date.now() - lastMutate > minMs) { - observer.disconnect() - fn() - } else { - setTimeout(poll, pollMs) +// We want to wait for the DOM to mutate the tags +// as well as finish routeChangeComplete (location.pathname) +// before sending the page event in order to get accurate data +async function waitForPageReady() { + const route = new Promise((resolve) => { + const handler = () => { + Router.events.off('routeChangeComplete', handler) + setTimeout(() => resolve(true)) } - } - poll() + Router.events.on('routeChangeComplete', handler) + }) + const mutate = new Promise((resolve) => { + const observer = new MutationObserver((mutations) => { + const metaMutated = mutations.find( + (mutation) => + mutation.target?.nodeName === 'META' || + Array.from(mutation.addedNodes).find((node) => node.nodeName === 'META') || + Array.from(mutation.removedNodes).find((node) => node.nodeName === 'META'), + ) + if (metaMutated) { + observer.disconnect() + setTimeout(() => resolve(true)) + } + }) + observer.observe(document.getElementsByTagName('head')[0], { + subtree: true, + childList: true, + attributes: true, + }) + }) + return Promise.all([route, mutate]) } function initClipboardEvent() { diff --git a/src/fixtures/fixtures/content/code-security/index.md b/src/fixtures/fixtures/content/code-security/index.md index 527bd6053b..c5d77b375c 100644 --- a/src/fixtures/fixtures/content/code-security/index.md +++ b/src/fixtures/fixtures/content/code-security/index.md @@ -1,6 +1,6 @@ --- -title: Code security documentation -shortTitle: Code security +title: '{% data variables.product.product_name %} Code security documentation' +shortTitle: '{% data variables.product.product_name %} Code security' intro: 'Code security' layout: product-landing featuredLinks: @@ -16,7 +16,3 @@ children: - /getting-started - /guides --- - - - - diff --git a/src/fixtures/fixtures/content/rest/code-scanning.md b/src/fixtures/fixtures/content/rest/code-scanning.md deleted file mode 100644 index 67cdf4892d..0000000000 --- a/src/fixtures/fixtures/content/rest/code-scanning.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Code Scanning -intro: >- - Use the REST API to retrieve and update {% data - variables.product.prodname_code_scanning %} alerts from a repository. -versions: - fpt: '*' - ghae: '*' - ghec: '*' - ghes: '*' -autogenerated: rest ---- - - -## About code scanning - -👋, if you're reading this, this is fixture content based on picking -a single endpoint from the real REST API reference docs. -This page, in particular, is different from "[AUTOTITLE](/rest/actions)" -in that the sidebar shows all sub-headings directly. - - diff --git a/src/fixtures/fixtures/content/rest/index.md b/src/fixtures/fixtures/content/rest/index.md index a6fb452564..678acad855 100644 --- a/src/fixtures/fixtures/content/rest/index.md +++ b/src/fixtures/fixtures/content/rest/index.md @@ -20,7 +20,6 @@ versions: children: - /overview - /actions - - /code-scanning --- diff --git a/src/fixtures/tests/footer.js b/src/fixtures/tests/footer.js index 112dbeae33..2cc435a1ab 100644 --- a/src/fixtures/tests/footer.js +++ b/src/fixtures/tests/footer.js @@ -1,11 +1,7 @@ -import { jest } from '@jest/globals' - import { getDOM } from '#src/tests/helpers/e2etest.js' import nonEnterpriseDefaultVersion from '#src/versions/lib/non-enterprise-default-version.js' describe('footer', () => { - jest.setTimeout(10 * 60 * 1000) - describe('"contact us" link', () => { test('leads to support from articles', async () => { const $ = await getDOM( diff --git a/src/fixtures/tests/guides.js b/src/fixtures/tests/guides.js index dbc23900d8..fd95f2db98 100644 --- a/src/fixtures/tests/guides.js +++ b/src/fixtures/tests/guides.js @@ -8,9 +8,9 @@ describe('guides', () => { expect($('title').text()).toMatch(title) expect($('h1').text()).toMatch(title) const learningPaths = $('h2#learning-paths') - expect(learningPaths.text()).toMatch('Code security learning paths') + expect(learningPaths.text()).toMatch('HubGit Code security learning paths') const allGuides = $('h2#all-guides') - expect(allGuides.text()).toMatch('All Code security guides') + expect(allGuides.text()).toMatch('All HubGit Code security guides') }) }) diff --git a/src/fixtures/tests/images.js b/src/fixtures/tests/images.js index 003703fd3e..938d22e659 100644 --- a/src/fixtures/tests/images.js +++ b/src/fixtures/tests/images.js @@ -1,14 +1,9 @@ -import { jest } from '@jest/globals' import sharp from 'sharp' import { get, head, getDOM } from '#src/tests/helpers/e2etest.js' import { MAX_WIDTH } from '#src/content-render/unified/rewrite-asset-img-tags.js' describe('render Markdown image tags', () => { - // The default timeout is 5 seconds, which is not enough for this test - // in potentially slower CI environments. - jest.setTimeout(30 * 1000) - test('page with a single image', async () => { const $ = await getDOM('/get-started/images/single-image') diff --git a/src/fixtures/tests/sidebar.js b/src/fixtures/tests/sidebar.js index 645806f940..a865b431b8 100644 --- a/src/fixtures/tests/sidebar.js +++ b/src/fixtures/tests/sidebar.js @@ -1,9 +1,5 @@ -import { jest } from '@jest/globals' - import { getDOMCached as getDOM } from '#src/tests/helpers/e2etest.js' -jest.setTimeout(10 * 60 * 1000) - describe('sidebar', () => { test('top level product mentioned at top of sidebar', async () => { const $ = await getDOM('/get-started') diff --git a/src/frame/components/page-header/Header.tsx b/src/frame/components/page-header/Header.tsx index 40d33acb63..f9c46ad88f 100644 --- a/src/frame/components/page-header/Header.tsx +++ b/src/frame/components/page-header/Header.tsx @@ -375,7 +375,7 @@ export const Header = () => { href={currentProduct.href} className="d-block pl-1 mb-2 h3 color-fg-default no-underline" > - {currentProduct.name} + {currentProduct.nameRendered} )} diff --git a/src/frame/lib/get-remote-json.js b/src/frame/lib/get-remote-json.js index 4dc69068af..ddaeb04476 100644 --- a/src/frame/lib/get-remote-json.js +++ b/src/frame/lib/get-remote-json.js @@ -85,7 +85,7 @@ export default async function getRemoteJSON(url, config) { } } } - const tags = [`url:${url}`, `from_cache:${fromCache}`] + const tags = [`from_cache:${fromCache}`] statsd.increment('middleware.get_remote_json', 1, tags) return cache.get(cacheKey) } diff --git a/src/frame/lib/warm-server.js b/src/frame/lib/warm-server.js index fcefc7d1ef..0d405d7bf9 100644 --- a/src/frame/lib/warm-server.js +++ b/src/frame/lib/warm-server.js @@ -30,10 +30,6 @@ async function warmServer() { statsd.gauge('memory_heap_used', process.memoryUsage().heapUsed, ['event:warm-server']) - statsd.gauge('num_redirects', Object.keys(redirects).length) - statsd.gauge('num_page_map', Object.keys(pageMap).length) - statsd.gauge('num_page_list', Object.keys(pageList).length) - if (process.env.NODE_ENV !== 'test') { console.log(`Context primed in ${Date.now() - startTime} ms`) } diff --git a/src/ghes-releases/lib/deprecation-steps.md b/src/ghes-releases/lib/deprecation-steps.md index 11c715645c..23c110f93d 100644 --- a/src/ghes-releases/lib/deprecation-steps.md +++ b/src/ghes-releases/lib/deprecation-steps.md @@ -60,7 +60,7 @@ The dates we use for Enterprise releases and deprecations are stored in [release 1. Do a dry run by scraping a small amount of files to test locally on your machine. This command does not overwrite the references to asset files so they will render on your machine. ```shell - node --max-old-space-size=8192 src/ghes-releases/scripts/archive-version.js --dry-run --local-dev + npm run archive-version -- --dry-run --local-dev ``` 1. Navigate to the scraped files directory (`tmpArchivalDir_`) inside your docs-internal checkout. Open a few HTML files and ensure they render and drop-down pickers work correctly. @@ -68,7 +68,7 @@ The dates we use for Enterprise releases and deprecations are stored in [release 1. If the dry-run looks good, scrape all content files. This will take about 20-30 minutes. **Note:** This will overwrite the directory that was previously generated with new files. You can also create a specific output directory using the `--output` flag. ```shell - node --max-old-space-size=8192 src/ghes-releases/scripts/archive-version.js + npm run archive-version ``` 1. Revert changes to `src/search/components/Search.tsx`. @@ -90,7 +90,7 @@ The dates we use for Enterprise releases and deprecations are stored in [release 1. Click `Containers` in the left sidebar, then click the `enterprise` container. 1. Click `Upload` in the top bar. Drag and drop or click `Browse for files` to select the directory inside of `tmpArchivalDir_`. For example, at the time of this writing, the directory name was `3.5`. The upload will take several minutes and the UI may not give feedback immediately. Don't close the browser tab or navigate away from the page until the upload is complete. - + App method: 1. Open the Microsoft Azure Storage Explorer app from the `Overview` tab [githubdocs Azure Storage Blob resource page](https://portal.azure.com/#@githubazure.onmicrosoft.com/resource/subscriptions/fa6134a7-f27e-4972-8e9f-0cedffa328f1/resourceGroups/docs-production/providers/Microsoft.Storage/storageAccounts/githubdocs/overview). @@ -144,7 +144,7 @@ This step will remove the version from the drop-down picker, effectively depreca 1. Manually delete the deprecated directory in `data/graphql`. For example, if you are deprecating the 3.5 release, you'd delete the `data/graphql/ghes-3.5` directory. -1. Open a new PR. Reviewers will be automatically assigned. +1. Open a new PR. Reviewers will be automatically assigned. 1. When the PR is approved, merge it in. 🚢 @@ -157,7 +157,7 @@ This step will remove the version from the drop-down picker, effectively depreca 1. Remove the outdated Liquid markup and frontmatter. ```shell - src/ghes-releases/scripts/remove-version-markup.js --release + npm run remove-version-markup -- --release ``` 1. If data resuables were deleted automatically, you'll need to remove references to the deleted reusable in the content. Using VSCode to find the occurrences is quick and there are typically only a few to update. If you have any questions, reach out to the docs-content team in #docs-content to ask for help updating the Markdown files. @@ -178,7 +178,7 @@ This step will remove the version from the drop-down picker, effectively depreca ## Re-scraping a page or all pages -Occasionally, a change will need to be added to our archived enterprise versions. If this occurs, you can check out the `enterprise--release` branch and re-scrape the page or all pages using `src/ghes-releases/scripts/archive-version.js`. To scrape a single page you can use the `—page ` option. +Occasionally, a change will need to be added to our archived enterprise versions. If this occurs, you can check out the `enterprise--release` branch and re-scrape the page or all pages using `npm run archive-version`. To scrape a single page you can use the `—page ` option. For each language, upload the new file to Azure blob storage in the `enterprise` container. diff --git a/src/ghes-releases/lib/release-steps.md b/src/ghes-releases/lib/release-steps.md index 3e4fff9344..be32404b5e 100644 --- a/src/ghes-releases/lib/release-steps.md +++ b/src/ghes-releases/lib/release-steps.md @@ -31,7 +31,7 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng - [ ] If this is a release candidate release, add a Release Candidate banner: ``` - src/ghes-releases/scripts/release-banner.js --action create --version + npm run release-banner -- --action create --version ``` - [ ] Create a PR with the above changes. This PR is used to track all docs changes and smoke tests associated with the release. For example https://github.com/github/docs-internal/pull/22286. @@ -73,7 +73,7 @@ This file should be automatically updated, but you can also run `src/ghes-releas - [ ] Add any required smoke tests to the opening post in the megabranch PR. Usually, we should smoke test any new GHES admin guides, any large features landing in this GHES version for the first time, and the REST and GraphQL API references. -- [ ] A few days before shipping, check for broken links. Run `/src/links/scripts/rendered-content-link-checker-cli.js` in a local copy of the megabranch. +- [ ] A few days before shipping, check for broken links. Run `npm run rendered-content-link-checker-cli` in a local copy of the megabranch. - [ ] [Freeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) at least 1-2 days before the release, and post an announcement in Slack so everybody knows. It's helpful to freeze the repos before doing the OpenAPI merges to avoid changes to the megabranch while preparing and deploying. - [ ] Alert the Neon Squad (formally docs-ecosystem team) 1-2 days before the release to deploy to `github/github`. A PR should already be open in `github/github` to change the OpenAPI schema config `published` to `true` in `app/api/description/config/releases/ghes-.yaml`. They will need to: - [ ] Get the required approval from `@github/ecosystem-api-reviewers` then deploy the PR to dotcom. This process generally takes 30-90 minutes. diff --git a/src/ghes-releases/scripts/remove-liquid-statements.js b/src/ghes-releases/scripts/remove-liquid-statements.js index 8969302c7f..328b189146 100644 --- a/src/ghes-releases/scripts/remove-liquid-statements.js +++ b/src/ghes-releases/scripts/remove-liquid-statements.js @@ -17,7 +17,7 @@ const tokenize = (str) => { return tokenizer.readTopLevelTokens() } // This module is used by -// src/ghes-releases/scripts/remove-version-markup.js to remove +// `npm run remove-version-markup` to remove // and update Liquid conditionals when a GHES release is being deprecated. It is also used by // src/ghes-releases/tests/remove-liquid-statements.js. export default function removeLiquidStatements(content, release, nextOldestRelease, file) { diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 399b84b3e6..69c0289a35 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -3200,15 +3200,6 @@ "additional-permissions": [], "access": "read" }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": [], - "access": "write" - }, { "category": "collaborators", "slug": "decline-a-repository-invitation", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 385629b3d1..d15d2e94b9 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -1670,12 +1670,6 @@ "verb": "get", "requestPath": "/user/repository_invitations" }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, { "slug": "decline-a-repository-invitation", "subcategory": "invitations", diff --git a/src/github-apps/data/ghae/fine-grained-pat-permissions.json b/src/github-apps/data/ghae/fine-grained-pat-permissions.json index ce856e0cab..741289d3aa 100644 --- a/src/github-apps/data/ghae/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghae/fine-grained-pat-permissions.json @@ -1863,15 +1863,6 @@ "additional-permissions": [], "access": "read" }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": [], - "access": "write" - }, { "category": "collaborators", "slug": "decline-a-repository-invitation", diff --git a/src/github-apps/data/ghae/fine-grained-pat.json b/src/github-apps/data/ghae/fine-grained-pat.json index 22c17674db..1050db2e3a 100644 --- a/src/github-apps/data/ghae/fine-grained-pat.json +++ b/src/github-apps/data/ghae/fine-grained-pat.json @@ -962,12 +962,6 @@ "verb": "get", "requestPath": "/user/repository_invitations" }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, { "slug": "decline-a-repository-invitation", "subcategory": "invitations", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index ed131cdd8e..ceae1d008e 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -3858,15 +3858,6 @@ "additional-permissions": [], "access": "read" }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": [], - "access": "write" - }, { "category": "collaborators", "slug": "decline-a-repository-invitation", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index c67b9b64c1..b89113f37d 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -1786,12 +1786,6 @@ "verb": "get", "requestPath": "/user/repository_invitations" }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, { "slug": "decline-a-repository-invitation", "subcategory": "invitations", diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json index 31aede8834..9dd885ff41 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json @@ -2890,15 +2890,6 @@ "additional-permissions": [], "access": "read" }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": [], - "access": "write" - }, { "category": "collaborators", "slug": "decline-a-repository-invitation", diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json index d4a9e5bf66..4f29d47785 100644 --- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat.json @@ -1422,12 +1422,6 @@ "verb": "get", "requestPath": "/user/repository_invitations" }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, { "slug": "decline-a-repository-invitation", "subcategory": "invitations", diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json index daef262314..e1c378adf3 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat-permissions.json @@ -2962,15 +2962,6 @@ "additional-permissions": [], "access": "read" }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": [], - "access": "write" - }, { "category": "collaborators", "slug": "decline-a-repository-invitation", diff --git a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json index 5892953a7d..cfb5f4df54 100644 --- a/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.11-2022-11-28/fine-grained-pat.json @@ -1422,12 +1422,6 @@ "verb": "get", "requestPath": "/user/repository_invitations" }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, { "slug": "decline-a-repository-invitation", "subcategory": "invitations", diff --git a/src/github-apps/data/ghes-3.7/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.7/fine-grained-pat-permissions.json index 5b69dc7ce0..1478e6e2fc 100644 --- a/src/github-apps/data/ghes-3.7/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.7/fine-grained-pat-permissions.json @@ -2598,15 +2598,6 @@ "additional-permissions": [], "access": "read" }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": [], - "access": "write" - }, { "category": "collaborators", "slug": "decline-a-repository-invitation", diff --git a/src/github-apps/data/ghes-3.7/fine-grained-pat.json b/src/github-apps/data/ghes-3.7/fine-grained-pat.json index 220ab4f825..cceb44169c 100644 --- a/src/github-apps/data/ghes-3.7/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.7/fine-grained-pat.json @@ -1264,12 +1264,6 @@ "verb": "get", "requestPath": "/user/repository_invitations" }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, { "slug": "decline-a-repository-invitation", "subcategory": "invitations", diff --git a/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json index 8c78c3ca1f..734dc5542c 100644 --- a/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.8/fine-grained-pat-permissions.json @@ -2711,15 +2711,6 @@ "additional-permissions": [], "access": "read" }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": [], - "access": "write" - }, { "category": "collaborators", "slug": "decline-a-repository-invitation", diff --git a/src/github-apps/data/ghes-3.8/fine-grained-pat.json b/src/github-apps/data/ghes-3.8/fine-grained-pat.json index 9c358bcb00..f871fcd432 100644 --- a/src/github-apps/data/ghes-3.8/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.8/fine-grained-pat.json @@ -1392,12 +1392,6 @@ "verb": "get", "requestPath": "/user/repository_invitations" }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, { "slug": "decline-a-repository-invitation", "subcategory": "invitations", diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json index e8b798a193..cf03e4d06b 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat-permissions.json @@ -2827,15 +2827,6 @@ "additional-permissions": [], "access": "read" }, - { - "category": "collaborators", - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}", - "additional-permissions": [], - "access": "write" - }, { "category": "collaborators", "slug": "decline-a-repository-invitation", diff --git a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json index 6d19813063..1c50e4985a 100644 --- a/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.9-2022-11-28/fine-grained-pat.json @@ -1410,12 +1410,6 @@ "verb": "get", "requestPath": "/user/repository_invitations" }, - { - "slug": "accept-a-repository-invitation", - "subcategory": "invitations", - "verb": "patch", - "requestPath": "/user/repository_invitations/{invitation_id}" - }, { "slug": "decline-a-repository-invitation", "subcategory": "invitations", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 6e0d610035..81ea3eedec 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "6922a6cfe785e1069e93d6e501805cf6e1891076" + "sha": "1fd29675070876e3278e71b47f4f2606601bc698" } \ No newline at end of file diff --git a/src/github-apps/scripts/sync.js b/src/github-apps/scripts/sync.js old mode 100755 new mode 100644 index d735fc7870..544fb18a42 --- a/src/github-apps/scripts/sync.js +++ b/src/github-apps/scripts/sync.js @@ -62,9 +62,11 @@ export async function syncGitHubAppsData(openApiSource, sourceSchemas, progAcces } // permissions - for (const [permissionName, readOrWrite] of Object.entries( - progAccessData[operation.operationId].permissions, - )) { + const allPermissions = { + ...progAccessData[operation.operationId].permissions.and, + ...progAccessData[operation.operationId].permissions.or, + } + for (const [permissionName, readOrWrite] of Object.entries(allPermissions)) { const tempTitle = permissionName.replace(/_/g, ' ') const permissionNameExists = progActorResources[permissionName] if (!permissionNameExists) { @@ -76,9 +78,8 @@ export async function syncGitHubAppsData(openApiSource, sourceSchemas, progAcces const resourceGroup = progActorResources[permissionName]?.resource_group || '' const displayTitle = getDisplayTitle(title, resourceGroup) const relatedPermissionNames = Object.keys( - progAccessData[operation.operationId].permissions, + progAccessData[operation.operationId].permissions.and, ).filter((permission) => permission !== permissionName) - // github app permissions const serverToServerPermissions = githubAppsData['server-to-server-permissions'] if (!serverToServerPermissions[permissionName]) { @@ -182,11 +183,41 @@ async function getProgAccessData(progAccessSource) { const progAccessData = {} for (const operation of progAccessDataRaw) { - const permissions = {} + const permissions = { or: {}, and: {} } if (operation.permission_sets) { - operation.permission_sets.forEach((permissionSet) => { - Object.assign(permissions, permissionSet) - }) + // Currently there is only a length of up to 2 permission_sets + // OR permission_sets are dashed lists in yaml + // e.g. + // permission_sets: + // - admin: write + // - contents: read + // This becomes: [{admin: write}, {contents: read}] with yaml.load + if (operation.permission_sets.length === 2) { + // There's currently only one scenario where you have an OR permission_set where one of the OR permissions is an AND permission_set + // In this scenario, we want the AND permission_set + if ( + Object.keys(operation.permission_sets[0]).length > 1 || + Object.keys(operation.permission_sets[1]).length > 1 + ) { + const andPermissionSet = + Object.keys(operation.permission_sets[0]).length > 1 + ? operation.permission_sets[0] + : operation.permission_sets[1] + Object.assign(permissions.and, andPermissionSet) + } else { + operation.permission_sets.forEach((permissionSet) => { + Object.assign(permissions.or, permissionSet) + }) + } + // AND permission_sets are under the same dash in yaml + // e.g. + // permission_sets: + // - admin: write + // contents: read + // This becomes: [{admin: write, contents: read}] with yaml.load + } else if (operation.permission_sets.length === 1) { + Object.assign(permissions.and, operation.permission_sets[0]) + } } const userToServerRest = operation.user_to_server.enabled diff --git a/src/landings/components/ProductGuides.tsx b/src/landings/components/ProductGuides.tsx index c60de8a66e..e80e5dab97 100644 --- a/src/landings/components/ProductGuides.tsx +++ b/src/landings/components/ProductGuides.tsx @@ -12,7 +12,8 @@ export const ProductGuides = () => { const { t } = useTranslation('product_guides') const { currentProduct } = useMainContext() - const productName = currentProduct?.name || title + + const productName = currentProduct?.nameRendered || title const nameRegex = /{{\s*name\s*}}/ return ( diff --git a/src/languages/lib/correct-translation-content.js b/src/languages/lib/correct-translation-content.js index 45c23fbe04..a363f1483b 100644 --- a/src/languages/lib/correct-translation-content.js +++ b/src/languages/lib/correct-translation-content.js @@ -68,7 +68,19 @@ export function correctTranslatedContentStrings(content, englishContent, context content = content.replaceAll('|:---|{% ifversion', '|:---|\n{%- ifversion') } - // A lot of Liquid tags lose their linebreak after the `}` which can + if (context.dottedPath === 'reusables.copilot.differences-cfi-cfb-table') { + // As of Dec 2023, the French translation has a subtle typo. + // This string replace is highly specific and clearly only going to + // work if the exact French, incorrect, translation is still in use. + // Consider deleting these lines in mid-2024 because hopefully by then + // the translation mistake, which we've reported, will be corrected. + content = content.replace( + '{% data variables.copilot.cfi_price_per_month %} par utilisateur et par mois', + '{% data variables.copilot.cfb_price_per_month %} par utilisateur et par mois.', + ) + } + + // A lot of Liquid tags lose their linebreak after the `}` // result in formatting problems, especially around Markdown tables. // This code here, compares each Liquid statement, in the translation, // and tests if it appears like that but with a newline in the English. diff --git a/src/languages/scripts/create-translation-health-report.js b/src/languages/scripts/create-translation-health-report.js index 4a5cb6c9aa..74847991c6 100755 --- a/src/languages/scripts/create-translation-health-report.js +++ b/src/languages/scripts/create-translation-health-report.js @@ -8,7 +8,7 @@ /* Nota bene: If you are getting more errors all the sudden, try running this: - $ src/languages/scripts/create-translation-health-report.js -l en -r 000 + $ npm run create-translation-health-report -- -l en -r 000 If there's any errors before getting the JSON output, const context = { ... } probably needs more data. */ diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 01a4da19ce..9f6c309312 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -4450,7 +4450,7 @@ "properties": { "access_level": { "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization.", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", "enum": [ "none", "user", @@ -4506,7 +4506,7 @@ "type": "string", "name": "access_level", "in": "body", - "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repos only. organization level access allows sharing across the organization.

", + "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization.

", "isRequired": true, "enum": [ "none", @@ -68532,7 +68532,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -88617,6 +88617,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -88625,6 +88633,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -88817,6 +88833,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -88896,6 +88919,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -89602,6 +89680,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -89610,6 +89696,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -89802,6 +89896,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -89881,6 +89982,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -90279,6 +90435,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -90288,6 +90453,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -90504,6 +90678,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -90593,6 +90775,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -90796,6 +91040,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -90804,6 +91056,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -90996,6 +91256,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -91075,6 +91342,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -92816,6 +93138,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -92825,6 +93156,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -93041,6 +93381,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -93130,6 +93478,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -93520,6 +93930,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -93528,6 +93946,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -93720,6 +94146,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -93799,6 +94232,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -94921,6 +95409,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -94929,6 +95425,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -95121,6 +95625,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -95200,6 +95711,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -95910,6 +96476,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -95918,6 +96492,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -96110,6 +96692,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -96189,6 +96778,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -96897,6 +97541,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -96905,6 +97557,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -97097,6 +97757,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -97176,6 +97843,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -99661,6 +100383,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -99669,6 +100399,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99861,6 +100599,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -99940,6 +100685,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -105350,6 +106150,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -105358,6 +106166,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105550,6 +106366,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -105629,6 +106452,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -106277,6 +107155,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -106285,6 +107171,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -106477,6 +107371,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -106556,6 +107457,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -152197,7 +153153,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

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

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

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

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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

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

\n

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

\n

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

\n

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

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

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

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

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

", "statusCodes": [ { "httpStatusCode": "200", @@ -154825,7 +155781,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", + "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", "isRequired": true }, { @@ -155032,7 +155988,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

", "statusCodes": [ { "httpStatusCode": "200", @@ -352801,6 +353757,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -352809,6 +353773,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -353001,6 +353973,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -353080,6 +354059,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 5fda426b9d..8487bb89f9 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -60914,6 +60914,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -60922,6 +60930,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -61073,6 +61089,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -61152,6 +61175,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -61858,6 +61936,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -61866,6 +61952,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -62017,6 +62111,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -62096,6 +62197,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -62494,6 +62650,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -62503,6 +62668,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -62673,6 +62847,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -62762,6 +62944,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -62965,6 +63209,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -62973,6 +63225,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -63124,6 +63384,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -63203,6 +63470,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -65620,6 +65942,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -65628,6 +65958,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -65779,6 +66117,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -65858,6 +66203,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -66568,6 +66968,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -66576,6 +66984,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -66727,6 +67143,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -66806,6 +67229,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -67514,6 +67992,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -67522,6 +68008,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -67673,6 +68167,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -67752,6 +68253,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -70152,6 +70708,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -70160,6 +70724,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -70311,6 +70883,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -70390,6 +70969,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -72883,6 +73517,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -72891,6 +73533,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -73042,6 +73692,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -73121,6 +73778,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -73769,6 +74481,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -73777,6 +74497,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -73928,6 +74656,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -74007,6 +74742,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -74715,6 +75505,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -74723,6 +75521,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -74874,6 +75680,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -74953,6 +75766,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -115270,7 +116138,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

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

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

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

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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

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

\n

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

\n

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -116909,7 +117777,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", + "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", "isRequired": true }, { @@ -117110,7 +117978,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

", "statusCodes": [ { "httpStatusCode": "200", @@ -150709,6 +151577,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -150717,6 +151593,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -150868,6 +151752,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -150947,6 +151838,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -151654,6 +152600,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -151662,6 +152616,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -151813,6 +152775,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -151892,6 +152861,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -152469,6 +153493,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -152477,6 +153509,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -152628,6 +153668,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -152707,6 +153754,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -260092,6 +261194,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -260100,6 +261210,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -260251,6 +261369,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -260330,6 +261455,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index e8e6a24a8c..ca753b8411 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -5388,7 +5388,7 @@ "properties": { "access_level": { "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", "enum": [ "none", "user", @@ -5445,7 +5445,7 @@ "type": "string", "name": "access_level", "in": "body", - "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repos only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", + "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", "isRequired": true, "enum": [ "none", @@ -78288,7 +78288,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -98955,6 +98955,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -98963,6 +98971,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99155,6 +99171,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -99234,6 +99257,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -99940,6 +100018,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -99948,6 +100034,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100140,6 +100234,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -100219,6 +100320,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -100617,6 +100773,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -100626,6 +100791,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -100842,6 +101016,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -100931,6 +101113,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -101134,6 +101378,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -101142,6 +101394,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -101334,6 +101594,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -101413,6 +101680,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -103154,6 +103476,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -103163,6 +103494,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -103379,6 +103719,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -103468,6 +103816,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -103858,6 +104268,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -103866,6 +104284,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104058,6 +104484,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -104137,6 +104570,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -105259,6 +105747,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -105267,6 +105763,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105459,6 +105963,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -105538,6 +106049,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -106248,6 +106814,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -106256,6 +106830,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -106448,6 +107030,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -106527,6 +107116,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -107235,6 +107879,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -107243,6 +107895,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -107435,6 +108095,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -107514,6 +108181,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -109999,6 +110721,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -110007,6 +110737,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -110199,6 +110937,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -110278,6 +111023,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -115688,6 +116488,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -115696,6 +116504,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -115888,6 +116704,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -115967,6 +116790,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -116615,6 +117493,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -116623,6 +117509,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116815,6 +117709,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -116894,6 +117795,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -164190,7 +165146,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

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

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

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

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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

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

\n

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

\n

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

\n

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

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

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

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

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

", "statusCodes": [ { "httpStatusCode": "200", @@ -166818,7 +167774,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", + "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", "isRequired": true }, { @@ -167025,7 +167981,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

", "statusCodes": [ { "httpStatusCode": "200", @@ -372863,6 +373819,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -372871,6 +373835,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -373063,6 +374035,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -373142,6 +374121,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 58eaec8610..cfabc279a1 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -5601,7 +5601,7 @@ "properties": { "access_level": { "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", "enum": [ "none", "user", @@ -5658,7 +5658,7 @@ "type": "string", "name": "access_level", "in": "body", - "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repos only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", + "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", "isRequired": true, "enum": [ "none", @@ -77852,7 +77852,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -98192,6 +98192,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -98200,6 +98208,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -98367,6 +98383,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -98446,6 +98469,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -99152,6 +99230,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -99160,6 +99246,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99327,6 +99421,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -99406,6 +99507,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -99804,6 +99960,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -99813,6 +99978,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -100001,6 +100175,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -100090,6 +100272,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -100293,6 +100537,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -100301,6 +100553,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100468,6 +100728,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -100547,6 +100814,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -102288,6 +102610,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -102297,6 +102628,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -102485,6 +102825,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -102574,6 +102922,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -102964,6 +103374,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -102972,6 +103390,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -103139,6 +103565,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -103218,6 +103651,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -104340,6 +104828,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -104348,6 +104844,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104515,6 +105019,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -104594,6 +105105,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -105304,6 +105870,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -105312,6 +105886,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105479,6 +106061,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -105558,6 +106147,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -106266,6 +106910,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -106274,6 +106926,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -106441,6 +107101,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -106520,6 +107187,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -109005,6 +109727,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -109013,6 +109743,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -109180,6 +109918,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -109259,6 +110004,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -111841,6 +112641,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -111849,6 +112657,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112016,6 +112832,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -112095,6 +112918,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -112743,6 +113621,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -112751,6 +113637,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112918,6 +113812,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -112997,6 +113898,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -158067,7 +159023,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

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

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

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

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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

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

\n

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

\n

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

\n

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

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

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

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

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

", "statusCodes": [ { "httpStatusCode": "200", @@ -159994,7 +160950,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", + "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", "isRequired": true }, { @@ -160195,7 +161151,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

", "statusCodes": [ { "httpStatusCode": "200", @@ -214221,6 +215177,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -214229,6 +215193,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -214396,6 +215368,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -214475,6 +215454,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -215495,6 +216529,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -215503,6 +216545,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -215670,6 +216720,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -215749,6 +216806,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -216326,6 +217438,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -216334,6 +217454,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -216501,6 +217629,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -216580,6 +217715,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -324070,6 +325260,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -324078,6 +325276,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -324245,6 +325451,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -324324,6 +325537,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -324977,6 +326245,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -324985,6 +326261,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -325152,6 +326436,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -325231,6 +326522,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -325899,6 +327245,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -325907,6 +327261,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -326074,6 +327436,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -326153,6 +327522,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -326733,6 +328157,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -326741,6 +328173,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -326908,6 +328348,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -326987,6 +328434,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -327659,6 +329161,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -327667,6 +329177,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -327834,6 +329352,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -327913,6 +329438,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -328494,6 +330074,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -328502,6 +330090,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -328669,6 +330265,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -328748,6 +330351,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -329358,6 +331016,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -329366,6 +331032,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -329533,6 +331207,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -329612,6 +331293,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -330273,6 +332009,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -330281,6 +332025,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -330448,6 +332200,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -330527,6 +332286,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -333253,6 +335067,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -333261,6 +335083,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -333428,6 +335258,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -333507,6 +335344,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 631ba29c9b..3abe38f6ca 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -5601,7 +5601,7 @@ "properties": { "access_level": { "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", "enum": [ "none", "user", @@ -5658,7 +5658,7 @@ "type": "string", "name": "access_level", "in": "body", - "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repos only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", + "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", "isRequired": true, "enum": [ "none", @@ -77876,7 +77876,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -98216,6 +98216,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -98224,6 +98232,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -98391,6 +98407,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -98470,6 +98493,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -99176,6 +99254,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -99184,6 +99270,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99351,6 +99445,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -99430,6 +99531,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -99828,6 +99984,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -99837,6 +100002,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -100025,6 +100199,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -100114,6 +100296,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -100317,6 +100561,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -100325,6 +100577,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100492,6 +100752,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -100571,6 +100838,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -102312,6 +102634,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -102321,6 +102652,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -102509,6 +102849,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -102598,6 +102946,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -102988,6 +103398,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -102996,6 +103414,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -103163,6 +103589,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -103242,6 +103675,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -104364,6 +104852,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -104372,6 +104868,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104539,6 +105043,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -104618,6 +105129,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -105328,6 +105894,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -105336,6 +105910,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105503,6 +106085,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -105582,6 +106171,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -106290,6 +106934,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -106298,6 +106950,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -106465,6 +107125,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -106544,6 +107211,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -109029,6 +109751,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -109037,6 +109767,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -109204,6 +109942,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -109283,6 +110028,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -111865,6 +112665,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -111873,6 +112681,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112040,6 +112856,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -112119,6 +112942,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -112767,6 +113645,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -112775,6 +113661,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112942,6 +113836,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -113021,6 +113922,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -158091,7 +159047,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

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

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

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

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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

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

\n

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

\n

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

\n

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

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

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

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

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

", "statusCodes": [ { "httpStatusCode": "200", @@ -160030,7 +160986,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", + "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", "isRequired": true }, { @@ -160231,7 +161187,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

", "statusCodes": [ { "httpStatusCode": "200", @@ -214286,6 +215242,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -214294,6 +215258,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -214461,6 +215433,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -214540,6 +215519,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -215560,6 +216594,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -215568,6 +216610,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -215735,6 +216785,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -215814,6 +216871,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -216391,6 +217503,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -216399,6 +217519,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -216566,6 +217694,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -216645,6 +217780,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -324135,6 +325325,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -324143,6 +325341,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -324310,6 +325516,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -324389,6 +325602,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -325042,6 +326310,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -325050,6 +326326,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -325217,6 +326501,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -325296,6 +326587,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -325964,6 +327310,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -325972,6 +327326,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -326139,6 +327501,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -326218,6 +327587,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -326798,6 +328222,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -326806,6 +328238,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -326973,6 +328413,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -327052,6 +328499,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -327724,6 +329226,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -327732,6 +329242,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -327899,6 +329417,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -327978,6 +329503,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -328559,6 +330139,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -328567,6 +330155,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -328734,6 +330330,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -328813,6 +330416,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -329423,6 +331081,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -329431,6 +331097,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -329598,6 +331272,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -329677,6 +331358,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -330338,6 +332074,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -330346,6 +332090,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -330513,6 +332265,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -330592,6 +332351,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -333332,6 +335146,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -333340,6 +335162,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -333507,6 +335337,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -333586,6 +335423,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json index d1483f1025..dd5141a627 100644 --- a/src/rest/data/ghes-3.7/schema.json +++ b/src/rest/data/ghes-3.7/schema.json @@ -73376,7 +73376,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -93145,6 +93145,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -93153,6 +93161,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -93304,6 +93320,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -93383,6 +93406,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -94089,6 +94167,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -94097,6 +94183,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -94248,6 +94342,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -94327,6 +94428,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -94725,6 +94881,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -94734,6 +94899,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -94904,6 +95078,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -94993,6 +95175,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -95196,6 +95440,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -95204,6 +95456,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -95355,6 +95615,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -95434,6 +95701,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -97175,6 +97497,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -97184,6 +97515,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -97354,6 +97694,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -97443,6 +97791,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -97833,6 +98243,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -97841,6 +98259,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -97992,6 +98418,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -98071,6 +98504,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -99193,6 +99681,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -99201,6 +99697,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99352,6 +99856,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -99431,6 +99942,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -100141,6 +100707,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -100149,6 +100723,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100300,6 +100882,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -100379,6 +100968,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -101087,6 +101731,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -101095,6 +101747,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -101246,6 +101906,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -101325,6 +101992,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -103810,6 +104532,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -103818,6 +104548,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -103969,6 +104707,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -104048,6 +104793,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -106626,6 +107426,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -106634,6 +107442,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -106785,6 +107601,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -106864,6 +107687,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -107512,6 +108390,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -107520,6 +108406,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -107671,6 +108565,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -107750,6 +108651,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -152057,7 +153013,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only. GitHub Apps must have the security_events read permission to use this endpoint.

\n

Deprecation notice:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.

", + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only. GitHub Apps must have the security_events read permission to use this endpoint.

\n

Deprecation notice:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.

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

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

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

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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

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

\n

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

\n

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -153729,7 +154685,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", + "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", "isRequired": true }, { @@ -153930,7 +154886,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

", "statusCodes": [ { "httpStatusCode": "200", @@ -199056,6 +200012,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -199064,6 +200028,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -199215,6 +200187,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -199294,6 +200273,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -200314,6 +201348,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -200322,6 +201364,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -200473,6 +201523,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -200552,6 +201609,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -201129,6 +202241,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -201137,6 +202257,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -201288,6 +202416,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -201367,6 +202502,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -308659,6 +309849,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -308667,6 +309865,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -308818,6 +310024,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -308897,6 +310110,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -309550,6 +310818,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -309558,6 +310834,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -309709,6 +310993,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -309788,6 +311079,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -310456,6 +311802,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -310464,6 +311818,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -310615,6 +311977,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -310694,6 +312063,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -311274,6 +312698,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -311282,6 +312714,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -311433,6 +312873,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -311512,6 +312959,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -312184,6 +313686,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -312192,6 +313702,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -312343,6 +313861,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -312422,6 +313947,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -313003,6 +314583,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -313011,6 +314599,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -313162,6 +314758,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -313241,6 +314844,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -313851,6 +315509,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -313859,6 +315525,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -314010,6 +315684,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -314089,6 +315770,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -314750,6 +316486,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -314758,6 +316502,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -314909,6 +316661,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -314988,6 +316747,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -317606,6 +319420,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -317614,6 +319436,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -317765,6 +319595,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -317844,6 +319681,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 36ad7ea73f..5eea262a56 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -5601,7 +5601,7 @@ "properties": { "access_level": { "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", "enum": [ "none", "user", @@ -5658,7 +5658,7 @@ "type": "string", "name": "access_level", "in": "body", - "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repos only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", + "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", "isRequired": true, "enum": [ "none", @@ -76150,7 +76150,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -96178,6 +96178,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -96186,6 +96194,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -96345,6 +96361,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -96424,6 +96447,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -97130,6 +97208,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -97138,6 +97224,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -97297,6 +97391,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -97376,6 +97477,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -97774,6 +97930,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -97783,6 +97948,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -97962,6 +98136,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -98051,6 +98233,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -98254,6 +98498,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -98262,6 +98514,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -98421,6 +98681,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -98500,6 +98767,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -100241,6 +100563,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -100250,6 +100581,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -100429,6 +100769,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -100518,6 +100866,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -100908,6 +101318,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -100916,6 +101334,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -101075,6 +101501,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -101154,6 +101587,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -102276,6 +102764,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -102284,6 +102780,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102443,6 +102947,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -102522,6 +103033,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -103232,6 +103798,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -103240,6 +103814,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -103399,6 +103981,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -103478,6 +104067,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -104186,6 +104830,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -104194,6 +104846,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104353,6 +105013,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -104432,6 +105099,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -106917,6 +107639,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -106925,6 +107655,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -107084,6 +107822,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -107163,6 +107908,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -109741,6 +110541,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -109749,6 +110557,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -109908,6 +110724,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -109987,6 +110810,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -110635,6 +111513,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -110643,6 +111529,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -110802,6 +111696,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -110881,6 +111782,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -155430,7 +156386,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

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

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

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

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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

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

\n

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

\n

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

\n

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -157102,7 +158058,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", + "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", "isRequired": true }, { @@ -157303,7 +158259,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

", "statusCodes": [ { "httpStatusCode": "200", @@ -209072,6 +210028,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -209080,6 +210044,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -209239,6 +210211,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -209318,6 +210297,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -210338,6 +211372,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -210346,6 +211388,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -210505,6 +211555,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -210584,6 +211641,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -211161,6 +212273,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -211169,6 +212289,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -211328,6 +212456,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -211407,6 +212542,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -318699,6 +319889,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -318707,6 +319905,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -318866,6 +320072,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -318945,6 +320158,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -319598,6 +320866,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -319606,6 +320882,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -319765,6 +321049,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -319844,6 +321135,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -320512,6 +321858,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -320520,6 +321874,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -320679,6 +322041,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -320758,6 +322127,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -321338,6 +322762,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -321346,6 +322778,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -321505,6 +322945,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -321584,6 +323031,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -322256,6 +323758,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -322264,6 +323774,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -322423,6 +323941,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -322502,6 +324027,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -323083,6 +324663,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -323091,6 +324679,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -323250,6 +324846,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -323329,6 +324932,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -323939,6 +325597,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -323947,6 +325613,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -324106,6 +325780,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -324185,6 +325866,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -324846,6 +326582,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -324854,6 +326598,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -325013,6 +326765,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -325092,6 +326851,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -327760,6 +329574,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -327768,6 +329590,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -327927,6 +329757,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -328006,6 +329843,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index e12c5eed4e..df970f8d67 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -5601,7 +5601,7 @@ "properties": { "access_level": { "type": "string", - "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", "enum": [ "none", "user", @@ -5658,7 +5658,7 @@ "type": "string", "name": "access_level", "in": "body", - "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repos only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", + "description": "

Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.

\n

none means the access is only possible from workflows in this repository. user level access allows sharing across user owned private repositories only. organization level access allows sharing across the organization. enterprise level access allows sharing across the enterprise.

", "isRequired": true, "enum": [ "none", @@ -76940,7 +76940,7 @@ } ], "previews": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "200", @@ -97210,6 +97210,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -97218,6 +97226,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -97385,6 +97401,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -97464,6 +97487,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -98170,6 +98248,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -98178,6 +98264,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -98345,6 +98439,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -98424,6 +98525,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -98822,6 +98978,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -98831,6 +98996,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -99019,6 +99193,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -99108,6 +99290,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -99311,6 +99555,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -99319,6 +99571,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99486,6 +99746,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -99565,6 +99832,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -101306,6 +101628,15 @@ "write" ] }, + { + "type": "string", + "name": "codespaces", + "description": "

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "contents", @@ -101315,6 +101646,15 @@ "write" ] }, + { + "type": "string", + "name": "dependabot_secrets", + "description": "

The leve of permission to grant the access token to manage Dependabot secrets.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "deployments", @@ -101503,6 +101843,14 @@ "write" ] }, + { + "type": "string", + "name": "organization_events", + "description": "

The level of permission to grant the access token to view events triggered by an activity in an organization.

", + "enum": [ + "read" + ] + }, { "type": "string", "name": "organization_hooks", @@ -101592,6 +101940,68 @@ "read", "write" ] + }, + { + "type": "string", + "name": "email_addresses", + "description": "

The level of permission to grant the access token to manage the email addresses belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "followers", + "description": "

The level of permission to grant the access token to manage the followers belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "git_ssh_keys", + "description": "

The level of permission to grant the access token to manage git SSH keys.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "gpg_keys", + "description": "

The level of permission to grant the access token to view and manage GPG keys belonging to a user.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "interaction_limits", + "description": "

The level of permission to grant the access token to view and manage interaction limits on a repository.

", + "enum": [ + "read", + "write" + ] + }, + { + "type": "string", + "name": "profile", + "description": "

The level of permission to grant the access token to manage the profile settings belonging to a user.

", + "enum": [ + "write" + ] + }, + { + "type": "string", + "name": "starring", + "description": "

The level of permission to grant the access token to list and manage repositories a user is starring.

", + "enum": [ + "read", + "write" + ] } ] } @@ -101982,6 +102392,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -101990,6 +102408,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102157,6 +102583,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -102236,6 +102669,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -103358,6 +103846,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -103366,6 +103862,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -103533,6 +104037,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -103612,6 +104123,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -104322,6 +104888,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -104330,6 +104904,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104497,6 +105079,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -104576,6 +105165,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -105284,6 +105928,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -105292,6 +105944,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105459,6 +106119,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -105538,6 +106205,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -108023,6 +108745,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -108031,6 +108761,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -108198,6 +108936,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -108277,6 +109022,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -110855,6 +111655,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -110863,6 +111671,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -111030,6 +111846,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -111109,6 +111932,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -111757,6 +112635,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -111765,6 +112651,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -111932,6 +112826,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -112011,6 +112912,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -156804,7 +157760,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

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

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repos,\nthe public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert.\nYou must use an access token with the security_events scope to use this endpoint with private repositories,\nthe public_repo scope also grants permission to read security events on public repositories only.

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

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

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

\n

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

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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

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

\n

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

\n

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

\n

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

", + "descriptionHTML": "

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

\n

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

\n

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

\n

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

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

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Gets a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

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

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repos or the public_repo\nscope for public repos.

", + "descriptionHTML": "

Updates a code scanning default setup configuration.\nYou must use an access token with the repo scope to use this endpoint with private repositories or the public_repo\nscope for public repositories.

", "statusCodes": [ { "httpStatusCode": "200", @@ -158725,7 +159681,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head.

", + "description": "

The full Git reference, formatted as refs/heads/<branch name>,\nrefs/tags/<tag>, refs/pull/<number>/merge, or refs/pull/<number>/head.

", "isRequired": true }, { @@ -158926,7 +159882,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

", + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint with private repositories, the public_repo scope also grants permission to read security events on public repositories only.

", "statusCodes": [ { "httpStatusCode": "200", @@ -211693,6 +212649,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -211701,6 +212665,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -211868,6 +212840,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -211947,6 +212926,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -212967,6 +214001,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -212975,6 +214017,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -213142,6 +214192,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -213221,6 +214278,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -213798,6 +214910,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -213806,6 +214926,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -213973,6 +215101,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -214052,6 +215187,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -321454,6 +322644,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -321462,6 +322660,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -321629,6 +322835,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -321708,6 +322921,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -322361,6 +323629,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -322369,6 +323645,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -322536,6 +323820,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -322615,6 +323906,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -323283,6 +324629,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -323291,6 +324645,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -323458,6 +324820,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -323537,6 +324906,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -324117,6 +325541,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -324125,6 +325557,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -324292,6 +325732,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -324371,6 +325818,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -325043,6 +326545,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -325051,6 +326561,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -325218,6 +326736,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -325297,6 +326822,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -325878,6 +327458,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -325886,6 +327474,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -326053,6 +327649,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -326132,6 +327735,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -326742,6 +328400,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -326750,6 +328416,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -326917,6 +328591,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -326996,6 +328677,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -327657,6 +329393,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -327665,6 +329409,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -327832,6 +329584,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -327911,6 +329670,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -330637,6 +332451,14 @@ "write" ] }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, "contents": { "type": "string", "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", @@ -330645,6 +332467,14 @@ "write" ] }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -330812,6 +332642,13 @@ "write" ] }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -330891,6 +332728,61 @@ "read", "write" ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 712bc9f08c..7bd8e350ff 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -39,5 +39,5 @@ ] } }, - "sha": "6922a6cfe785e1069e93d6e501805cf6e1891076" + "sha": "1fd29675070876e3278e71b47f4f2606601bc698" } \ No newline at end of file diff --git a/src/search/components/Search.tsx b/src/search/components/Search.tsx index f966ae0898..4f40718e2a 100644 --- a/src/search/components/Search.tsx +++ b/src/search/components/Search.tsx @@ -92,6 +92,7 @@ export function Search() { aria-label="Search" icon={SearchIcon} sx={{ borderTopLeftRadius: 'unset', borderBottomLeftRadius: 'unset' }} + type="submit" /> diff --git a/src/search/scripts/analyze-text.js b/src/search/scripts/analyze-text.js index 6e545739ae..17e6e0e122 100755 --- a/src/search/scripts/analyze-text.js +++ b/src/search/scripts/analyze-text.js @@ -8,7 +8,7 @@ // // Example: // -// ./src/search/scripts/analyze-text.js my words to tokenize +// npm run analyze-text "my words" to tokenize // // [end-readme] diff --git a/src/shielding/middleware/handle-invalid-query-strings.js b/src/shielding/middleware/handle-invalid-query-strings.js index 64a96680cf..7048dfab63 100644 --- a/src/shielding/middleware/handle-invalid-query-strings.js +++ b/src/shielding/middleware/handle-invalid-query-strings.js @@ -76,7 +76,17 @@ export default function handleInvalidQuerystrings(req, res, next) { const badKeylessQuery = rootHomePage && keys.length === 1 && keys[0].length === 8 && !query[keys[0]] - if (keys.length >= MAX_UNFAMILIAR_KEYS_REDIRECT || badKeylessQuery) { + // It's still a mystery why these requests happen but we've seen large + // number of requests that have a very long URL-encoded query string + // that starts with 'tool' but doesn't have any value. + // For example + // ?tool%25252525253Dvisualstudio%252525253D%2525252526tool%25252525... + // ...3Dvscode%2525253D%25252526tool%2525253Dvscode%25253D%252526tool... + // ...%25253Dvimneovim%253D%2526tool%253Djetbrains%3D%26tool%3Djetbrains=& + // Let's shield against those by removing them. + const badToolsQuery = keys.some((key) => key.startsWith('tool%') && !query[key]) + + if (keys.length >= MAX_UNFAMILIAR_KEYS_REDIRECT || badKeylessQuery || badToolsQuery) { defaultCacheControl(res) const sp = new URLSearchParams(query) keys.forEach((key) => sp.delete(key)) diff --git a/src/shielding/tests/invalid-querystrings.js b/src/shielding/tests/invalid-querystrings.js index e21f2e58ae..cdf9b95667 100644 --- a/src/shielding/tests/invalid-querystrings.js +++ b/src/shielding/tests/invalid-querystrings.js @@ -63,6 +63,14 @@ describe('invalid query strings', () => { expect(res.statusCode).toBe(302) expect(res.headers.location).toBe('/en') }) + + test('bad tool query string with Chinese URL-encoded characters', async () => { + const url = + '/?tool%25252525253Dvisualstudio%252525253D%2525252526tool%252525253Dvscode%2525253D%25252526tool%2525253Dvscode%25253D%252526tool%25253Dvimneovim%253D%2526tool%253Djetbrains%3D%26tool%3Djetbrains=&tool=azure_data_studio' + const res = await get(url) + expect(res.statusCode).toBe(302) + expect(res.headers.location).toBe('/?tool=azure_data_studio') + }) }) function randomCharacters(length) { diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 215e1a2e81..109a454fcc 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -15323,7 +15323,7 @@ }, "dependabot_alert": { "auto_dismissed": { - "descriptionHtml": "

A Dependabot alert was automatically closed.

", + "descriptionHtml": "

A Dependabot alert was automatically closed by a Dependabot auto-triage rule.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -15905,7 +15905,7 @@ "category": "dependabot_alert" }, "auto_reopened": { - "descriptionHtml": "

A Dependabot alert was automatically reopened.

", + "descriptionHtml": "

A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -86995,8 +86995,8 @@ }, "project_card": { "converted": { - "descriptionHtml": "

A note in a classic project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -87277,8 +87277,8 @@ "category": "project_card" }, "created": { - "descriptionHtml": "

A card was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -87536,8 +87536,8 @@ "category": "project_card" }, "deleted": { - "descriptionHtml": "

A card on a classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -87796,8 +87796,8 @@ "category": "project_card" }, "edited": { - "descriptionHtml": "

A note on a classic project was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note on a project (classic) was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -88078,8 +88078,8 @@ "category": "project_card" }, "moved": { - "descriptionHtml": "

A card on a classic project was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -88363,8 +88363,8 @@ }, "project": { "closed": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -88628,8 +88628,8 @@ "category": "project" }, "created": { - "descriptionHtml": "

A classic project was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -88893,8 +88893,8 @@ "category": "project" }, "deleted": { - "descriptionHtml": "

A classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89157,8 +89157,8 @@ "category": "project" }, "edited": { - "descriptionHtml": "

The name or description of a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name or description of a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89455,8 +89455,8 @@ "category": "project" }, "reopened": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89722,8 +89722,8 @@ }, "project_column": { "created": { - "descriptionHtml": "

A column was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89843,8 +89843,8 @@ "category": "project_column" }, "deleted": { - "descriptionHtml": "

A column was deleted from a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was deleted from a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89964,8 +89964,8 @@ "category": "project_column" }, "edited": { - "descriptionHtml": "

The name of a column on a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name of a column on a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -90107,8 +90107,8 @@ "category": "project_column" }, "moved": { - "descriptionHtml": "

A column was moved to a new position on a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was moved to a new position on a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -208914,7 +208914,7 @@ "security_advisory": { "published": { "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -209149,8 +209149,8 @@ "category": "security_advisory" }, "updated": { - "descriptionHtml": "

The metadata or description of a security advisory was changed, or the security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "descriptionHtml": "

The metadata or description of a security advisory was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -209386,7 +209386,7 @@ }, "withdrawn": { "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json index 7c0c8bf359..7a214a420d 100644 --- a/src/webhooks/data/ghae/schema.json +++ b/src/webhooks/data/ghae/schema.json @@ -14895,7 +14895,7 @@ }, "dependabot_alert": { "auto_dismissed": { - "descriptionHtml": "

A Dependabot alert was automatically closed.

", + "descriptionHtml": "

A Dependabot alert was automatically closed by a Dependabot auto-triage rule.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -15477,7 +15477,7 @@ "category": "dependabot_alert" }, "auto_reopened": { - "descriptionHtml": "

A Dependabot alert was automatically reopened.

", + "descriptionHtml": "

A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -81516,8 +81516,8 @@ }, "project_card": { "converted": { - "descriptionHtml": "

A note in a classic project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -81798,8 +81798,8 @@ "category": "project_card" }, "created": { - "descriptionHtml": "

A card was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -82057,8 +82057,8 @@ "category": "project_card" }, "deleted": { - "descriptionHtml": "

A card on a classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -82317,8 +82317,8 @@ "category": "project_card" }, "edited": { - "descriptionHtml": "

A note on a classic project was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note on a project (classic) was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -82599,8 +82599,8 @@ "category": "project_card" }, "moved": { - "descriptionHtml": "

A card on a classic project was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -82884,8 +82884,8 @@ }, "project": { "closed": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83149,8 +83149,8 @@ "category": "project" }, "created": { - "descriptionHtml": "

A classic project was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83414,8 +83414,8 @@ "category": "project" }, "deleted": { - "descriptionHtml": "

A classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83678,8 +83678,8 @@ "category": "project" }, "edited": { - "descriptionHtml": "

The name or description of a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name or description of a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83976,8 +83976,8 @@ "category": "project" }, "reopened": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84243,8 +84243,8 @@ }, "project_column": { "created": { - "descriptionHtml": "

A column was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84364,8 +84364,8 @@ "category": "project_column" }, "deleted": { - "descriptionHtml": "

A column was deleted from a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was deleted from a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84485,8 +84485,8 @@ "category": "project_column" }, "edited": { - "descriptionHtml": "

The name of a column on a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name of a column on a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84628,8 +84628,8 @@ "category": "project_column" }, "moved": { - "descriptionHtml": "

A column was moved to a new position on a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was moved to a new position on a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 677b005ac3..0ab045d841 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -15387,7 +15387,7 @@ }, "dependabot_alert": { "auto_dismissed": { - "descriptionHtml": "

A Dependabot alert was automatically closed.

", + "descriptionHtml": "

A Dependabot alert was automatically closed by a Dependabot auto-triage rule.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -15969,7 +15969,7 @@ "category": "dependabot_alert" }, "auto_reopened": { - "descriptionHtml": "

A Dependabot alert was automatically reopened.

", + "descriptionHtml": "

A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.

", "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

\n

Note: Webhook events for Dependabot alerts are currently in beta and subject to change.

", "bodyParameters": [ { @@ -87059,8 +87059,8 @@ }, "project_card": { "converted": { - "descriptionHtml": "

A note in a classic project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -87341,8 +87341,8 @@ "category": "project_card" }, "created": { - "descriptionHtml": "

A card was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -87600,8 +87600,8 @@ "category": "project_card" }, "deleted": { - "descriptionHtml": "

A card on a classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -87860,8 +87860,8 @@ "category": "project_card" }, "edited": { - "descriptionHtml": "

A note on a classic project was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note on a project (classic) was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -88142,8 +88142,8 @@ "category": "project_card" }, "moved": { - "descriptionHtml": "

A card on a classic project was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -88427,8 +88427,8 @@ }, "project": { "closed": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -88692,8 +88692,8 @@ "category": "project" }, "created": { - "descriptionHtml": "

A classic project was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -88957,8 +88957,8 @@ "category": "project" }, "deleted": { - "descriptionHtml": "

A classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89221,8 +89221,8 @@ "category": "project" }, "edited": { - "descriptionHtml": "

The name or description of a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name or description of a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89519,8 +89519,8 @@ "category": "project" }, "reopened": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89786,8 +89786,8 @@ }, "project_column": { "created": { - "descriptionHtml": "

A column was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -89907,8 +89907,8 @@ "category": "project_column" }, "deleted": { - "descriptionHtml": "

A column was deleted from a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was deleted from a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -90028,8 +90028,8 @@ "category": "project_column" }, "edited": { - "descriptionHtml": "

The name of a column on a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name of a column on a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -90171,8 +90171,8 @@ "category": "project_column" }, "moved": { - "descriptionHtml": "

A column was moved to a new position on a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was moved to a new position on a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -208978,7 +208978,7 @@ "security_advisory": { "published": { "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -209213,8 +209213,8 @@ "category": "security_advisory" }, "updated": { - "descriptionHtml": "

The metadata or description of a security advisory was changed, or the security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "descriptionHtml": "

The metadata or description of a security advisory was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -209450,7 +209450,7 @@ }, "withdrawn": { "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.10/schema.json b/src/webhooks/data/ghes-3.10/schema.json index 6edd629bdf..50c76058b3 100644 --- a/src/webhooks/data/ghes-3.10/schema.json +++ b/src/webhooks/data/ghes-3.10/schema.json @@ -83026,8 +83026,8 @@ }, "project_card": { "converted": { - "descriptionHtml": "

A note in a classic project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83308,8 +83308,8 @@ "category": "project_card" }, "created": { - "descriptionHtml": "

A card was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83567,8 +83567,8 @@ "category": "project_card" }, "deleted": { - "descriptionHtml": "

A card on a classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83827,8 +83827,8 @@ "category": "project_card" }, "edited": { - "descriptionHtml": "

A note on a classic project was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note on a project (classic) was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84109,8 +84109,8 @@ "category": "project_card" }, "moved": { - "descriptionHtml": "

A card on a classic project was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84394,8 +84394,8 @@ }, "project": { "closed": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84659,8 +84659,8 @@ "category": "project" }, "created": { - "descriptionHtml": "

A classic project was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84924,8 +84924,8 @@ "category": "project" }, "deleted": { - "descriptionHtml": "

A classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85188,8 +85188,8 @@ "category": "project" }, "edited": { - "descriptionHtml": "

The name or description of a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name or description of a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85486,8 +85486,8 @@ "category": "project" }, "reopened": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85753,8 +85753,8 @@ }, "project_column": { "created": { - "descriptionHtml": "

A column was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85874,8 +85874,8 @@ "category": "project_column" }, "deleted": { - "descriptionHtml": "

A column was deleted from a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was deleted from a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85995,8 +85995,8 @@ "category": "project_column" }, "edited": { - "descriptionHtml": "

The name of a column on a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name of a column on a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -86138,8 +86138,8 @@ "category": "project_column" }, "moved": { - "descriptionHtml": "

A column was moved to a new position on a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was moved to a new position on a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -191036,7 +191036,7 @@ "security_advisory": { "published": { "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -191271,8 +191271,8 @@ "category": "security_advisory" }, "updated": { - "descriptionHtml": "

The metadata or description of a security advisory was changed, or the security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "descriptionHtml": "

The metadata or description of a security advisory was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -191508,7 +191508,7 @@ }, "withdrawn": { "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.11/schema.json b/src/webhooks/data/ghes-3.11/schema.json index e358e43503..9fe3102094 100644 --- a/src/webhooks/data/ghes-3.11/schema.json +++ b/src/webhooks/data/ghes-3.11/schema.json @@ -83155,8 +83155,8 @@ }, "project_card": { "converted": { - "descriptionHtml": "

A note in a classic project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83437,8 +83437,8 @@ "category": "project_card" }, "created": { - "descriptionHtml": "

A card was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83696,8 +83696,8 @@ "category": "project_card" }, "deleted": { - "descriptionHtml": "

A card on a classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -83956,8 +83956,8 @@ "category": "project_card" }, "edited": { - "descriptionHtml": "

A note on a classic project was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note on a project (classic) was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84238,8 +84238,8 @@ "category": "project_card" }, "moved": { - "descriptionHtml": "

A card on a classic project was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84523,8 +84523,8 @@ }, "project": { "closed": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -84788,8 +84788,8 @@ "category": "project" }, "created": { - "descriptionHtml": "

A classic project was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85053,8 +85053,8 @@ "category": "project" }, "deleted": { - "descriptionHtml": "

A classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85317,8 +85317,8 @@ "category": "project" }, "edited": { - "descriptionHtml": "

The name or description of a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name or description of a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85615,8 +85615,8 @@ "category": "project" }, "reopened": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -85882,8 +85882,8 @@ }, "project_column": { "created": { - "descriptionHtml": "

A column was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -86003,8 +86003,8 @@ "category": "project_column" }, "deleted": { - "descriptionHtml": "

A column was deleted from a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was deleted from a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -86124,8 +86124,8 @@ "category": "project_column" }, "edited": { - "descriptionHtml": "

The name of a column on a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name of a column on a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -86267,8 +86267,8 @@ "category": "project_column" }, "moved": { - "descriptionHtml": "

A column was moved to a new position on a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was moved to a new position on a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -195690,7 +195690,7 @@ "security_advisory": { "published": { "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -195925,8 +195925,8 @@ "category": "security_advisory" }, "updated": { - "descriptionHtml": "

The metadata or description of a security advisory was changed, or the security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "descriptionHtml": "

The metadata or description of a security advisory was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -196162,7 +196162,7 @@ }, "withdrawn": { "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.7/schema.json b/src/webhooks/data/ghes-3.7/schema.json index aee1efe2ab..0ae4799e2d 100644 --- a/src/webhooks/data/ghes-3.7/schema.json +++ b/src/webhooks/data/ghes-3.7/schema.json @@ -76438,8 +76438,8 @@ }, "project_card": { "converted": { - "descriptionHtml": "

A note in a classic project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -76720,8 +76720,8 @@ "category": "project_card" }, "created": { - "descriptionHtml": "

A card was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -76979,8 +76979,8 @@ "category": "project_card" }, "deleted": { - "descriptionHtml": "

A card on a classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -77239,8 +77239,8 @@ "category": "project_card" }, "edited": { - "descriptionHtml": "

A note on a classic project was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note on a project (classic) was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -77521,8 +77521,8 @@ "category": "project_card" }, "moved": { - "descriptionHtml": "

A card on a classic project was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -77806,8 +77806,8 @@ }, "project": { "closed": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78071,8 +78071,8 @@ "category": "project" }, "created": { - "descriptionHtml": "

A classic project was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78336,8 +78336,8 @@ "category": "project" }, "deleted": { - "descriptionHtml": "

A classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78600,8 +78600,8 @@ "category": "project" }, "edited": { - "descriptionHtml": "

The name or description of a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name or description of a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78898,8 +78898,8 @@ "category": "project" }, "reopened": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79165,8 +79165,8 @@ }, "project_column": { "created": { - "descriptionHtml": "

A column was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79286,8 +79286,8 @@ "category": "project_column" }, "deleted": { - "descriptionHtml": "

A column was deleted from a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was deleted from a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79407,8 +79407,8 @@ "category": "project_column" }, "edited": { - "descriptionHtml": "

The name of a column on a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name of a column on a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79550,8 +79550,8 @@ "category": "project_column" }, "moved": { - "descriptionHtml": "

A column was moved to a new position on a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was moved to a new position on a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -181725,7 +181725,7 @@ "security_advisory": { "published": { "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -181960,8 +181960,8 @@ "category": "security_advisory" }, "updated": { - "descriptionHtml": "

The metadata or description of a security advisory was changed, or the security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "descriptionHtml": "

The metadata or description of a security advisory was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -182197,7 +182197,7 @@ }, "withdrawn": { "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json index ff1b0ca103..5da55d5eea 100644 --- a/src/webhooks/data/ghes-3.8/schema.json +++ b/src/webhooks/data/ghes-3.8/schema.json @@ -76438,8 +76438,8 @@ }, "project_card": { "converted": { - "descriptionHtml": "

A note in a classic project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -76720,8 +76720,8 @@ "category": "project_card" }, "created": { - "descriptionHtml": "

A card was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -76979,8 +76979,8 @@ "category": "project_card" }, "deleted": { - "descriptionHtml": "

A card on a classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -77239,8 +77239,8 @@ "category": "project_card" }, "edited": { - "descriptionHtml": "

A note on a classic project was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note on a project (classic) was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -77521,8 +77521,8 @@ "category": "project_card" }, "moved": { - "descriptionHtml": "

A card on a classic project was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -77806,8 +77806,8 @@ }, "project": { "closed": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78071,8 +78071,8 @@ "category": "project" }, "created": { - "descriptionHtml": "

A classic project was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78336,8 +78336,8 @@ "category": "project" }, "deleted": { - "descriptionHtml": "

A classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78600,8 +78600,8 @@ "category": "project" }, "edited": { - "descriptionHtml": "

The name or description of a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name or description of a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78898,8 +78898,8 @@ "category": "project" }, "reopened": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79165,8 +79165,8 @@ }, "project_column": { "created": { - "descriptionHtml": "

A column was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79286,8 +79286,8 @@ "category": "project_column" }, "deleted": { - "descriptionHtml": "

A column was deleted from a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was deleted from a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79407,8 +79407,8 @@ "category": "project_column" }, "edited": { - "descriptionHtml": "

The name of a column on a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name of a column on a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79550,8 +79550,8 @@ "category": "project_column" }, "moved": { - "descriptionHtml": "

A column was moved to a new position on a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was moved to a new position on a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -181761,7 +181761,7 @@ "security_advisory": { "published": { "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -181996,8 +181996,8 @@ "category": "security_advisory" }, "updated": { - "descriptionHtml": "

The metadata or description of a security advisory was changed, or the security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "descriptionHtml": "

The metadata or description of a security advisory was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -182233,7 +182233,7 @@ }, "withdrawn": { "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/data/ghes-3.9/schema.json b/src/webhooks/data/ghes-3.9/schema.json index 1f9f4bf4a0..735a516fd0 100644 --- a/src/webhooks/data/ghes-3.9/schema.json +++ b/src/webhooks/data/ghes-3.9/schema.json @@ -77808,8 +77808,8 @@ }, "project_card": { "converted": { - "descriptionHtml": "

A note in a classic project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78090,8 +78090,8 @@ "category": "project_card" }, "created": { - "descriptionHtml": "

A card was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78349,8 +78349,8 @@ "category": "project_card" }, "deleted": { - "descriptionHtml": "

A card on a classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78609,8 +78609,8 @@ "category": "project_card" }, "edited": { - "descriptionHtml": "

A note on a classic project was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A note on a project (classic) was edited.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -78891,8 +78891,8 @@ "category": "project_card" }, "moved": { - "descriptionHtml": "

A card on a classic project was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79176,8 +79176,8 @@ }, "project": { "closed": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79441,8 +79441,8 @@ "category": "project" }, "created": { - "descriptionHtml": "

A classic project was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was created.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79706,8 +79706,8 @@ "category": "project" }, "deleted": { - "descriptionHtml": "

A classic project was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was deleted.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -79970,8 +79970,8 @@ "category": "project" }, "edited": { - "descriptionHtml": "

The name or description of a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name or description of a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -80268,8 +80268,8 @@ "category": "project" }, "reopened": { - "descriptionHtml": "

A classic project was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A project (classic) was closed.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -80535,8 +80535,8 @@ }, "project_column": { "created": { - "descriptionHtml": "

A column was added to a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was added to a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -80656,8 +80656,8 @@ "category": "project_column" }, "deleted": { - "descriptionHtml": "

A column was deleted from a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was deleted from a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -80777,8 +80777,8 @@ "category": "project_column" }, "edited": { - "descriptionHtml": "

The name of a column on a classic project was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

The name of a column on a project (classic) was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -80920,8 +80920,8 @@ "category": "project_column" }, "moved": { - "descriptionHtml": "

A column was moved to a new position on a classic project.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "descriptionHtml": "

A column was moved to a new position on a project (classic).

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -185788,7 +185788,7 @@ "security_advisory": { "published": { "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -186023,8 +186023,8 @@ "category": "security_advisory" }, "updated": { - "descriptionHtml": "

The metadata or description of a security advisory was changed, or the security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "descriptionHtml": "

The metadata or description of a security advisory was changed.

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -186260,7 +186260,7 @@ }, "withdrawn": { "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 90eac32a5c..ab65b89815 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "6922a6cfe785e1069e93d6e501805cf6e1891076" + "sha": "1fd29675070876e3278e71b47f4f2606601bc698" } \ No newline at end of file diff --git a/src/workflows/delete-orphan-translation-files.ts b/src/workflows/delete-orphan-translation-files.ts new file mode 100644 index 0000000000..7b52075c33 --- /dev/null +++ b/src/workflows/delete-orphan-translation-files.ts @@ -0,0 +1,84 @@ +#!/usr/bin/env node + +/** + * This script will delete files from a translation repo of files that + * only exist there and not "here". Here being the docs repo. + * It will only look at *.md files in `content/` and + * only look at *.md and *.yml files in `data/`. + * + * If executed with `--dry-run` it will only print what it would delete. + * + * To avoid deleting too many files at once, which can make PRs too big, + * there's a `--max ` options which is defaulted to 100. + * + * To run this locally, check out a translation repo and then run it like this: + * + * git clone git@github.com:github/docs-internal.ja-jp.git /tmp/docs-internal.ja-jp + * npm run delete-orphan-translation-files -- /tmp/docs-internal.ja-jp + * + * Note that it doesn't execute `git rm ...` for you. Just regular + * file deletion. It's up to you now to commit and push. + */ + +import fs from 'fs' +import path from 'path' + +import { program } from 'commander' +import walkFiles from 'src/workflows/walk-files.js' +import { ROOT } from 'src/frame/lib/constants.js' + +program + .description('Delete orphan translation files') + .option('--dry-run', 'Just print what it would delete') + .option('--max ', 'Max. number of files to delete', '100') + .argument('', 'path to repo root') + .parse(process.argv) + +const opts = program.opts() + +type Options = { + dryRun: boolean + max: number +} +main(program.args[0], { + dryRun: Boolean(opts.dryRun), + max: parseInt(opts.max, 10), +}) + +function main(root: string, options: Options) { + let deleted = 0 + let countInSync = 0 + let countOrphan = 0 + for (const filePath of getContentAndDataFiles(root)) { + const relPath = path.relative(root, filePath) + if (!fs.existsSync(path.join(ROOT, relPath))) { + countOrphan++ + if (deleted < options.max) { + if (options.dryRun) { + console.log('DELETE', filePath) + } else { + fs.rmSync(filePath) + console.log('DELETED', filePath) + } + deleted++ + + if (deleted >= options.max) { + console.log(`Max. number (${options.max}) of files deleted`) + } + } + } else { + countInSync++ + } + } + console.log(`In conclusion, deleted ${deleted.toLocaleString()} files.`) + console.log( + `There are ${countInSync.toLocaleString()} files in sync and ${countOrphan.toLocaleString()} orphan files in ${root}`, + ) +} + +function getContentAndDataFiles(root: string) { + return [ + ...walkFiles(path.join(root, 'content'), ['.md']), + ...walkFiles(path.join(root, 'data'), ['.md', '.yml']), + ] +} diff --git a/src/workflows/docker-compose.prod.tmpl.yaml b/src/workflows/docker-compose.prod.tmpl.yaml index b4a1ea8e5f..8d48940906 100644 --- a/src/workflows/docker-compose.prod.tmpl.yaml +++ b/src/workflows/docker-compose.prod.tmpl.yaml @@ -30,3 +30,4 @@ services: DD_API_KEY: ${DD_API_KEY} DD_AGENT_HOST: datadog-agent DD_HISTOGRAM_PERCENTILES: 0.99 0.95 0.50 + DD_HOSTNAME_TRUST_UTS_NAMESPACE: true diff --git a/src/workflows/projects.js b/src/workflows/projects.js index fb04379d75..63deb83d99 100644 --- a/src/workflows/projects.js +++ b/src/workflows/projects.js @@ -84,6 +84,10 @@ export async function addItemToProject(item, project) { // Given a GitHub login, returns a bool indicating // whether the login is part of the docs team export async function isDocsTeamMember(login) { + // Returns true if login is docs-bot, to bypass the checks and make PRs opened by docs-bot be treated as though they were made by a docs team member + if (login === 'docs-bot') { + return true + } // Get all members of the docs team const data = await graphql( `