diff --git a/.github/workflows/autoupdate-branch.yml b/.github/workflows/autoupdate-branch.yml index 04347e9995..281ad5363c 100644 --- a/.github/workflows/autoupdate-branch.yml +++ b/.github/workflows/autoupdate-branch.yml @@ -40,7 +40,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repo content - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/azure-preview-env-deploy.yml b/.github/workflows/azure-preview-env-deploy.yml index 892e0ebbc6..273776088c 100644 --- a/.github/workflows/azure-preview-env-deploy.yml +++ b/.github/workflows/azure-preview-env-deploy.yml @@ -79,7 +79,7 @@ jobs: - if: ${{ env.IS_PUBLIC_BUILD == 'true' }} name: Check out main branch - uses: actions/checkout@1e204e9a9253d643386038d443f96446fa156a97 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: ref: 'main' persist-credentials: 'false' @@ -87,7 +87,7 @@ jobs: - if: ${{ env.IS_INTERNAL_BUILD == 'true' }} name: Check out PR code - uses: actions/checkout@1e204e9a9253d643386038d443f96446fa156a97 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: ref: ${{ env.COMMIT_REF }} # To prevent issues with cloning early access content later @@ -139,7 +139,7 @@ jobs: - if: ${{ env.IS_INTERNAL_BUILD == 'true' }} name: Clone docs-early-access - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: repository: github/docs-early-access token: ${{ secrets.DOCUBOT_REPO_PAT }} @@ -152,7 +152,7 @@ jobs: - if: ${{ env.IS_PUBLIC_BUILD == 'true' }} name: Check out user code to temp directory - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: path: ./user-code ref: ${{ env.COMMIT_REF }} diff --git a/.github/workflows/azure-preview-env-destroy.yml b/.github/workflows/azure-preview-env-destroy.yml index 0a012a4403..be47225893 100644 --- a/.github/workflows/azure-preview-env-destroy.yml +++ b/.github/workflows/azure-preview-env-destroy.yml @@ -39,7 +39,7 @@ jobs: creds: ${{ secrets.NONPROD_AZURE_CREDENTIALS }} - name: Check out repo - uses: actions/checkout@1e204e9a9253d643386038d443f96446fa156a97 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Get preview app info env: diff --git a/.github/workflows/azure-prod-build-deploy.yml b/.github/workflows/azure-prod-build-deploy.yml index 2a10b09863..27bdd28f94 100644 --- a/.github/workflows/azure-prod-build-deploy.yml +++ b/.github/workflows/azure-prod-build-deploy.yml @@ -49,7 +49,7 @@ jobs: uses: docker/setup-buildx-action@94ab11c41e45d028884a99163086648e898eed25 - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: ref: ${{ github.sha }} # To prevent issues with cloning early access content later @@ -66,7 +66,7 @@ jobs: cache: npm - name: Clone docs-early-access - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: repository: github/docs-early-access token: ${{ secrets.DOCUBOT_REPO_PAT }} diff --git a/.github/workflows/browser-test.yml b/.github/workflows/browser-test.yml index 14b0e3de1b..60b728d8e4 100644 --- a/.github/workflows/browser-test.yml +++ b/.github/workflows/browser-test.yml @@ -32,7 +32,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: lfs: true @@ -54,7 +54,7 @@ jobs: run: npm ci --include=optional - name: Cache nextjs build - uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed + uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09 with: path: .next/cache key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} diff --git a/.github/workflows/check-all-english-links.yml b/.github/workflows/check-all-english-links.yml index a405461ff2..cc163d320e 100644 --- a/.github/workflows/check-all-english-links.yml +++ b/.github/workflows/check-all-english-links.yml @@ -26,7 +26,7 @@ jobs: REPORT_REPOSITORY: github/docs-content steps: - name: Check out repo's default branch - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 with: @@ -35,7 +35,7 @@ jobs: - name: npm ci run: npm ci - name: Cache nextjs build - uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed + uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09 with: path: .next/cache key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} diff --git a/.github/workflows/check-broken-links-github-github.yml b/.github/workflows/check-broken-links-github-github.yml index 902b396c90..020039f105 100644 --- a/.github/workflows/check-broken-links-github-github.yml +++ b/.github/workflows/check-broken-links-github-github.yml @@ -39,7 +39,7 @@ jobs: exit 1 # prevents further steps from running - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 @@ -50,9 +50,20 @@ jobs: - name: Install Node.js dependencies run: npm ci - - name: Run broken github/github link check + - name: Build server + run: npm run build + + - name: Start server in the background env: - WAF_TOKEN: ${{ secrets.WAF_TOKEN }} + NODE_ENV: production + PORT: 4000 + run: | + + node server.mjs & + sleep 5 + curl --retry-connrefused --retry 3 -I http://localhost:4000/ + + - name: Run broken github/github link check run: | script/check-github-github-links.js > broken_github_github_links.md diff --git a/.github/workflows/code-lint.yml b/.github/workflows/code-lint.yml index ac204f6484..1aa9279a2a 100644 --- a/.github/workflows/code-lint.yml +++ b/.github/workflows/code-lint.yml @@ -34,7 +34,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 80c9b4cc72..04009a7f10 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -30,7 +30,7 @@ jobs: if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' runs-on: ubuntu-latest steps: - - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + - uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - uses: github/codeql-action/init@1ed1437484560351c5be56cf73a48a279d116b78 with: languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!) diff --git a/.github/workflows/content-changes-table-comment.yml b/.github/workflows/content-changes-table-comment.yml index 2584ca9cf9..08ded81b73 100644 --- a/.github/workflows/content-changes-table-comment.yml +++ b/.github/workflows/content-changes-table-comment.yml @@ -49,7 +49,7 @@ jobs: PR_NUMBER: ${{ github.event.pull_request.number }} steps: - name: check out repo content - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Get preview app info env: @@ -74,7 +74,7 @@ jobs: run: .github/actions-scripts/content-changes-table-comment.js - name: Find content directory changes comment - uses: peter-evans/find-comment@d2dae40ed151c634e4189471272b57e76ec19ba8 + uses: peter-evans/find-comment@1769778a0c5bd330272d749d12c036d65e70d39d id: findComment with: issue-number: ${{ github.event.pull_request.number }} diff --git a/.github/workflows/create-translation-batch-pr.yml b/.github/workflows/create-translation-batch-pr.yml index 3aa683d75b..a836bca6ad 100644 --- a/.github/workflows/create-translation-batch-pr.yml +++ b/.github/workflows/create-translation-batch-pr.yml @@ -55,7 +55,7 @@ jobs: - run: git config --global user.email "67483024+docubot@users.noreply.github.com" - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: fetch-depth: 0 lfs: true diff --git a/.github/workflows/crowdin-cleanup.yml b/.github/workflows/crowdin-cleanup.yml index d378461d77..377c9e4bac 100644 --- a/.github/workflows/crowdin-cleanup.yml +++ b/.github/workflows/crowdin-cleanup.yml @@ -26,7 +26,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/docs-review-collect.yml b/.github/workflows/docs-review-collect.yml index ee6733392b..821a86108c 100644 --- a/.github/workflows/docs-review-collect.yml +++ b/.github/workflows/docs-review-collect.yml @@ -20,7 +20,7 @@ jobs: steps: - name: Check out repo content - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/enterprise-dates.yml b/.github/workflows/enterprise-dates.yml index 25394c9b74..b970978fa2 100644 --- a/.github/workflows/enterprise-dates.yml +++ b/.github/workflows/enterprise-dates.yml @@ -36,7 +36,7 @@ jobs: exit 1 # prevents further steps from running - name: Checkout repository code - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/enterprise-release-sync-search-index.yml b/.github/workflows/enterprise-release-sync-search-index.yml index 3a35457272..e053c74f1c 100644 --- a/.github/workflows/enterprise-release-sync-search-index.yml +++ b/.github/workflows/enterprise-release-sync-search-index.yml @@ -44,7 +44,7 @@ jobs: runs-on: ubuntu-latest steps: - name: checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: ref: ${{ github.head_ref }} token: ${{ secrets.DOCUBOT_REPO_PAT }} @@ -63,7 +63,7 @@ jobs: run: $GITHUB_WORKSPACE/.github/actions-scripts/enterprise-search-label.js - name: Cache nextjs build - uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed + uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09 with: path: .next/cache key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} diff --git a/.github/workflows/link-check-all.yml b/.github/workflows/link-check-all.yml index eeec776e09..23817594c8 100644 --- a/.github/workflows/link-check-all.yml +++ b/.github/workflows/link-check-all.yml @@ -27,7 +27,7 @@ jobs: runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/main-preview-docker-cache.yml b/.github/workflows/main-preview-docker-cache.yml index 1522e9a415..87f4c9bc46 100644 --- a/.github/workflows/main-preview-docker-cache.yml +++ b/.github/workflows/main-preview-docker-cache.yml @@ -45,7 +45,7 @@ jobs: uses: docker/setup-buildx-action@94ab11c41e45d028884a99163086648e898eed25 - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: # To prevent issues with cloning early access content later persist-credentials: 'false' @@ -56,7 +56,7 @@ jobs: - if: ${{ env.ENABLE_EARLY_ACCESS }} name: Clone docs-early-access - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: repository: github/docs-early-access token: ${{ secrets.DOCUBOT_REPO_PAT }} diff --git a/.github/workflows/manually-purge-fastly.yml b/.github/workflows/manually-purge-fastly.yml index e4db1b03f4..af897aa857 100644 --- a/.github/workflows/manually-purge-fastly.yml +++ b/.github/workflows/manually-purge-fastly.yml @@ -16,7 +16,7 @@ jobs: steps: - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Install dependencies run: npm ci diff --git a/.github/workflows/open-enterprise-issue.yml b/.github/workflows/open-enterprise-issue.yml index 2e0dcac1cf..17229bf0d0 100644 --- a/.github/workflows/open-enterprise-issue.yml +++ b/.github/workflows/open-enterprise-issue.yml @@ -19,7 +19,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout repository code - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/openapi-decorate.yml b/.github/workflows/openapi-decorate.yml index a77301d393..67e67cac58 100644 --- a/.github/workflows/openapi-decorate.yml +++ b/.github/workflows/openapi-decorate.yml @@ -31,7 +31,7 @@ jobs: add-labels: 'github-openapi-bot' - name: Checkout repository code - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: # actions/checkout by default will leave you in a detached head state # so we need to specify the PR head ref explicitly since we're making diff --git a/.github/workflows/openapi-schema-check.yml b/.github/workflows/openapi-schema-check.yml index 128adec955..68bcf982af 100644 --- a/.github/workflows/openapi-schema-check.yml +++ b/.github/workflows/openapi-schema-check.yml @@ -39,7 +39,7 @@ jobs: runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }} steps: - name: Checkout repository code - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/optimize-images.yml b/.github/workflows/optimize-images.yml index 336ba86684..3db30c6aa3 100644 --- a/.github/workflows/optimize-images.yml +++ b/.github/workflows/optimize-images.yml @@ -21,7 +21,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repo on head ref - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: ref: ${{ github.head_ref }} # Need to specify a PAT here because otherwise GITHUB_TOKEN is used diff --git a/.github/workflows/orphaned-assets-check.yml b/.github/workflows/orphaned-assets-check.yml index 18204888de..275dec0c53 100644 --- a/.github/workflows/orphaned-assets-check.yml +++ b/.github/workflows/orphaned-assets-check.yml @@ -18,7 +18,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: # Using a PAT is necessary so that the new commit will trigger the # CI in the PR. (Events from GITHUB_TOKEN don't trigger new workflows.) diff --git a/.github/workflows/os-ready-for-review.yml b/.github/workflows/os-ready-for-review.yml index 673e11627c..c1036f0430 100644 --- a/.github/workflows/os-ready-for-review.yml +++ b/.github/workflows/os-ready-for-review.yml @@ -44,7 +44,7 @@ jobs: exit 1 - name: Check out repo content - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/pa11y.yml b/.github/workflows/pa11y.yml index 8babbfa8d8..918d1f9e47 100644 --- a/.github/workflows/pa11y.yml +++ b/.github/workflows/pa11y.yml @@ -18,7 +18,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 @@ -30,7 +30,7 @@ jobs: run: npm ci --include=optional - name: Cache nextjs build - uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed + uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09 with: path: .next/cache key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} diff --git a/.github/workflows/package-lock-lint.yml b/.github/workflows/package-lock-lint.yml index c045acfdc1..5c652e8412 100644 --- a/.github/workflows/package-lock-lint.yml +++ b/.github/workflows/package-lock-lint.yml @@ -24,7 +24,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/ready-for-doc-review.yml b/.github/workflows/ready-for-doc-review.yml index 416ade5841..049aba3ef0 100644 --- a/.github/workflows/ready-for-doc-review.yml +++ b/.github/workflows/ready-for-doc-review.yml @@ -20,7 +20,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repo content - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 diff --git a/.github/workflows/remove-unused-assets.yml b/.github/workflows/remove-unused-assets.yml index 5cdbec0b9f..1b70808363 100644 --- a/.github/workflows/remove-unused-assets.yml +++ b/.github/workflows/remove-unused-assets.yml @@ -25,7 +25,7 @@ jobs: echo 'The repo is currently frozen! Exiting this workflow.' exit 1 # prevents further steps from running - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 with: diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index 50ff2272ec..1575e54d84 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -98,7 +98,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 # Set up npm and run npm ci to run husky to get githooks for LFS - name: Setup node diff --git a/.github/workflows/site-policy-sync.yml b/.github/workflows/site-policy-sync.yml index db2fda616f..0e73ed05ea 100644 --- a/.github/workflows/site-policy-sync.yml +++ b/.github/workflows/site-policy-sync.yml @@ -26,10 +26,10 @@ jobs: runs-on: ubuntu-latest steps: - name: checkout docs-internal - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: checkout public site-policy - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: repository: github/site-policy token: ${{ secrets.API_TOKEN_SITEPOLICY }} diff --git a/.github/workflows/sync-search-indices.yml b/.github/workflows/sync-search-indices.yml index 48c92a54d6..3074e2f7fe 100644 --- a/.github/workflows/sync-search-indices.yml +++ b/.github/workflows/sync-search-indices.yml @@ -51,7 +51,7 @@ jobs: exit 1 # prevents further steps from running # Check out internal docs repository - name: checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: token: ${{ secrets.DOCS_BOT_FR }} @@ -65,7 +65,7 @@ jobs: run: npm ci - name: Cache nextjs build - uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed + uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09 with: path: .next/cache key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} diff --git a/.github/workflows/sync-search-pr.yml b/.github/workflows/sync-search-pr.yml index 339dec8714..b5e39d791f 100644 --- a/.github/workflows/sync-search-pr.yml +++ b/.github/workflows/sync-search-pr.yml @@ -26,7 +26,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 @@ -38,7 +38,7 @@ jobs: run: npm ci - name: Cache nextjs build - uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed + uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09 with: path: .next/cache key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 36c5a5c3c2..0fc88729c8 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -46,7 +46,7 @@ jobs: # Each of these ifs needs to be repeated at each step to make sure the required check still runs # Even if if doesn't do anything - name: Check out repo - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: # Not all test suites need the LFS files. So instead, we opt to # NOT clone them initially and instead, include them manually @@ -87,7 +87,7 @@ jobs: - name: Check out docs-early-access too, if internal repo if: ${{ github.repository == 'github/docs-internal' }} - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: repository: github/docs-early-access token: ${{ secrets.DOCUBOT_REPO_PAT }} @@ -132,7 +132,7 @@ jobs: run: npm ci - name: Cache nextjs build - uses: actions/cache@937d24475381cd9c75ae6db12cb4e79714b926ed + uses: actions/cache@48af2dc4a9e8278b89d7fa154b955c30c6aaab09 with: path: .next/cache key: ${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }} diff --git a/.github/workflows/triage-unallowed-internal-changes.yml b/.github/workflows/triage-unallowed-internal-changes.yml index 6908831f81..57641880dd 100644 --- a/.github/workflows/triage-unallowed-internal-changes.yml +++ b/.github/workflows/triage-unallowed-internal-changes.yml @@ -55,7 +55,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 with: ref: ${{ github.head_ref }} token: ${{ secrets.DOCUBOT_REPO_PAT }} diff --git a/.github/workflows/update-graphql-files.yml b/.github/workflows/update-graphql-files.yml index 9e416c99f8..c545d1c6dc 100644 --- a/.github/workflows/update-graphql-files.yml +++ b/.github/workflows/update-graphql-files.yml @@ -32,7 +32,7 @@ jobs: echo 'The repo is currently frozen! Exiting this workflow.' exit 1 # prevents further steps from running - name: Checkout - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 + uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748 - name: Setup Node uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 with: diff --git a/assets/images/help/organizations/customize_pins_link.png b/assets/images/help/organizations/customize_pins_link.png new file mode 100644 index 0000000000..865f5d39d8 Binary files /dev/null and b/assets/images/help/organizations/customize_pins_link.png differ diff --git a/assets/images/help/organizations/new_organization_page.png b/assets/images/help/organizations/new_organization_page.png new file mode 100644 index 0000000000..56779be876 Binary files /dev/null and b/assets/images/help/organizations/new_organization_page.png differ diff --git a/assets/images/help/organizations/org_member_readme.png b/assets/images/help/organizations/org_member_readme.png new file mode 100644 index 0000000000..c5736a3509 Binary files /dev/null and b/assets/images/help/organizations/org_member_readme.png differ diff --git a/assets/images/help/organizations/org_profile_view.png b/assets/images/help/organizations/org_profile_view.png new file mode 100644 index 0000000000..e2e1b91d69 Binary files /dev/null and b/assets/images/help/organizations/org_profile_view.png differ diff --git a/assets/images/help/organizations/org_public_readme.png b/assets/images/help/organizations/org_public_readme.png new file mode 100644 index 0000000000..c802039a5c Binary files /dev/null and b/assets/images/help/organizations/org_public_readme.png differ diff --git a/assets/images/help/organizations/pin_repositories_link.png b/assets/images/help/organizations/pin_repositories_link.png new file mode 100644 index 0000000000..bea964d020 Binary files /dev/null and b/assets/images/help/organizations/pin_repositories_link.png differ diff --git a/assets/images/help/organizations/pinned_repo_dialog.png b/assets/images/help/organizations/pinned_repo_dialog.png new file mode 100644 index 0000000000..ec696d1004 Binary files /dev/null and b/assets/images/help/organizations/pinned_repo_dialog.png differ diff --git a/components/DefaultLayout.tsx b/components/DefaultLayout.tsx index cd02585a19..f8de64b98a 100644 --- a/components/DefaultLayout.tsx +++ b/components/DefaultLayout.tsx @@ -88,10 +88,7 @@ export const DefaultLayout = (props: Props) => { {/* Need to set an explicit height for sticky elements since we also set overflow to auto */} -
+
diff --git a/components/article/ClientSideHighlightJS.tsx b/components/article/ClientSideHighlightJS.tsx index c14ec0fec3..c5b7bab282 100644 --- a/components/article/ClientSideHighlightJS.tsx +++ b/components/article/ClientSideHighlightJS.tsx @@ -26,7 +26,7 @@ const SUPPORTED_LANGUAGES = ['json', 'javascript', 'curl'] // // const CODE_ELEMENTS_PARENT_SELECTOR = '[data-highlight]' -const CODE_SELECTOR = 'pre code' +const CODE_SELECTOR = 'div code' || 'pre code' export default function ClientSideHighlightJS() { const { asPath } = useRouter() diff --git a/components/context/RestContext.tsx b/components/context/RestContext.tsx new file mode 100644 index 0000000000..a579403656 --- /dev/null +++ b/components/context/RestContext.tsx @@ -0,0 +1,37 @@ +import { createContext, useContext } from 'react' + +export type MiniTocItem = { + platform: string + contents: string & { title: string; href: string } + items?: MiniTocItem[] +} + +export type RestContextT = { + title: string + intro: string + renderedPage: string | JSX.Element[] + miniTocItems: Array +} + +export const RestContext = createContext(null) + +export const useRestContext = (): RestContextT => { + const context = useContext(RestContext) + + if (!context) { + throw new Error('"useRestContext" may only be used inside "RestContext.Provider"') + } + + return context +} + +export const getRestContextFromRequest = (req: any): RestContextT => { + const page = req.context.page + + return { + title: page.titlePlainText, + intro: page.intro, + renderedPage: req.context.renderedPage || '', + miniTocItems: req.context.miniTocItems || [], + } +} diff --git a/components/landing/TocLanding.tsx b/components/landing/TocLanding.tsx index 9d02636d99..3fb37a5682 100644 --- a/components/landing/TocLanding.tsx +++ b/components/landing/TocLanding.tsx @@ -1,3 +1,7 @@ +import { useState, useEffect } from 'react' +import { useRouter } from 'next/router' +import dynamic from 'next/dynamic' + import { DefaultLayout } from 'components/DefaultLayout' import { TableOfContents } from 'components/landing/TableOfContents' import { useTocLandingContext } from 'components/context/TocLandingContext' @@ -10,6 +14,13 @@ import { Callout } from 'components/ui/Callout' import { Lead } from 'components/ui/Lead' import { LearningTrackNav } from 'components/article/LearningTrackNav' +const ClientSideRedirectExceptions = dynamic( + () => import('components/article/ClientsideRedirectExceptions'), + { + ssr: false, + } +) + export const TocLanding = () => { const { title, @@ -23,8 +34,38 @@ export const TocLanding = () => { } = useTocLandingContext() const { t } = useTranslation('toc') + const { asPath } = useRouter() + // We have some one-off redirects for rest api docs + // currently those are limited to the repos page, but + // that will grow soon as we restructure the rest api docs. + // This is a workaround to updating the hardcoded links + // directly in the REST API code in a separate repo, which + // requires many file changes and teams to sign off. + // While the organization is turbulent, we can do this. + // Once it's more settled, we can refactor the rest api code + // to leverage the OpenAPI urls rather than hardcoded urls. + // The code below determines if we should bother loading this redirecting + // component at all. + // The reason this isn't done at the server-level is because there you + // can't possibly access the URL hash. That's only known in client-side + // code. + const [loadClientsideRedirectExceptions, setLoadClientsideRedirectExceptions] = useState(false) + useEffect(() => { + const { hash } = window.location + // Today, Jan 2022, it's known explicitly what the pathname. + // In the future there might be more. + // Hopefully, we can some day delete all of this and no longer + // be dependent on the URL hash to do the redirect. + if (hash && asPath.startsWith('/rest')) { + setLoadClientsideRedirectExceptions(true) + } + }, []) + return ( + {/* Doesn't matter *where* this is included because it will + never render anything. It always just return null. */} + {loadClientsideRedirectExceptions && }
{title} diff --git a/components/page-header/Header.tsx b/components/page-header/Header.tsx index 612cca6965..05d57fbb9a 100644 --- a/components/page-header/Header.tsx +++ b/components/page-header/Header.tsx @@ -52,7 +52,7 @@ export const Header = () => { return (
diff --git a/components/page-header/RestBanner.tsx b/components/page-header/RestBanner.tsx index 89f916f047..cc2ea6be56 100644 --- a/components/page-header/RestBanner.tsx +++ b/components/page-header/RestBanner.tsx @@ -43,7 +43,7 @@ export const RestBanner = () => { > const newRestPagesText = pages.map((page, i) => [ - + {restRepoCategoryExceptionsTitles[page]} {i < pages.length - 1 && ', '} @@ -60,7 +60,7 @@ export const RestBanner = () => { noticeString = ( If you can't find what you're looking for, you might try the{' '} - Actions REST API page. + Actions REST API page. ) } diff --git a/components/rest/CodeBlock.module.scss b/components/rest/CodeBlock.module.scss index 2027f5c9d7..76c5b3a1f0 100644 --- a/components/rest/CodeBlock.module.scss +++ b/components/rest/CodeBlock.module.scss @@ -1,4 +1,14 @@ .codeBlock { max-height: 32rem; overflow: auto; + padding: 1rem; + margin-bottom: 1rem; + line-height: 1.45; + background-color: var(--color-canvas-subtle); + white-space: pre-wrap; + word-break: break-all; + + code { + background-color: transparent; + } } diff --git a/components/rest/CodeBlock.tsx b/components/rest/CodeBlock.tsx index 709b1941a0..b8d211a2bb 100644 --- a/components/rest/CodeBlock.tsx +++ b/components/rest/CodeBlock.tsx @@ -31,7 +31,7 @@ export function CodeBlock({ verb, headingLang, codeBlock, highlight }: Props) {
)} - 
+      

         
           {verb && (
             <>
@@ -43,7 +43,7 @@ export function CodeBlock({ verb, headingLang, codeBlock, highlight }: Props) {
           )}
           {codeBlock}
         
-
+
) } diff --git a/components/rest/RestReferencePage.tsx b/components/rest/RestReferencePage.tsx index 2adc48a96f..07e567bade 100644 --- a/components/rest/RestReferencePage.tsx +++ b/components/rest/RestReferencePage.tsx @@ -1,18 +1,13 @@ import React, { useState, useEffect } from 'react' -import cx from 'classnames' import { useRouter } from 'next/router' import dynamic from 'next/dynamic' import { DefaultLayout } from 'components/DefaultLayout' -import { useMainContext } from 'components/context/MainContext' import { MarkdownContent } from 'components/ui/MarkdownContent' import { Lead } from 'components/ui/Lead' -import { MiniTocItem } from 'components/context/ArticleContext' -import { RestCategoryOperationsT } from './types' +import { useRestContext } from 'components/context/RestContext' +import { Operation } from './types' import { RestOperation } from './RestOperation' -import { ChevronDownIcon, ChevronUpIcon, SearchIcon } from '@primer/octicons-react' -import { useTranslation } from 'components/hooks/useTranslation' -import { ActionList } from '@primer/react' const ClientSideHighlightJS = dynamic(() => import('components/article/ClientSideHighlightJS'), { ssr: false, @@ -26,24 +21,12 @@ const ClientSideRedirectExceptions = dynamic( ) export type StructuredContentT = { - descriptions: any - introContent: string - restOperations: RestCategoryOperationsT - miniTocItems?: MiniTocItem[] + restOperations: Operation[] } -export const RestReferencePage = ({ - descriptions, - introContent, - restOperations, - miniTocItems, -}: StructuredContentT) => { - const { t } = useTranslation('pages') +export const RestReferencePage = ({ restOperations }: StructuredContentT) => { const { asPath } = useRouter() - const { page } = useMainContext() - const subcategories = Object.keys(restOperations) - const [collapsed, setCollapsed] = useState({} as Record) - + const { title, intro, renderedPage } = useRestContext() // We have some one-off redirects for rest api docs // currently those are limited to the repos page, but // that will grow soon as we restructure the rest api docs. @@ -60,17 +43,13 @@ export const RestReferencePage = ({ // code. const [loadClientsideRedirectExceptions, setLoadClientsideRedirectExceptions] = useState(false) useEffect(() => { - const { hash, pathname } = window.location + const { hash } = window.location + // Today, Jan 2022, it's known explicitly what the pathname. // In the future there might be more. // Hopefully, we can some day delete all of this and no longer // be dependent on the URL hash to do the redirect. - if ( - hash && - (pathname.endsWith('/rest/reference/repos') || - pathname.endsWith('/rest/reference/enterprise-admin') || - pathname.endsWith('/rest/reference/deployments')) - ) { + if (hash && asPath.startsWith('/rest')) { setLoadClientsideRedirectExceptions(true) } }, []) @@ -110,113 +89,31 @@ export const RestReferencePage = ({ // consecutive one does. }, [asPath]) - // Resetting the collapsed array when we move to another REST page - useEffect(() => { - setCollapsed({}) - }, [asPath]) - - const handleClick = (param: number) => { - setCollapsed((prevState) => { - return { ...prevState, [param]: !prevState[param] } - }) - } - - const renderTocItem = (item: MiniTocItem, index: number) => { - return ( - -
-
- {item.items && item.items.length > 0 && ( - - )} - {collapsed[index] && item.items && item.items.length > 0 ? ( -
    {item.items.map(renderTocItem)}
- ) : null} -
- - ) - } - return ( {/* Doesn't matter *where* this is included because it will never render anything. It always just return null. */} {loadClientsideRedirectExceptions && } {lazyLoadHighlightJS && } - -
-

{page.title}

- {page.introPlainText && ( +
+

{title}

+ {intro && ( - {page.introPlainText} + {intro} )} -
-
- - - -
-
-

{t('miniToc')}

- {miniTocItems && ( - { - return { - key: page.title + i, - text: page.title, - renderItem: () =>
    {renderTocItem(items, i)}
, - } - })} - /> - )} -
-
-
-
-
- {subcategories.map((subcategory, index) => ( -
-
- {restOperations[subcategory].map((operation, index) => ( - - ))} -
- ))} + {renderedPage} + {restOperations && + restOperations.length > 0 && + restOperations.map((operation, index) => ( + + ))}
) } - -const Circle = ({ className, children }: { className?: string; children?: React.ReactNode }) => { - return ( -
- {children} -
- ) -} diff --git a/components/rest/types.ts b/components/rest/types.ts index 25d3bbd344..091196ce23 100644 --- a/components/rest/types.ts +++ b/components/rest/types.ts @@ -69,7 +69,3 @@ export interface ChildParameter { description: string type: string } - -export interface RestCategoryOperationsT { - [subcategory: string]: Operation[] -} diff --git a/components/sidebar/ProductCollapsibleSection.tsx b/components/sidebar/ProductCollapsibleSection.tsx new file mode 100644 index 0000000000..0d9c0cac00 --- /dev/null +++ b/components/sidebar/ProductCollapsibleSection.tsx @@ -0,0 +1,124 @@ +import cx from 'classnames' +import { useState, SyntheticEvent } from 'react' +import { ChevronDownIcon } from '@primer/octicons-react' +import { ActionList } from '@primer/react' + +import { Link } from 'components/Link' +import { ProductTreeNode } from 'components/context/MainContext' +import { EventType, sendEvent } from 'components/lib/events' +import styles from './SidebarProduct.module.scss' + +type SectionProps = { + routePath: string + page: ProductTreeNode + title: string + defaultOpen: boolean +} +export const ProductCollapsibleSection = (props: SectionProps) => { + const { routePath, defaultOpen, title, page } = props + const [isOpen, setIsOpen] = useState(defaultOpen) + + const onToggle = (e: SyntheticEvent) => { + const newIsOpen = (e.target as HTMLDetailsElement).open + setIsOpen(newIsOpen) + sendEvent({ + type: EventType.navigate, + navigate_label: `details ${newIsOpen ? 'open' : 'close'}: ${title}`, + }) + } + + // The lowest level page link displayed in the tree + const renderTerminalPageLink = (page: ProductTreeNode) => { + const title = page.renderedShortTitle || page.renderedFullTitle + + const isCurrent = routePath === page.href + return { + text: title, + renderItem: () => ( + + + {title} + + + ), + } + } + + return ( +
+ +
+
+ {title} +
+ + + +
+ + + { + <> + {/* */} + {page.childPages[0]?.page.documentType === 'mapTopic' ? ( +
    + {page.childPages.map((childPage, i) => { + const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle + + const isActive = routePath.includes(childPage.href) + const isCurrent = routePath === childPage.href + + return ( +
  • +
    e.stopPropagation()} + className="details-reset" + > + +
    {childTitle}
    +     +
    + { + return renderTerminalPageLink(cp) + })} + > +
    +
    +
    • + ) + })} +
+ ) : page.childPages[0]?.page.documentType === 'article' ? ( +
+ +
+ ) : null} + + } +
+ ) +} diff --git a/components/sidebar/RestCollapsibleSection.tsx b/components/sidebar/RestCollapsibleSection.tsx new file mode 100644 index 0000000000..2b2c628aec --- /dev/null +++ b/components/sidebar/RestCollapsibleSection.tsx @@ -0,0 +1,206 @@ +import { useRouter } from 'next/router' +import cx from 'classnames' +import { useState, useEffect, SyntheticEvent, ReactElement } from 'react' +import { ChevronDownIcon } from '@primer/octicons-react' +import { ActionList } from '@primer/react' + +import { Link } from 'components/Link' +import { ProductTreeNode } from 'components/context/MainContext' +import { EventType, sendEvent } from 'components/lib/events' +import { MiniTocItem, useRestContext } from 'components/context/RestContext' +import styles from './SidebarProduct.module.scss' + +type SectionProps = { + routePath: string + page: ProductTreeNode + title: string + defaultOpen: boolean + isStandaloneCategory: boolean +} + +type ConditionalLinkTypes = { + condition: boolean + wrapper: Function + children: ReactElement +} + +export const RestCollapsibleSection = (props: SectionProps) => { + const router = useRouter() + const { routePath, defaultOpen, title, page, isStandaloneCategory } = props + const [isOpen, setIsOpen] = useState(defaultOpen) + const [currentAnchor, setCurrentAnchor] = useState('') + const onToggle = (e: SyntheticEvent) => { + const newIsOpen = (e.target as HTMLDetailsElement).open + setIsOpen(newIsOpen) + sendEvent({ + type: EventType.navigate, + navigate_label: `details ${newIsOpen ? 'open' : 'close'}: ${title}`, + }) + } + + useEffect(() => { + if (!currentAnchor) { + setCurrentAnchor(window.location.hash) + } + + const hashChangeHandler = () => { + setCurrentAnchor(window.location.hash) + } + + window.addEventListener('hashchange', hashChangeHandler) + + return () => { + window.removeEventListener('hashchange', hashChangeHandler) + } + }, []) + + const miniTocItems = + router.query.productId === 'rest' || + // These pages need the Article Page mini tocs instead of the Rest Pages + router.asPath.includes('/rest/guides') || + router.asPath.includes('/rest/overview') + ? [] + : useRestContext().miniTocItems + + // This wrapper solves the issue of having standalone categories not + // link to the new page. We want standalone categories to have links + // just like maptopics/subcategories. + const ConditionalLinkWrapper = ({ condition, wrapper, children }: ConditionalLinkTypes) => + condition ? wrapper(children) : children + + const renderRestAnchorLink = (miniTocItem: MiniTocItem) => { + const miniTocAnchor = miniTocItem.contents.href + const title = miniTocItem.contents.title + const isCurrent = currentAnchor === miniTocAnchor + + return { + text: title, + renderItem: () => ( + + + {title} + + + ), + } + } + + return ( +
+ + ( + + {children} + + )} + > +
+
+ {title} +
+ + + +
+ + + + { + <> + {/* */} +
    + {page.childPages.length <= 0 ? ( +
    + {miniTocItems.length > 0 && ( + { + return renderRestAnchorLink(item) + })} + > + )} +
    + ) : ( + page.childPages.map((childPage, i) => { + const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle + const isActive = routePath.includes(childPage.href) + const isCurrent = routePath === childPage.href + + // At this point we have the mini-toc data for the current page + // so we render this list of operation links. + if (routePath === childPage.href) { + return ( +
  • +
    e.stopPropagation()} + className="details-reset" + > + +
    + {childTitle} +
    +     +
    + {miniTocItems.length > 0 && ( + { + return renderRestAnchorLink(item) + })} + > + )} +
    +
    +
    • + ) + } else { + // We're not on the current page so don't have any minitoc + // data so just render a link to the category page. + return ( +
  • + + {childTitle} + +
    • + ) + } + }) + )} +
+ + } +
+ ) +} diff --git a/components/sidebar/SidebarNav.tsx b/components/sidebar/SidebarNav.tsx index 97a79f1052..e0e7a6f605 100644 --- a/components/sidebar/SidebarNav.tsx +++ b/components/sidebar/SidebarNav.tsx @@ -9,7 +9,7 @@ import { SidebarHomepage } from './SidebarHomepage' export const SidebarNav = () => { const router = useRouter() - const { error, relativePath } = useMainContext() + const { error, currentProduct } = useMainContext() const { t } = useTranslation('header') return ( @@ -40,7 +40,7 @@ export const SidebarNav = () => {
) diff --git a/components/sidebar/SidebarProduct.tsx b/components/sidebar/SidebarProduct.tsx index 560c48a04b..470058fdf0 100644 --- a/components/sidebar/SidebarProduct.tsx +++ b/components/sidebar/SidebarProduct.tsx @@ -1,18 +1,19 @@ import { useRouter } from 'next/router' +import { useEffect } from 'react' import cx from 'classnames' -import { useState, useEffect, SyntheticEvent } from 'react' -import { ChevronDownIcon } from '@primer/octicons-react' -import { ActionList } from '@primer/react' import { Link } from 'components/Link' -import { ProductTreeNode, useMainContext } from 'components/context/MainContext' +import { useMainContext } from 'components/context/MainContext' import { AllProductsLink } from 'components/sidebar/AllProductsLink' -import { EventType, sendEvent } from 'components/lib/events' import styles from './SidebarProduct.module.scss' +import { RestCollapsibleSection } from './RestCollapsibleSection' +import { ProductCollapsibleSection } from './ProductCollapsibleSection' +import { useTranslation } from 'components/hooks/useTranslation' export const SidebarProduct = () => { const router = useRouter() - const { currentProductTree } = useMainContext() + const { currentProduct, currentProductTree } = useMainContext() + const { t } = useTranslation(['products']) useEffect(() => { const activeArticle = document.querySelector('[data-is-current-page=true]') @@ -28,13 +29,134 @@ export const SidebarProduct = () => { return null } - const productTitle = currentProductTree.renderedShortTitle || currentProductTree.renderedFullTitle // remove query string and hash const routePath = `/${router.locale}${router.asPath.split('?')[0].split('#')[0]}` - const hasExactCategory = !!currentProductTree.childPages.find(({ href }) => + const hasExactCategory = !!currentProductTree?.childPages.find(({ href }) => routePath.includes(href) ) + + const productTitle = currentProductTree.renderedShortTitle || currentProductTree.renderedFullTitle + + const productSection = () => ( +
  • +
      + {currentProductTree && + currentProductTree.childPages.map((childPage, i) => { + const isStandaloneCategory = childPage.page.documentType === 'article' + + const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle + const isActive = + routePath.includes(childPage.href + '/') || routePath === childPage.href + const defaultOpen = hasExactCategory ? isActive : false + return ( +
    • + {isStandaloneCategory ? ( + + {childTitle} + + ) : ( + + )} +
      • + ) + })} +
    +
    • + ) + + const restSection = () => { + const conceptualPages = currentProductTree.childPages.filter( + (page) => page.href.includes('guides') || page.href.includes('overview') + ) + const restPages = currentProductTree.childPages.filter( + (page) => !page.href.includes('guides') && !page.href.includes('overview') + ) + return ( + <> +
  • +
      + {conceptualPages.map((childPage, i) => { + const isStandaloneCategory = childPage.page.documentType === 'article' + const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle + const isActive = + routePath.includes(childPage.href + '/') || routePath === childPage.href + const defaultOpen = hasExactCategory ? isActive : false + return ( +
    • + +
      • + ) + })} +
    +
    • +
    + + + {t('rest.reference.api_reference')} + +
    +
  • +
      + {restPages.map((childPage, i) => { + const isStandaloneCategory = childPage.page.documentType === 'article' + + const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle + const isActive = + routePath.includes(childPage.href + '/') || routePath === childPage.href + const defaultOpen = hasExactCategory ? isActive : false + return ( +
    • + +
      • + ) + })} +
    +
    • + + ) + } + return (
      @@ -49,160 +171,9 @@ export const SidebarProduct = () => { {productTitle} - -
    • -
        - {currentProductTree.childPages.map((childPage, i) => { - const isStandaloneCategory = childPage.page.documentType === 'article' - - const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle - const isActive = - routePath.includes(childPage.href + '/') || routePath === childPage.href - const defaultOpen = hasExactCategory ? isActive : false - return ( -
      • - {isStandaloneCategory ? ( - - {childTitle} - - ) : ( - - )} -
        • - ) - })} -
      -
      • + {currentProduct && currentProduct.id === 'rest' ? restSection() : productSection()} )}
    ) } - -type SectionProps = { - routePath: string - page: ProductTreeNode - title: string - defaultOpen: boolean -} -const CollapsibleSection = (props: SectionProps) => { - const { routePath, defaultOpen, title, page } = props - const [isOpen, setIsOpen] = useState(defaultOpen) - - const onToggle = (e: SyntheticEvent) => { - const newIsOpen = (e.target as HTMLDetailsElement).open - setIsOpen(newIsOpen) - sendEvent({ - type: EventType.navigate, - navigate_label: `details ${newIsOpen ? 'open' : 'close'}: ${title}`, - }) - } - - // The lowest level page link displayed in the tree - const renderTerminalPageLink = (page: ProductTreeNode) => { - const title = page.renderedShortTitle || page.renderedFullTitle - - const isCurrent = routePath === page.href - return { - text: title, - renderItem: () => ( - - - {title} - - - ), - } - } - - return ( -
    - -
    -
    - {title} -
    - - - -
    -     - - { - <> - {/* */} - {page.childPages[0]?.page.documentType === 'mapTopic' ? ( -
      - {page.childPages.map((childPage, i) => { - const childTitle = childPage.renderedShortTitle || childPage.renderedFullTitle - - const isActive = routePath.includes(childPage.href) - const isCurrent = routePath === childPage.href - - return ( -
    • -
      e.stopPropagation()} - className="details-reset" - > - -
      {childTitle}
      -       -
      - { - return renderTerminalPageLink(cp) - })} - > -
      -
      -
      • - ) - })} -
    - ) : page.childPages[0]?.page.documentType === 'article' ? ( -
    - -
    - ) : null} - - } -
    - ) -} diff --git a/components/ui/MarkdownContent/stylesheets/code.scss b/components/ui/MarkdownContent/stylesheets/code.scss index 8c440c47c8..3c2d3e6832 100644 --- a/components/ui/MarkdownContent/stylesheets/code.scss +++ b/components/ui/MarkdownContent/stylesheets/code.scss @@ -12,7 +12,8 @@ [class~="code-extra"] { margin-top: 1.5rem; - pre { + pre, + div { margin-top: 0 !important; border-top-left-radius: 0 !important; border-top-right-radius: 0 !important; diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md index 751e1bbebb..a584636f36 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md @@ -16,7 +16,7 @@ topics: shortTitle: Organization's profile --- -You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4749 %} You can customize your organization's profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %} +You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4749 %} You can customize your organization's public profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %} {% ifversion fpt %} Organizations that use {% data variables.product.prodname_ghe_cloud %} can confirm their organization's identity and display a "Verified" badge on their organization's profile page by verifying the organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)" in the {% data variables.product.prodname_ghe_cloud %} documenatation. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md index d146a8db58..60952b5203 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md @@ -65,7 +65,7 @@ jobs: java-version: '11' distribution: 'adopt' - name: Build with Maven - run: mvn --batch-mode --update-snapshots verify + run: mvn --batch-mode --update-snapshots package ``` This workflow performs the following steps: diff --git a/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 9426b2ff4b..c1e1ea2515 100644 --- a/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -28,6 +28,14 @@ You can add self-hosted runners at various levels in the management hierarchy: {% data reusables.actions.self-hosted-runner-architecture %} {% data reusables.actions.runner-app-open-source %} When a new version is released, the runner application automatically updates itself when a job is assigned to the runner, or within a week of release if the runner hasn't been assigned any jobs. +{% ifversion ghes %} +{% note %} + +**Note:** {% data reusables.actions.upgrade-runners-before-upgrade-ghes %} + +{% endnote %} +{% endif %} + {% data reusables.actions.self-hosted-runner-auto-removal %} For more information about installing and using self-hosted runners, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." @@ -45,7 +53,7 @@ For more information about installing and using self-hosted runners, see "[Addin - Use free minutes on your {% data variables.product.prodname_dotcom %} plan, with per-minute rates applied after surpassing the free minutes. **Self-hosted runners:**{% endif %} -- Receive automatic updates for the self-hosted runner application only{% ifversion fpt or ghec or ghes > 3.2 %}, though you may disable automatic updates of the runner. For more information about controlling runner software updates on self-hosted runners, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)."{% else %}.{% endif %} You are responsible for updating the operating system and all other software. +- Receive automatic updates for the self-hosted runner application only{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6143 %}, though you may disable automatic updates of the runner. For more information about controlling runner software updates on self-hosted runners, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)."{% else %}.{% endif %} You are responsible for updating the operating system and all other software. - Can use cloud services or local machines that you already pay for. - Are customizable to your hardware, operating system, software, and security requirements. - Don't need to have a clean instance for every job execution. diff --git a/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index 6bc28e5c75..5967079516 100644 --- a/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -54,6 +54,8 @@ The {% data variables.product.prodname_actions %} service will then automaticall {% endnote %} +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6143 %} + ## Controlling runner software updates on self-hosted runners By default, self-hosted runners will automatically perform a software update whenever a new version of the runner software is available. If you use ephemeral runners in containers then this can lead to repeated software updates when a new runner version is released. Turning off automatic updates allows you to update the runner version on the container image directly on your own schedule. @@ -76,6 +78,8 @@ For instructions on how to install the latest runner version, see the installati {% endnote %} +{% endif %} + ## Using webhooks for autoscaling You can create your own autoscaling environment by using payloads received from the [`workflow_job`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) webhook. This webhook is available at the repository, organization, and enterprise levels, and the payload for this event contains an `action` key that corresponds to the stages of a workflow job's life-cycle; for example when jobs are `queued`, `in_progress`, and `completed`. You must then create your own scaling automation in response to these webhook payloads. diff --git a/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md index 6c596084ba..8bc1ed42f1 100644 --- a/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -258,3 +258,11 @@ User=runner-user ``` {% endlinux %} + +{% ifversion ghes %} +## Resolving runners that are offline after an upgrade of {% data variables.product.product_location %} + +{% data reusables.actions.upgrade-runners-before-upgrade-ghes %} + +If your runners are offline for this reason, manually update the runners. For more information, see the installation instructions for [the latest release](https://github.com/actions/runner/releases/latest) in the actions/runner repository. +{% endif %} \ No newline at end of file diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 95326574a6..a877b5c6af 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -50,7 +50,7 @@ Setting secondary rate limits protects the overall level of service on {% data v 3. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} -## Enabling Git rate limits +## Enabling rate limits for Git You can apply Git rate limits per repository network or per user ID. Git rate limits are expressed in concurrent operations per minute, and are adaptive based on the current CPU load. @@ -61,3 +61,44 @@ You can apply Git rate limits per repository network or per user ID. Git rate li 3. Type limits for each repository network or user ID. ![Fields for repository network and user ID limits](/assets/images/enterprise/management-console/example-git-rate-limits.png) {% data reusables.enterprise_management_console.save-settings %} + +{% ifversion ghes > 3.4 %} + +## Configuring rate limits for {% data variables.product.prodname_actions %} + +You can apply a rate limit to {% data variables.product.prodname_actions %} workflow runs. For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %} for enterprises](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)." + +### About rate limits for {% data variables.product.prodname_actions %} + +Your {% data variables.product.product_name %} instance assigns each {% data variables.product.prodname_actions %} workflow job to a runner. If your instance cannot immediately assign a job to an available runner, the job will wait in a queue until a runner is available. If {% data variables.product.prodname_actions %} experiences sustained high load, the queue can back up, and the performance of {% data variables.product.product_location %} may degrade. + +To avoid this performance degradation, you can configure a rate limit for {% data variables.product.prodname_actions %}. This rate limit is expressed in job runs per minute. {% data variables.product.product_name %} calculates and applies the rate limit for the sum total of all job runs on the instance. If runs exceed the rate limit, additional runs will fail instead of entering the queue. The following error will appear in the run's annotations. + +> You've exceeded the rate limit for workflow run requests. Please wait before retrying the run. + +An appropriate rate limit protects {% data variables.product.product_location %} from abnormal usage of {% data variables.product.prodname_actions %} without interfering with day-to-day operations. The exact threshold depends on your instance's available resources and overall load profile. For more information about the hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-requirements)." + +By default, the rate limit for {% data variables.product.prodname_actions %} is disabled. Because {% data variables.product.product_name %} can handle temporary spikes in usage without performance degradation, this rate limit is intended to protect against sustained high load. We recommend leaving the rate limit disabled unless you are experiencing performance problems. In some cases, {% data variables.contact.github_support %} may recommend that you enable a rate limit for {% data variables.product.prodname_actions %}. + +### Enabling or disabling rate limits for {% data variables.product.prodname_actions %} + +{% data reusables.enterprise_installation.ssh-into-instance %} +1. To enable and configure the rate limit, run the following two commands, replacing **RUNS-PER-MINUTE** with the value of your choice. + + ```shell + ghe-config actions-rate-limiting.enabled true + ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE + ``` +1. To disable the rate limit after it's been enabled, run the following command. + + ``` + ghe-config actions-rate-limiting.enabled false + ``` +1. To apply the configuration, run the following command. + + ``` + ghe-config-apply + ``` +1. Wait for the configuration run to complete. + +{% endif %} \ No newline at end of file diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index 3a8e381da1..cdd8706294 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -28,8 +28,9 @@ shortTitle: Upgrading GHES ## Preparing to upgrade 1. Determine an upgrade strategy and choose a version to upgrade to. For more information, see "[Upgrade requirements](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrade-requirements/)" and refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version. -3. Create a fresh backup of your primary instance with the {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README.md file](https://github.com/github/backup-utils#readme). -4. If you are upgrading using an upgrade package, schedule a maintenance window for {% data variables.product.prodname_ghe_server %} end users. If you are using a hotpatch, maintenance mode is not required. +1. Create a fresh backup of your primary instance with the {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README.md file](https://github.com/github/backup-utils#readme). +1. If {% data variables.product.product_location %} uses ephemeral self-hosted runners for {% data variables.product.prodname_actions %} and you've disabled automatic updates, upgrade your runners to the version of the runner application that your upgraded instance will run. +1. If you are upgrading using an upgrade package, schedule a maintenance window for {% data variables.product.prodname_ghe_server %} end users. If you are using a hotpatch, maintenance mode is not required. {% note %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md index 8aeb75ffad..9321667ae6 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -94,6 +94,12 @@ For more information about minimum hardware requirements for {% data variables.p {% data reusables.enterprise_installation.about-adjusting-resources %} +{% ifversion ghes > 3.4 %} + +Optionally, you can limit resource consumption on {% data variables.product.product_location %} by configuring a rate limit for {% data variables.product.prodname_actions %}. For more information, see "[Configuring rate limits](/admin/configuration/configuring-your-enterprise/configuring-rate-limits#configuring-rate-limits-for-github-actions)." + +{% endif %} + ## External storage requirements To enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, you must have access to external blob storage. diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md index 67bc5728a9..f3d53a8507 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md @@ -161,6 +161,11 @@ This uploads the database as an actions artifact that you can download to your l The artifact will contain an archived copy of the source files scanned by {% data variables.product.prodname_codeql %} called _src.zip_. If you compare the source code files in the repository and the files in _src.zip_, you can see which types of file are missing. Once you know what types of file are not being analyzed, it is easier to understand how you may need to change the workflow for {% data variables.product.prodname_codeql %} analysis. +## Alerts found in generated code + +{% data reusables.code-scanning.alerts-found-in-generated-code %} + + ## Extraction errors in the database The {% data variables.product.prodname_codeql %} team constantly works on critical extraction errors to make sure that all source files can be scanned. However, the {% data variables.product.prodname_codeql %} extractors do occasionally generate errors during database creation. {% data variables.product.prodname_codeql %} provides information about extraction errors and warnings generated during database creation in a log file. @@ -191,11 +196,9 @@ The default {% data variables.product.prodname_codeql_workflow %} uses a build m Analysis time is typically proportional to the amount of code being analyzed. You can reduce the analysis time by reducing the amount of code being analyzed at once, for example, by excluding test code, or breaking analysis into multiple workflows that analyze only a subset of your code at a time. -For compiled languages like Java, C, C++, and C#, {% data variables.product.prodname_codeql %} analyzes all of the code which was built during the workflow run. To limit the amount of code being analyzed, build only the code which you wish to analyze by specifying your own build steps in a `run` block. You can combine specifying your own build steps with using the `paths` or `paths-ignore` filters on the `pull_request` and `push` events to ensure that your workflow only runs when specific code is changed. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)." +{% data reusables.code-scanning.alerts-found-in-generated-code %} -For languages like Go, JavaScript, Python, and TypeScript, that {% data variables.product.prodname_codeql %} analyzes without compiling the source code, you can specify additional configuration options to limit the amount of code to analyze. For more information, see "[Specifying directories to scan](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)." - -If you split your analysis into multiple workflows as described above, we still recommend that you have at least one workflow which runs on a `schedule` which analyzes all of the code in your repository. Because {% data variables.product.prodname_codeql %} analyzes data flows between components, some complex security behaviors may only be detected on a complete build. +If you split your analysis into multiple workflows as described above, we still recommend that you have at least one workflow which runs on a `schedule` which analyzes all of the code in your repository. Because {% data variables.product.prodname_codeql %} analyzes data flows between components, some complex security behaviors may only be detected on a complete build. ### Run only during a `schedule` event diff --git a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md index e05375528a..543e8e908d 100644 --- a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md +++ b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md @@ -64,7 +64,7 @@ You need to make the full contents of the {% data variables.product.prodname_cod ```shell $ wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-bundle-linux64.tar.gz -$ tar -xvzf ../codeql-bundle-linux64.tar.gz +$ tar -xvzf ./codeql-bundle-linux64.tar.gz ``` After you extract the {% data variables.product.prodname_codeql_cli %} bundle, you can run the `codeql` executable on the server: diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md index 42cac17af9..6cbb18c5af 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md @@ -66,7 +66,7 @@ The recommended formats explicitly define which versions are used for all direct | Package manager | Languages | Recommended formats | All supported formats | | --- | --- | --- | ---| | Composer | PHP | `composer.lock` | `composer.json`, `composer.lock` | -| `dotnet` CLI | .NET languages (C#, C++, F#, VB) | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` | +| NuGet | .NET languages (C#, F#, VB), C++ | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` | {%- if github-actions-in-dependency-graph %} | {% data variables.product.prodname_actions %} workflows[1] | YAML | `.yml`, `.yaml` | `.yml`, `.yaml` | {%- endif %} diff --git a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 63f8487314..9e67787fd8 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -198,7 +198,7 @@ The `devcontainer.json` file is written using the JSONC format. This allows you {% note %} -**Note**: If you use a linter to valid the `devcontainer.json` file, make sure it is set to JSONC and not JSON or comments will be reported as errors. +**Note**: If you use a linter to validate the `devcontainer.json` file, make sure it is set to JSONC and not JSON or comments will be reported as errors. {% endnote %} diff --git a/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index e4ce93f1c8..1971ab0671 100644 --- a/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -122,6 +122,7 @@ Webhook event name | Required permission | Description [`pull_request`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %} [`pull_request_review`](/webhooks/event-payloads/#pull_request_review) | `pull_request` | {% data reusables.webhooks.pull_request_review_short_desc %} [`pull_request_review_comment`](/webhooks/event-payloads/#pull_request_review_comment) | `pull_request` | {% data reusables.webhooks.pull_request_review_comment_short_desc %} +[`pull_request_review_thread`](/webhooks/event-payloads/#pull_request_review_thread) | `pull_request` | {% data reusables.webhooks.pull_request_review_thread_short_desc %} [`push`](/webhooks/event-payloads/#push) | `contents` | {% data reusables.webhooks.push_short_desc %} [`release`](/webhooks/event-payloads/#release) | `contents` | {% data reusables.webhooks.release_short_desc %} [`repository`](/webhooks/event-payloads/#repository) |`metadata` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} diff --git a/content/developers/webhooks-and-events/events/github-event-types.md b/content/developers/webhooks-and-events/events/github-event-types.md index 1f69c168a8..ee2109db01 100644 --- a/content/developers/webhooks-and-events/events/github-event-types.md +++ b/content/developers/webhooks-and-events/events/github-event-types.md @@ -207,6 +207,16 @@ Key | Type | Description {% data reusables.webhooks.pull_request_review_comment_event_api_properties %} {% data reusables.webhooks.pull_request_review_comment_properties %} +## PullRequestReviewThreadEvent + +{% data reusables.webhooks.pull_request_review_thread_short_desc %} + +{% data reusables.webhooks.events_api_payload %} + +### Event `payload` object + +{% data reusables.webhooks.pull_request_thread_properties %} + ## PushEvent {% data reusables.webhooks.push_short_desc %} diff --git a/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index c0e7b3fa92..efd403c2f6 100644 --- a/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1060,6 +1060,28 @@ Deliveries for `review_requested` and `review_request_removed` events will have {{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }} +## pull_request_review_thread + +{% data reusables.webhooks.pull_request_review_thread_short_desc %} + +### Availability + +- Repository webhooks +- Organization webhooks +- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission + +### Webhook payload object + +{% data reusables.webhooks.pull_request_thread_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Webhook payload example + +{{ webhookPayloadsForCurrentVersion.pull_request_review_thread.resolved }} + ## push {% data reusables.webhooks.push_short_desc %} @@ -1161,7 +1183,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends Key | Type | Description ----|------|------------- -`action` |`string` | The action that was performed. This can be one of:
    • `created` - A repository is created.
    • `deleted` - A repository is deleted.
    • `archived` - A repository is archived.
    • `unarchived` - A repository is unarchived.
      • {% ifversion ghes or ghae %}
    • `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/rest/overview/api-previews#anonymous-git-access-to-repositories)
      • {% endif %}
    • `edited` - A repository's information is edited.
    • `renamed` - A repository is renamed.
    • `transferred` - A repository is transferred.
    • `publicized` - A repository is made public.
    • `privatized` - A repository is made private.
    +`action` |`string` | The action that was performed. This can be one of:
    • `created` - A repository is created.
    • `deleted` - A repository is deleted.
    • `archived` - A repository is archived.
    • `unarchived` - A repository is unarchived.
      • {% ifversion ghes or ghae %}
    • `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
      • {% endif %}
    • `edited` - A repository's information is edited.
    • `renamed` - A repository is renamed.
    • `transferred` - A repository is transferred.
    • `publicized` - A repository is made public.
    • `privatized` - A repository is made private.
    {% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.org_desc %} {% data reusables.webhooks.app_desc %} diff --git a/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md b/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md index 74e22b565a..b0df6e5667 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md +++ b/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md @@ -1,6 +1,6 @@ --- title: Customizing your organization's profile -intro: You can share information about your organization by customizing your organization's profile +intro: You can share information about your organization by customizing your organization's profile. versions: fpt: '*' ghec: '*' @@ -11,19 +11,70 @@ topics: shortTitle: Customize organization profile --- -## About your organization's profile README +{% if org-profile-pin-private %} -You can share information about how to engage with your organization by creating an organization profile README. {% data variables.product.prodname_dotcom %} shows your organization profile README in the "Overview" tab of your organization. +## About your organization's profile page -You can choose what information to include your organization profile README. Here are some examples of information that may be helpful in your organization's profile README. +You can customize your organization's Overview page to show content dedicated to public users or members of the organization. Members of your organization who are signed into {% data variables.product.prodname_dotcom %}, are shown a member view when they visit your organization's profile page. Users who are not members of your organization will be shown a public view. + +![Image of an organization profile page](/assets/images/help/organizations/new_organization_page.png) +{% endif %} + +### Pinned repositories + +You can give users easy access to important or frequently used repositories, by choosing up to six repositories for public users and six repositories for members of the organization. Once you pin repositories to your organization profile, the "Pinned" section is shown above the "Repositories" section of the profile page. + +Only organization owners can pin repositories. For more information, see "[Pinning repositories to your organization's profile](#pinning-repositories-to-your-organizations-profile)." + +### Organization profile READMEs + +You can share information about how to engage with your organization by creating an organization profile README for both public users and members of the organization. {% data variables.product.prodname_dotcom %} shows your organization profile README in the "Overview" tab of your organization. + +You can choose what information to include in your organization profile README. Here are some examples of information that may be helpful. - An "About" section that describes your organization - Guidance for getting help in the organization You can format text and include emoji, images, and GIFs in your organization profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)." -## Adding an organization profile README +## Adding a public organization profile README 1. If your organization does not already have a public `.github` repository, create a public `.github` repository. 2. In your organization's `.github` repository, create a `README.md` file in the `profile` folder. -3. Commit the changes to the `README.md` file. The content of the `README.md` will appear on your organization's profile. +3. Commit the changes to the `README.md` file. The content of the `README.md` will appear on your organization's public profile. + + ![Image of an organization's public README](/assets/images/help/organizations/org_public_readme.png) + +{% if org-profile-pin-private %} + +## Adding a member-only organization profile README + +1. If your organization does not already have a `.github-private` repository, create a public `.github-private` repository. This action can be performed by any user that has write access to that repository. +2. In your organization's `.github-private` repository, create a `README.md` file in the `profile` folder. +3. Commit the changes to the `README.md` file. The content of the `README.md` will be displayed in the member view of your organization's profile. + + ![Image of an organization's private README](/assets/images/help/organizations/org_member_readme.png) + +## Pinning repositories to your organization's profile + +You can pin repositories that you want to feature, such as those that are frequently used, to your organization's profile page. To choose which repositories to pin to your organization's profile, you must be an organization owner or administrator. + +1. Navigate to your organization's profile page. +2. In the right sidebar of the page in the {% octicon "eye" aria-label="The eye octicon" %} "View as" link, choose the **Public** or **Member** profile view from the dropdown menu. + + ![Image of the organization profile view dropdown](/assets/images/help/organizations/org_profile_view.png) + +3. In the pinned repositories section, select **Customize pins**. + + ![Image of the customize pins link](/assets/images/help/organizations/customize_pins_link.png) + + - If you haven't yet pinned any repositories to your organization's profile, you'll need to instead click **pin repositories** in the right sidebar of the profile page. + ![Image of pin repositories link in right sidebar](/assets/images/help/organizations/pin_repositories_link.png) + +4. In the "Edit pinned repositories" dialog box, select a combination of up to six public, {% ifversion not fpt %}private, or internal{% else %}or private{% endif %} repositories to display. + + ![Image of pinned repo dialog](/assets/images/help/organizations/pinned_repo_dialog.png) + +5. Click **Save pins**. + +{% endif %} diff --git a/content/rest/actions/artifacts.md b/content/rest/actions/artifacts.md new file mode 100644 index 0000000000..50728ce183 --- /dev/null +++ b/content/rest/actions/artifacts.md @@ -0,0 +1,15 @@ +--- +title: Artifacts +intro: 'The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/cache.md b/content/rest/actions/cache.md similarity index 52% rename from data/reusables/rest-reference/actions/cache.md rename to content/rest/actions/cache.md index 6f735ae59c..227622ec99 100644 --- a/data/reusables/rest-reference/actions/cache.md +++ b/content/rest/actions/cache.md @@ -1,3 +1,11 @@ -## Cache +--- +title: Cache +intro: 'The Cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories.' +topics: + - API +versions: + fpt: '*' + ghec: '*' +--- -The cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories. For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)." \ No newline at end of file +The cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories. For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)." diff --git a/content/rest/actions/index.md b/content/rest/actions/index.md new file mode 100644 index 0000000000..1eef306da9 --- /dev/null +++ b/content/rest/actions/index.md @@ -0,0 +1,26 @@ +--- +title: Actions +intro: 'With the Actions API, you can manage and control {% data variables.product.prodname_actions %} for an organization or repository.' +redirect_from: + - /v3/actions + - /rest/reference/actions +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /artifacts + - /cache + - /permissions + - /secrets + - /self-hosted-runner-groups + - /self-hosted-runners + - /workflow-jobs + - /workflow-runs + - /workflows +--- +The {% data variables.product.prodname_actions %} API enables you to manage {% data variables.product.prodname_actions %} using the REST API. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/permissions.md b/content/rest/actions/permissions.md similarity index 58% rename from data/reusables/rest-reference/actions/permissions.md rename to content/rest/actions/permissions.md index 6acc16385d..250824f7dd 100644 --- a/data/reusables/rest-reference/actions/permissions.md +++ b/content/rest/actions/permissions.md @@ -1,3 +1,15 @@ +--- +title: Permissions +intro: 'The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + ## Permissions The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %} \ No newline at end of file diff --git a/content/rest/actions/secrets.md b/content/rest/actions/secrets.md new file mode 100644 index 0000000000..bb9cdca350 --- /dev/null +++ b/content/rest/actions/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. ' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/self-hosted-runner-groups.md b/content/rest/actions/self-hosted-runner-groups.md similarity index 76% rename from data/reusables/rest-reference/actions/self-hosted-runner-groups.md rename to content/rest/actions/self-hosted-runner-groups.md index f523849935..77b15aa36f 100644 --- a/data/reusables/rest-reference/actions/self-hosted-runner-groups.md +++ b/content/rest/actions/self-hosted-runner-groups.md @@ -1,3 +1,15 @@ +--- +title: Self-hosted runner groups +intro: 'The Self-hosted Runners Groups API allows you manage groups of self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + ## Self-hosted runner groups The Self-hosted Runners Groups API allows you manage groups of self-hosted runners. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." diff --git a/data/reusables/rest-reference/actions/self-hosted-runners.md b/content/rest/actions/self-hosted-runners.md similarity index 75% rename from data/reusables/rest-reference/actions/self-hosted-runners.md rename to content/rest/actions/self-hosted-runners.md index 4f2d9b1907..61c8aa3d5a 100644 --- a/data/reusables/rest-reference/actions/self-hosted-runners.md +++ b/content/rest/actions/self-hosted-runners.md @@ -1,3 +1,15 @@ +--- +title: Self-hosted runners +intro: 'The Self-hosted Runners API allows you to register, view, and delete self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + ## Self-hosted runners The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)." diff --git a/content/rest/actions/workflow-jobs.md b/content/rest/actions/workflow-jobs.md new file mode 100644 index 0000000000..469ea0382f --- /dev/null +++ b/content/rest/actions/workflow-jobs.md @@ -0,0 +1,15 @@ +--- +title: Workflow jobs +intro: 'The Workflow Jobs API allows you to view logs and workflow jobs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/content/rest/actions/workflow-runs.md b/content/rest/actions/workflow-runs.md new file mode 100644 index 0000000000..3fca12a420 --- /dev/null +++ b/content/rest/actions/workflow-runs.md @@ -0,0 +1,15 @@ +--- +title: Workflow runs +intro: 'The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/content/rest/actions/workflows.md b/content/rest/actions/workflows.md new file mode 100644 index 0000000000..55dad18cea --- /dev/null +++ b/content/rest/actions/workflows.md @@ -0,0 +1,15 @@ +--- +title: Workflows +intro: 'The Workflows API allows you to view workflows for a repository.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/data/reusables/rest-reference/activity/events.md b/content/rest/activity/events.md similarity index 83% rename from data/reusables/rest-reference/activity/events.md rename to content/rest/activity/events.md index 78f65cef36..9b3f58527b 100644 --- a/data/reusables/rest-reference/activity/events.md +++ b/content/rest/activity/events.md @@ -1,6 +1,17 @@ -## Events +--- +title: Events +intro: 'The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events. These events power the various activity streams on the site. +These events power the various activity streams on the site. The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{% data variables.product.prodname_dotcom %} Event types](/developers/webhooks-and-events/github-event-types)." An events API for repository issues is also available. For more information, see the "[Issue Events API](/rest/reference/issues#events)." diff --git a/data/reusables/rest-reference/activity/feeds.md b/content/rest/activity/feeds.md similarity index 93% rename from data/reusables/rest-reference/activity/feeds.md rename to content/rest/activity/feeds.md index b3a531acb3..e11e4cf1f4 100644 --- a/data/reusables/rest-reference/activity/feeds.md +++ b/content/rest/activity/feeds.md @@ -1,4 +1,15 @@ -## Feeds +--- +title: Feeds +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- ### Example of getting an Atom feed diff --git a/translations/es-ES/content/rest/reference/activity.md b/content/rest/activity/index.md similarity index 69% rename from translations/es-ES/content/rest/reference/activity.md rename to content/rest/activity/index.md index 469e3fd72e..3f18631406 100644 --- a/translations/es-ES/content/rest/reference/activity.md +++ b/content/rest/activity/index.md @@ -3,6 +3,7 @@ title: Activity intro: 'The Activity API allows you to list events and feeds and manage notifications, starring, and watching for the authenticated user.' redirect_from: - /v3/activity + - /rest/reference/activity versions: fpt: '*' ghes: '*' @@ -11,8 +12,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /events + - /feeds + - /notifications + - /starring + - /watching --- - - \ No newline at end of file diff --git a/data/reusables/rest-reference/activity/notifications.md b/content/rest/activity/notifications.md similarity index 96% rename from data/reusables/rest-reference/activity/notifications.md rename to content/rest/activity/notifications.md index bda316fd68..49678f8f9c 100644 --- a/data/reusables/rest-reference/activity/notifications.md +++ b/content/rest/activity/notifications.md @@ -1,4 +1,15 @@ -## Notifications +--- +title: Notifications +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- Users receive notifications for conversations in repositories they watch including: diff --git a/data/reusables/rest-reference/activity/starring.md b/content/rest/activity/starring.md similarity index 76% rename from data/reusables/rest-reference/activity/starring.md rename to content/rest/activity/starring.md index 5827504c99..9c45ddad6f 100644 --- a/data/reusables/rest-reference/activity/starring.md +++ b/content/rest/activity/starring.md @@ -1,6 +1,17 @@ -## Starring +--- +title: Starring +intro: 'Repository starring is a feature that lets users bookmark repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -Repository starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. +Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. ### Starring vs. Watching diff --git a/content/rest/activity/watching.md b/content/rest/activity/watching.md new file mode 100644 index 0000000000..10f078782e --- /dev/null +++ b/content/rest/activity/watching.md @@ -0,0 +1,14 @@ +--- +title: Watching +intro: "Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." \ No newline at end of file diff --git a/data/reusables/rest-reference/apps/apps.md b/content/rest/apps/apps.md similarity index 72% rename from data/reusables/rest-reference/apps/apps.md rename to content/rest/apps/apps.md index dc5f5bfab9..7f7fa4b74f 100644 --- a/data/reusables/rest-reference/apps/apps.md +++ b/content/rest/apps/apps.md @@ -1,3 +1,16 @@ +--- +title: Apps +intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + {% data reusables.apps.general-apps-restrictions %} This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more. @@ -6,4 +19,4 @@ When authenticated as a GitHub App, the GitHub Apps API enables you to get high- You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user. -A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints. \ No newline at end of file +A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints. diff --git a/translations/es-ES/content/rest/reference/apps.md b/content/rest/apps/index.md similarity index 69% rename from translations/es-ES/content/rest/reference/apps.md rename to content/rest/apps/index.md index 55023fa8db..5bbc724e11 100644 --- a/translations/es-ES/content/rest/reference/apps.md +++ b/content/rest/apps/index.md @@ -3,6 +3,7 @@ title: Apps intro: The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps. redirect_from: - /v3/apps + - /rest/reference/apps versions: fpt: '*' ghes: '*' @@ -11,8 +12,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /apps + - /installations + - /marketplace + - /oauth-applications + - /webhooks --- - - diff --git a/content/rest/apps/installations.md b/content/rest/apps/installations.md new file mode 100644 index 0000000000..8e858caed4 --- /dev/null +++ b/content/rest/apps/installations.md @@ -0,0 +1,16 @@ +--- +title: Installations +intro: 'The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." + +To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." diff --git a/data/reusables/rest-reference/apps/marketplace.md b/content/rest/apps/marketplace.md similarity index 89% rename from data/reusables/rest-reference/apps/marketplace.md rename to content/rest/apps/marketplace.md index 1aae73d87f..d49e3bed46 100644 --- a/data/reusables/rest-reference/apps/marketplace.md +++ b/content/rest/apps/marketplace.md @@ -1,4 +1,13 @@ -## Marketplace +--- +title: Marketplace +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' +--- For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)." @@ -10,4 +19,4 @@ This API includes endpoints that allow you to [test your {% data variables.produ To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether API logic succeeds before listing {% data variables.product.prodname_github_apps %} on {% data variables.product.prodname_marketplace %}. -Be sure to replace stubbed endpoints with production endpoints before deploying your {% data variables.product.prodname_github_app %}. \ No newline at end of file +Be sure to replace stubbed endpoints with production endpoints before deploying your {% data variables.product.prodname_github_app %}. diff --git a/data/reusables/rest-reference/apps/oauth-applications.md b/content/rest/apps/oauth-applications.md similarity index 51% rename from data/reusables/rest-reference/apps/oauth-applications.md rename to content/rest/apps/oauth-applications.md index d0f6e0b850..037850e51c 100644 --- a/data/reusables/rest-reference/apps/oauth-applications.md +++ b/content/rest/apps/oauth-applications.md @@ -1,3 +1,14 @@ -## OAuth Applications API +--- +title: OAuth Applications +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- -You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. \ No newline at end of file +You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. diff --git a/data/reusables/rest-reference/apps/webhooks.md b/content/rest/apps/webhooks.md similarity index 57% rename from data/reusables/rest-reference/apps/webhooks.md rename to content/rest/apps/webhooks.md index 7ae5665f8b..c3cf61466f 100644 --- a/data/reusables/rest-reference/apps/webhooks.md +++ b/content/rest/apps/webhooks.md @@ -1,3 +1,14 @@ -## Webhooks +--- +title: Webhooks +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- -A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %} \ No newline at end of file +A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %} diff --git a/data/reusables/rest-reference/billing/billing.md b/content/rest/billing.md similarity index 55% rename from data/reusables/rest-reference/billing/billing.md rename to content/rest/billing.md index daefbe58a5..6f9ccd86a6 100644 --- a/data/reusables/rest-reference/billing/billing.md +++ b/content/rest/billing.md @@ -1 +1,15 @@ +--- +title: Billing +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.4' +redirect_from: + - /rest/reference/billing +--- + You can get billing information for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#billing)" REST API. \ No newline at end of file diff --git a/content/rest/branches/branch-protection.md b/content/rest/branches/branch-protection.md new file mode 100644 index 0000000000..e831cd0fea --- /dev/null +++ b/content/rest/branches/branch-protection.md @@ -0,0 +1,13 @@ +--- +title: Protected branches +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/content/rest/branches/branches.md b/content/rest/branches/branches.md new file mode 100644 index 0000000000..99f1050d0a --- /dev/null +++ b/content/rest/branches/branches.md @@ -0,0 +1,12 @@ +--- +title: Branches +intro: 'The Branches API allows you to modify branches and their protection settings.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/content/rest/reference/branches.md b/content/rest/branches/index.md similarity index 65% rename from content/rest/reference/branches.md rename to content/rest/branches/index.md index 636a339a75..6b13175895 100644 --- a/content/rest/reference/branches.md +++ b/content/rest/branches/index.md @@ -10,8 +10,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /branches + - /branch-protection +redirect_from: + - /rest/reference/branches --- - - diff --git a/content/rest/checks/index.md b/content/rest/checks/index.md new file mode 100644 index 0000000000..6b0e064cb8 --- /dev/null +++ b/content/rest/checks/index.md @@ -0,0 +1,20 @@ +--- +title: Checks +intro: 'With the Checks API, you can build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' +redirect_from: + - /v3/checks + - /rest/reference/checks +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /runs + - /suites +--- + +You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." \ No newline at end of file diff --git a/content/rest/checks/runs.md b/content/rest/checks/runs.md new file mode 100644 index 0000000000..c49d26fd02 --- /dev/null +++ b/content/rest/checks/runs.md @@ -0,0 +1,13 @@ +--- +title: Check Runs +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/data/reusables/rest-reference/checks/suites.md b/content/rest/checks/suites.md similarity index 66% rename from data/reusables/rest-reference/checks/suites.md rename to content/rest/checks/suites.md index 4b0bf46a16..9aec42aad3 100644 --- a/data/reusables/rest-reference/checks/suites.md +++ b/content/rest/checks/suites.md @@ -1,4 +1,16 @@ -## Check Suites +--- +title: Check Suites +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- {% note %} diff --git a/data/reusables/rest-reference/code-scanning/code-scanning.md b/content/rest/code-scanning.md similarity index 88% rename from data/reusables/rest-reference/code-scanning/code-scanning.md rename to content/rest/code-scanning.md index 01c90554fd..8c464645a9 100644 --- a/data/reusables/rest-reference/code-scanning/code-scanning.md +++ b/content/rest/code-scanning.md @@ -1,3 +1,20 @@ +--- +title: Code Scanning +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API + - Code scanning + - REST +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/code-scanning +--- + {% data reusables.code-scanning.beta %} The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[Finding security vulnerabilities and errors in your code](/github/finding-security-vulnerabilities-and-errors-in-your-code)." @@ -12,4 +29,4 @@ There is one supported custom media type for the {% data variables.product.prodn You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. For more information about this operation, see "[Get a {% data variables.product.prodname_code_scanning %} analysis for a repository](#get-a-code-scanning-analysis-for-a-repository)." When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than the summary of the analysis that's returned when you use the default media type. The response also includes additional data such as the `github/alertNumber` and `github/alertUrl` properties. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). For more information, see "[Media types](/rest/overview/media-types)." -{% endif %} \ No newline at end of file +{% endif %} diff --git a/data/reusables/rest-reference/codes-of-conduct/codes-of-conduct.md b/content/rest/codes-of-conduct.md similarity index 52% rename from data/reusables/rest-reference/codes-of-conduct/codes-of-conduct.md rename to content/rest/codes-of-conduct.md index 6dd6af4e64..dd96f59734 100644 --- a/data/reusables/rest-reference/codes-of-conduct/codes-of-conduct.md +++ b/content/rest/codes-of-conduct.md @@ -1,2 +1,16 @@ +--- +title: Codes of Conduct +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/codes-of-conduct +--- You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a repository's code of conduct, use the "[Get a repository](/rest/reference/repos#get-a-repository)" endpoint. \ No newline at end of file diff --git a/data/reusables/rest-reference/codespaces/codespaces.md b/content/rest/codespaces/codespaces.md similarity index 66% rename from data/reusables/rest-reference/codespaces/codespaces.md rename to content/rest/codespaces/codespaces.md index 5f73ea28b0..11d920b1c2 100644 --- a/data/reusables/rest-reference/codespaces/codespaces.md +++ b/content/rest/codespaces/codespaces.md @@ -1,3 +1,14 @@ +--- +title: Codespaces +intro: 'The Codespaces API enables you to manage your codespaces using the REST API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + {% data reusables.codespaces.codespaces-api-beta-note %} -The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)." \ No newline at end of file +The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)." diff --git a/content/rest/reference/codespaces.md b/content/rest/codespaces/index.md similarity index 68% rename from content/rest/reference/codespaces.md rename to content/rest/codespaces/index.md index 11f28ca643..d97a0755c0 100644 --- a/content/rest/reference/codespaces.md +++ b/content/rest/codespaces/index.md @@ -8,8 +8,11 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /codespaces + - /machines + - /repository-secrets + - /secrets +redirect_from: + - /rest/reference/codespaces --- - - \ No newline at end of file diff --git a/content/rest/codespaces/machines.md b/content/rest/codespaces/machines.md new file mode 100644 index 0000000000..b39416253f --- /dev/null +++ b/content/rest/codespaces/machines.md @@ -0,0 +1,14 @@ +--- +title: Machines +intro: 'The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)." + +You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)." \ No newline at end of file diff --git a/data/reusables/rest-reference/codespaces/repository-secrets.md b/content/rest/codespaces/repository-secrets.md similarity index 56% rename from data/reusables/rest-reference/codespaces/repository-secrets.md rename to content/rest/codespaces/repository-secrets.md index 83ead676f1..ccab41f36e 100644 --- a/data/reusables/rest-reference/codespaces/repository-secrets.md +++ b/content/rest/codespaces/repository-secrets.md @@ -1,2 +1,15 @@ +--- +title: Repository Secrets +intro: 'The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.5' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + ## Repository Secrets -The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." + +The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/data/reusables/rest-reference/codespaces/secrets.md b/content/rest/codespaces/secrets.md similarity index 55% rename from data/reusables/rest-reference/codespaces/secrets.md rename to content/rest/codespaces/secrets.md index 72cf1f4e0e..fb315dc8ce 100644 --- a/data/reusables/rest-reference/codespaces/secrets.md +++ b/content/rest/codespaces/secrets.md @@ -1,2 +1,15 @@ +--- +title: User Secrets +intro: 'The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + ## User Secrets + The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/content/rest/collaborators/collaborators.md b/content/rest/collaborators/collaborators.md new file mode 100644 index 0000000000..e2c617d39f --- /dev/null +++ b/content/rest/collaborators/collaborators.md @@ -0,0 +1,12 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/reference/collaborators.md b/content/rest/collaborators/index.md similarity index 50% rename from content/rest/reference/collaborators.md rename to content/rest/collaborators/index.md index 783b81feaa..925f1ff4e9 100644 --- a/content/rest/reference/collaborators.md +++ b/content/rest/collaborators/index.md @@ -1,6 +1,6 @@ --- title: Collaborators -intro: 'The collaborators API allows you to add, invite, and remove collaborators from a repository.' +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -10,8 +10,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /collaborators + - /invitations +redirect_from: + - /rest/reference/collaborators --- - - diff --git a/content/rest/collaborators/invitations.md b/content/rest/collaborators/invitations.md new file mode 100644 index 0000000000..502e22608a --- /dev/null +++ b/content/rest/collaborators/invitations.md @@ -0,0 +1,22 @@ +--- +title: Invitations +intro: 'The Repository Invitations API allows users or external services to invite other users to collaborate on a repo.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. + +Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted +access to invitations **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as invitations. + +### Invite a user to a repository + +Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/collaborators/collaborators#add-a-repository-collaborator)." \ No newline at end of file diff --git a/data/reusables/rest-reference/commits/comments.md b/content/rest/commits/comments.md similarity index 72% rename from data/reusables/rest-reference/commits/comments.md rename to content/rest/commits/comments.md index 4714391413..34ff1e9f90 100644 --- a/data/reusables/rest-reference/commits/comments.md +++ b/content/rest/commits/comments.md @@ -1,4 +1,16 @@ -## Commit comments +--- +title: Commit comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- ### Custom media types for commit comments diff --git a/content/rest/commits/commits.md b/content/rest/commits/commits.md new file mode 100644 index 0000000000..8b0fa3f792 --- /dev/null +++ b/content/rest/commits/commits.md @@ -0,0 +1,12 @@ +--- +title: Commits +intro: 'The Commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/content/rest/reference/commits.md b/content/rest/commits/index.md similarity index 71% rename from content/rest/reference/commits.md rename to content/rest/commits/index.md index 953008d164..425b0999cf 100644 --- a/content/rest/reference/commits.md +++ b/content/rest/commits/index.md @@ -10,8 +10,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /commits + - /comments + - /statuses +redirect_from: + - /rest/reference/commits --- - - diff --git a/content/rest/commits/statuses.md b/content/rest/commits/statuses.md new file mode 100644 index 0000000000..27050e2439 --- /dev/null +++ b/content/rest/commits/statuses.md @@ -0,0 +1,23 @@ +--- +title: Commit statuses +intro: 'The status API allows external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Statuses can also include an optional `description` and `target_url`, and we highly recommend providing them as they make statuses much more useful in the GitHub UI. + +As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The `target_url` would be the full URL to the build output, and the `description` would be the high level summary of what happened with the build. + +Statuses can include a `context` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. + +Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the `repo` scope grants permission to code as well as statuses. + +If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks). \ No newline at end of file diff --git a/content/rest/dependabot/index.md b/content/rest/dependabot/index.md new file mode 100644 index 0000000000..9de244ec7d --- /dev/null +++ b/content/rest/dependabot/index.md @@ -0,0 +1,16 @@ +--- +title: Dependabot +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /secrets +redirect_from: + - /rest/reference/dependabot +--- diff --git a/data/reusables/rest-reference/dependabot/dependabot.md b/content/rest/dependabot/secrets.md similarity index 72% rename from data/reusables/rest-reference/dependabot/dependabot.md rename to content/rest/dependabot/secrets.md index a57f79b757..f57bff7358 100644 --- a/data/reusables/rest-reference/dependabot/dependabot.md +++ b/content/rest/dependabot/secrets.md @@ -1,3 +1,15 @@ +--- +title: Secrets +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +topics: + - API +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +allowTitleToDifferFromFilename: true +--- + The {% data variables.product.prodname_dependabot %} Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)." {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/data/reusables/rest-reference/dependency-graph/dependency-review.md b/content/rest/dependency-graph/dependency-review.md similarity index 62% rename from data/reusables/rest-reference/dependency-graph/dependency-review.md rename to content/rest/dependency-graph/dependency-review.md index 084e89c11f..b08e657b46 100644 --- a/data/reusables/rest-reference/dependency-graph/dependency-review.md +++ b/content/rest/dependency-graph/dependency-review.md @@ -1,3 +1,17 @@ +--- +title: Dependency Review +intro: 'The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment.' +versions: + fpt: '*' + ghes: '>=3.6' + ghec: '*' + ghae: 'issue-6396' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + ## Dependency review {% data reusables.dependency-review.dependency-review-api-beta-note %} diff --git a/content/rest/reference/dependency-graph.md b/content/rest/dependency-graph/index.md similarity index 59% rename from content/rest/reference/dependency-graph.md rename to content/rest/dependency-graph/index.md index 44e8ce9334..393c5eaa5c 100644 --- a/content/rest/reference/dependency-graph.md +++ b/content/rest/dependency-graph/index.md @@ -1,5 +1,5 @@ --- -title: Dependency graph +title: Dependency Graph intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.' versions: fpt: '*' @@ -9,8 +9,8 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /dependency-review +redirect_from: + - /rest/reference/dependency-graph --- - - \ No newline at end of file diff --git a/data/reusables/rest-reference/deploy_keys/deploy_keys.md b/content/rest/deploy-keys.md similarity index 53% rename from data/reusables/rest-reference/deploy_keys/deploy_keys.md rename to content/rest/deploy-keys.md index 008b8ba133..0158b1194b 100644 --- a/data/reusables/rest-reference/deploy_keys/deploy_keys.md +++ b/content/rest/deploy-keys.md @@ -1,3 +1,19 @@ +--- +title: Deploy Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/deploy_keys +--- + {% data reusables.repositories.deploy-keys %} Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)." \ No newline at end of file diff --git a/data/reusables/rest-reference/deployments/deployments.md b/content/rest/deployments/deployments.md similarity index 93% rename from data/reusables/rest-reference/deployments/deployments.md rename to content/rest/deployments/deployments.md index 71ce02d30f..84f4f9eea3 100644 --- a/data/reusables/rest-reference/deployments/deployments.md +++ b/content/rest/deployments/deployments.md @@ -1,3 +1,16 @@ +--- +title: Deployments +intro: 'The Deployments API allows you to create and delete deployments and deployment environments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume. @@ -44,4 +57,4 @@ Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth- When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status. -You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. \ No newline at end of file +You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. diff --git a/content/rest/deployments/environments.md b/content/rest/deployments/environments.md new file mode 100644 index 0000000000..1d90c1aa6b --- /dev/null +++ b/content/rest/deployments/environments.md @@ -0,0 +1,16 @@ +--- +title: Environments +intro: 'The Environments API allows you to create, configure, and delete environments.' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." + +{% data reusables.gated-features.environments %} \ No newline at end of file diff --git a/content/rest/reference/deployments.md b/content/rest/deployments/index.md similarity index 57% rename from content/rest/reference/deployments.md rename to content/rest/deployments/index.md index 23d5e0a4ab..c92c19aec6 100644 --- a/content/rest/reference/deployments.md +++ b/content/rest/deployments/index.md @@ -1,6 +1,6 @@ --- title: Deployments -intro: 'The deployments API allows you to create and delete deployments and deployment environments.' +intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -10,8 +10,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /deployments + - /environments + - /statuses +redirect_from: + - /rest/reference/deployments --- - - diff --git a/content/rest/deployments/statuses.md b/content/rest/deployments/statuses.md new file mode 100644 index 0000000000..0896d48e75 --- /dev/null +++ b/content/rest/deployments/statuses.md @@ -0,0 +1,13 @@ +--- +title: Deployment Statuses +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/content/rest/reference/emojis.md b/content/rest/emojis.md similarity index 63% rename from content/rest/reference/emojis.md rename to content/rest/emojis.md index a6aad64794..ca45960388 100644 --- a/content/rest/reference/emojis.md +++ b/content/rest/emojis.md @@ -1,9 +1,6 @@ --- title: Emojis intro: 'With the Emojis API, you can list and view all the available emojis to use in {% data variables.product.product_name %}.' -redirect_from: - - /v3/emojis - - /v3/misc versions: fpt: '*' ghes: '*' @@ -12,8 +9,6 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/emojis --- - - \ No newline at end of file diff --git a/content/rest/enterprise-admin/admin-stats.md b/content/rest/enterprise-admin/admin-stats.md new file mode 100644 index 0000000000..d18be10342 --- /dev/null +++ b/content/rest/enterprise-admin/admin-stats.md @@ -0,0 +1,12 @@ +--- +title: Admin stats +intro: 'The Admin Stats API provides a variety of metrics about your installation.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/announcements.md b/content/rest/enterprise-admin/announcement.md similarity index 51% rename from data/reusables/rest-reference/enterprise-admin/announcements.md rename to content/rest/enterprise-admin/announcement.md index 2596c77515..05a248af24 100644 --- a/data/reusables/rest-reference/enterprise-admin/announcements.md +++ b/content/rest/enterprise-admin/announcement.md @@ -1,3 +1,14 @@ -## Announcements +--- +title: Announcement +intro: 'The Announcement API allows you to manage the global announcement banner in your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." +## Announcement + +The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." \ No newline at end of file diff --git a/content/rest/enterprise-admin/audit-log.md b/content/rest/enterprise-admin/audit-log.md new file mode 100644 index 0000000000..7fa5096e21 --- /dev/null +++ b/content/rest/enterprise-admin/audit-log.md @@ -0,0 +1,11 @@ +--- +title: Audit log +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/enterprise-admin/billing.md b/content/rest/enterprise-admin/billing.md new file mode 100644 index 0000000000..15f8a05d8f --- /dev/null +++ b/content/rest/enterprise-admin/billing.md @@ -0,0 +1,11 @@ +--- +title: Billing +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/enterprise-admin/global-webhooks.md b/content/rest/enterprise-admin/global-webhooks.md new file mode 100644 index 0000000000..b14fc8ab70 --- /dev/null +++ b/content/rest/enterprise-admin/global-webhooks.md @@ -0,0 +1,14 @@ +--- +title: Global Webhooks +intro: 'Global Webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. + +*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/enterprise-admin.md b/content/rest/enterprise-admin/index.md similarity index 79% rename from data/reusables/rest-reference/enterprise-admin/enterprise-admin.md rename to content/rest/enterprise-admin/index.md index 82ba528717..2845bef7e0 100644 --- a/data/reusables/rest-reference/enterprise-admin/enterprise-admin.md +++ b/content/rest/enterprise-admin/index.md @@ -1,3 +1,38 @@ +--- +title: GitHub Enterprise administration +intro: You can use these endpoints to administer your enterprise. +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/enterprise-admin + - /v3/enterprise + - /rest/reference/enterprise-admin +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +shortTitle: Enterprise administration +children: + - /admin-stats + - /announcement + - /audit-log + - /billing + - /global-webhooks + - /ldap + - /license + - /management-console + - /org-pre-receive-hooks + - /orgs + - /pre-receive-environments + - /pre-receive-hooks + - /repo-pre-receive-hooks + - /users + - /scim +--- + {% ifversion fpt or ghec %} {% note %} diff --git a/data/reusables/rest-reference/enterprise-admin/ldap.md b/content/rest/enterprise-admin/ldap.md similarity index 61% rename from data/reusables/rest-reference/enterprise-admin/ldap.md rename to content/rest/enterprise-admin/ldap.md index 1b1188e0d1..af2f31c0a7 100644 --- a/data/reusables/rest-reference/enterprise-admin/ldap.md +++ b/content/rest/enterprise-admin/ldap.md @@ -1,5 +1,11 @@ -## LDAP - -You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization. +--- +title: LDAP +intro: 'You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. \ No newline at end of file diff --git a/content/rest/enterprise-admin/license.md b/content/rest/enterprise-admin/license.md new file mode 100644 index 0000000000..2fd64bd48e --- /dev/null +++ b/content/rest/enterprise-admin/license.md @@ -0,0 +1,12 @@ +--- +title: License +intro: 'The License API provides information on your Enterprise license.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/management-console.md b/content/rest/enterprise-admin/management-console.md similarity index 85% rename from data/reusables/rest-reference/enterprise-admin/management-console.md rename to content/rest/enterprise-admin/management-console.md index 5fb70035c2..5e9f95ee02 100644 --- a/data/reusables/rest-reference/enterprise-admin/management-console.md +++ b/content/rest/enterprise-admin/management-console.md @@ -1,6 +1,12 @@ -## Management console - -The Management Console API helps you manage your {% data variables.product.product_name %} installation. +--- +title: Management Console +intro: 'The Management Console API helps you manage your {% data variables.product.product_name %} installation.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- {% tip %} diff --git a/data/reusables/rest-reference/enterprise-admin/org-pre-receive-hooks.md b/content/rest/enterprise-admin/org-pre-receive-hooks.md similarity index 60% rename from data/reusables/rest-reference/enterprise-admin/org-pre-receive-hooks.md rename to content/rest/enterprise-admin/org-pre-receive-hooks.md index b15736148b..bc8b8b31ea 100644 --- a/data/reusables/rest-reference/enterprise-admin/org-pre-receive-hooks.md +++ b/content/rest/enterprise-admin/org-pre-receive-hooks.md @@ -1,7 +1,13 @@ -## Organization pre-receive hooks - -The Organization Pre-receive Hooks API allows you to view and modify -enforcement of the pre-receive hooks that are available to an organization. +--- +title: Organization Pre-receive Hooks +intro: 'The Organization Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to an organization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- ### Object attributes @@ -12,8 +18,6 @@ enforcement of the pre-receive hooks that are available to an organization. | `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | | `configuration_url` | `string` | URL for the endpoint where enforcement is set. | -Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject -any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. -`configuration_url` may be a link to this endpoint or this hook's global -configuration. Only site admins are able to access the global configuration. \ No newline at end of file +`configuration_url` may be a link to this endpoint or this hook's global configuration. Only site admins are able to access the global configuration. \ No newline at end of file diff --git a/content/rest/enterprise-admin/orgs.md b/content/rest/enterprise-admin/orgs.md new file mode 100644 index 0000000000..f8fdc559dc --- /dev/null +++ b/content/rest/enterprise-admin/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: 'The Organization Administration API allows you to create organizations on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/pre-receive-environments.md b/content/rest/enterprise-admin/pre-receive-environments.md similarity index 77% rename from data/reusables/rest-reference/enterprise-admin/pre-receive-environments.md rename to content/rest/enterprise-admin/pre-receive-environments.md index cd6495a194..feb2ce08b5 100644 --- a/data/reusables/rest-reference/enterprise-admin/pre-receive-environments.md +++ b/content/rest/enterprise-admin/pre-receive-environments.md @@ -1,6 +1,15 @@ -## Pre-receive environments +--- +title: Pre-receive Environments +intro: 'The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. ### Object attributes diff --git a/data/reusables/rest-reference/enterprise-admin/pre-receive-hooks.md b/content/rest/enterprise-admin/pre-receive-hooks.md similarity index 76% rename from data/reusables/rest-reference/enterprise-admin/pre-receive-hooks.md rename to content/rest/enterprise-admin/pre-receive-hooks.md index fe92c92523..08d5c5f3ce 100644 --- a/data/reusables/rest-reference/enterprise-admin/pre-receive-hooks.md +++ b/content/rest/enterprise-admin/pre-receive-hooks.md @@ -1,7 +1,14 @@ -## Pre-receive hooks +--- +title: Pre-receive Hooks +intro: 'The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks. *It is only available to -[authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. ### Object attributes diff --git a/data/reusables/rest-reference/enterprise-admin/repo-pre-receive-hooks.md b/content/rest/enterprise-admin/repo-pre-receive-hooks.md similarity index 77% rename from data/reusables/rest-reference/enterprise-admin/repo-pre-receive-hooks.md rename to content/rest/enterprise-admin/repo-pre-receive-hooks.md index 97e2a1b20b..831ca1a06a 100644 --- a/data/reusables/rest-reference/enterprise-admin/repo-pre-receive-hooks.md +++ b/content/rest/enterprise-admin/repo-pre-receive-hooks.md @@ -1,7 +1,13 @@ -## Repository pre-receive hooks - -The Repository Pre-receive Hooks API allows you to view and modify -enforcement of the pre-receive hooks that are available to a repository. +--- +title: Repository Pre-receive Hooks +intro: 'The Repository Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to a repository.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- ### Object attributes diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md new file mode 100644 index 0000000000..326d333cbf --- /dev/null +++ b/content/rest/enterprise-admin/scim.md @@ -0,0 +1,11 @@ +--- +title: SCIM +intro: '' +versions: + fpt: '*' + ghec: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/enterprise-admin/users.md b/content/rest/enterprise-admin/users.md new file mode 100644 index 0000000000..6d9aea56c7 --- /dev/null +++ b/content/rest/enterprise-admin/users.md @@ -0,0 +1,12 @@ +--- +title: Users +intro: 'The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. \ No newline at end of file diff --git a/data/reusables/rest-reference/gists/comments.md b/content/rest/gists/comments.md similarity index 67% rename from data/reusables/rest-reference/gists/comments.md rename to content/rest/gists/comments.md index 096163d51e..9b01fd1f71 100644 --- a/data/reusables/rest-reference/gists/comments.md +++ b/content/rest/gists/comments.md @@ -1,4 +1,15 @@ -## Comments +--- +title: Comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- ### Custom media types for Gist comments diff --git a/data/reusables/rest-reference/gists/gists.md b/content/rest/gists/gists.md similarity index 88% rename from data/reusables/rest-reference/gists/gists.md rename to content/rest/gists/gists.md index db412786b3..5cb6fef354 100644 --- a/data/reusables/rest-reference/gists/gists.md +++ b/content/rest/gists/gists.md @@ -1,3 +1,16 @@ +--- +title: Gists +intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on GitHub.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + ### Authentication You can read public gists {% ifversion ghae or ghes %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." @@ -19,4 +32,4 @@ These are the supported media types for fetching gist contents. application/vnd.github.VERSION.raw application/vnd.github.VERSION.base64 -For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file +For more information, see "[Media types](/rest/overview/media-types)." diff --git a/translations/pt-BR/content/rest/reference/gists.md b/content/rest/gists/index.md similarity index 70% rename from translations/pt-BR/content/rest/reference/gists.md rename to content/rest/gists/index.md index 7bc85d1bad..7c9ddbab2c 100644 --- a/translations/pt-BR/content/rest/reference/gists.md +++ b/content/rest/gists/index.md @@ -3,6 +3,7 @@ title: Gists intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on {% data variables.product.product_name %}.' redirect_from: - /v3/gists + - /rest/reference/gists versions: fpt: '*' ghes: '*' @@ -11,8 +12,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /gists + - /comments --- - - \ No newline at end of file diff --git a/data/reusables/rest-reference/git/blobs.md b/content/rest/git/blobs.md similarity index 51% rename from data/reusables/rest-reference/git/blobs.md rename to content/rest/git/blobs.md index d4d4d65f86..a4df5aca84 100644 --- a/data/reusables/rest-reference/git/blobs.md +++ b/content/rest/git/blobs.md @@ -1,6 +1,17 @@ -## Blobs +--- +title: Blobs +intro: 'A Git blob (binary large object) is the object type used to store the contents of each file in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -A Git blob (binary large object) is the object type used to store the contents of each file in a repository. The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) +The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) to your Git database on {% data variables.product.product_name %}. Blobs leverage [these custom media types](#custom-media-types-for-blobs). You can read more about the use of media types in the API [here](/rest/overview/media-types). ### Custom media types for blobs diff --git a/content/rest/git/commits.md b/content/rest/git/commits.md new file mode 100644 index 0000000000..18c14bb2ac --- /dev/null +++ b/content/rest/git/commits.md @@ -0,0 +1,14 @@ +--- +title: Commits +intro: 'A Git commit is a snapshot of the hierarchy ([Git tree](/rest/reference/git#trees)) and the contents of the files ([Git blob](/rest/reference/git#blobs)) in a Git repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/content/rest/git/index.md b/content/rest/git/index.md new file mode 100644 index 0000000000..da1de11653 --- /dev/null +++ b/content/rest/git/index.md @@ -0,0 +1,24 @@ +--- +title: Git database +intro: 'The Git Database API enables you to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update Git references (branch heads and tags).' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/git + - /rest/reference/git +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /blobs + - /commits + - /refs + - /tags + - /trees +--- + +The Git Database API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the Git Database API, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)." \ No newline at end of file diff --git a/content/rest/git/refs.md b/content/rest/git/refs.md new file mode 100644 index 0000000000..55b5f8122a --- /dev/null +++ b/content/rest/git/refs.md @@ -0,0 +1,15 @@ +--- +title: References +intro: 'A Git reference (`git ref`) is just a file that contains a Git commit SHA-1 hash.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is just a Git reference that stores the new Git commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v1/Git-Internals-Git-References) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/content/rest/git/tags.md b/content/rest/git/tags.md new file mode 100644 index 0000000000..101fde046a --- /dev/null +++ b/content/rest/git/tags.md @@ -0,0 +1,14 @@ +--- +title: Tags +intro: 'A Git tag is similar to a [Git reference](/rest/reference/git#refs), but the Git commit that it points to never changes.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags) to your Git database on {% data variables.product.product_name %}. The Git tags API only supports [annotated tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags), not lightweight tags. diff --git a/content/rest/git/trees.md b/content/rest/git/trees.md new file mode 100644 index 0000000000..7471c1d66a --- /dev/null +++ b/content/rest/git/trees.md @@ -0,0 +1,14 @@ +--- +title: Trees +intro: 'A Git tree object creates the hierarchy between files in a Git repository. ' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/data/reusables/rest-reference/gitignore/gitignore.md b/content/rest/gitignore.md similarity index 71% rename from data/reusables/rest-reference/gitignore/gitignore.md rename to content/rest/gitignore.md index ac6d29591f..0a641c3994 100644 --- a/data/reusables/rest-reference/gitignore/gitignore.md +++ b/content/rest/gitignore.md @@ -1,3 +1,18 @@ +--- +title: Gitignore +intro: 'The Gitignore API fetches `.gitignore` templates that can be used to ignore files and directories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/gitignore +--- + When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). ### Custom media types for gitignore diff --git a/content/rest/index.md b/content/rest/index.md index d27742aeca..773fa86484 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -31,7 +31,49 @@ versions: ghec: '*' children: - /overview - - /reference - /guides + - /actions + - /activity + - /apps + - /billing + - /branches + - /checks + - /codes-of-conduct + - /code-scanning + - /codespaces + - /collaborators + - /commits + - /dependabot + - /dependency-graph + - /deploy-keys + - /deployments + - /emojis + - /enterprise-admin + - /gists + - /git + - /gitignore + - /interactions + - /issues + - /licenses + - /markdown + - /meta + - /metrics + - /migrations + - /oauth-authorizations + - /orgs + - /packages + - /pages + - /projects + - /pulls + - /rate-limit + - /reactions + - /releases + - /repos + - /scim + - /search + - /secret-scanning + - /teams + - /users + - /webhooks --- diff --git a/content/rest/interactions/index.md b/content/rest/interactions/index.md new file mode 100644 index 0000000000..10c5349a73 --- /dev/null +++ b/content/rest/interactions/index.md @@ -0,0 +1,19 @@ +--- +title: Interactions +intro: 'With the Interactions API, people with owner or admin access can set the interaction limit for the users in their organizations and repositories.' +redirect_from: + - /v3/interactions + - /rest/reference/interactions +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /repos + - /user +--- + +Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. \ No newline at end of file diff --git a/data/reusables/rest-reference/interactions/orgs.md b/content/rest/interactions/orgs.md similarity index 55% rename from data/reusables/rest-reference/interactions/orgs.md rename to content/rest/interactions/orgs.md index ad526ccc02..2185e2bb46 100644 --- a/data/reusables/rest-reference/interactions/orgs.md +++ b/content/rest/interactions/orgs.md @@ -1,6 +1,16 @@ -## Organization +--- +title: Organization +intro: "The Organization Interactions API allows organization owners to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories." +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- -The Organization Interactions API allows organization owners to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: * {% data reusables.interactions.existing-user-limit-definition %} in the organization. * {% data reusables.interactions.contributor-user-limit-definition %} in the organization. diff --git a/data/reusables/rest-reference/interactions/repos.md b/content/rest/interactions/repos.md similarity index 53% rename from data/reusables/rest-reference/interactions/repos.md rename to content/rest/interactions/repos.md index 517b3406ba..5bba6ae46d 100644 --- a/data/reusables/rest-reference/interactions/repos.md +++ b/content/rest/interactions/repos.md @@ -1,6 +1,16 @@ -## Repository +--- +title: Repository +intro: 'The Repository Interactions API allows people with owner or admin access to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- -The Repository Interactions API allows people with owner or admin access to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: * {% data reusables.interactions.existing-user-limit-definition %} in the repository. * {% data reusables.interactions.contributor-user-limit-definition %} in the repository. diff --git a/data/reusables/rest-reference/interactions/users.md b/content/rest/interactions/user.md similarity index 61% rename from data/reusables/rest-reference/interactions/users.md rename to content/rest/interactions/user.md index 6830e46b91..b7fa0c6174 100644 --- a/data/reusables/rest-reference/interactions/users.md +++ b/content/rest/interactions/user.md @@ -1,6 +1,15 @@ -## User +--- +title: User +intro: 'The User Interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -The User Interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: * {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. * {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. diff --git a/content/rest/issues/assignees.md b/content/rest/issues/assignees.md new file mode 100644 index 0000000000..3d465a739e --- /dev/null +++ b/content/rest/issues/assignees.md @@ -0,0 +1,12 @@ +--- +title: Assignees +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/issues/comments.md b/content/rest/issues/comments.md new file mode 100644 index 0000000000..9d68676a6a --- /dev/null +++ b/content/rest/issues/comments.md @@ -0,0 +1,14 @@ +--- +title: Comments +intro: 'The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Issue Comments use [these custom media types](#custom-media-types). You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/content/rest/issues/events.md b/content/rest/issues/events.md new file mode 100644 index 0000000000..e6eaa7a53c --- /dev/null +++ b/content/rest/issues/events.md @@ -0,0 +1,14 @@ +--- +title: Events +intro: 'The Issue Events API can return different types of events triggered by activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[Events API](/developers/webhooks-and-events/github-event-types)." \ No newline at end of file diff --git a/content/rest/reference/issues.md b/content/rest/issues/index.md similarity index 67% rename from content/rest/reference/issues.md rename to content/rest/issues/index.md index 3682dfa0cb..11fae409e7 100644 --- a/content/rest/reference/issues.md +++ b/content/rest/issues/index.md @@ -3,6 +3,7 @@ title: Issues intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' redirect_from: - /v3/issues + - /rest/reference/issues versions: fpt: '*' ghes: '*' @@ -11,8 +12,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /issues + - /assignees + - /comments + - /events + - /labels + - /milestones + - /timeline --- - - \ No newline at end of file diff --git a/data/reusables/rest-reference/issues/issues.md b/content/rest/issues/issues.md similarity index 59% rename from data/reusables/rest-reference/issues/issues.md rename to content/rest/issues/issues.md index 6c5e372c91..630bf7315f 100644 --- a/data/reusables/rest-reference/issues/issues.md +++ b/content/rest/issues/issues.md @@ -1,3 +1,16 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + ### Custom media types for issues These are the supported media types for issues. diff --git a/content/rest/issues/labels.md b/content/rest/issues/labels.md new file mode 100644 index 0000000000..c2d910ec3e --- /dev/null +++ b/content/rest/issues/labels.md @@ -0,0 +1,12 @@ +--- +title: Labels +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/issues/milestones.md b/content/rest/issues/milestones.md new file mode 100644 index 0000000000..2ae71632ba --- /dev/null +++ b/content/rest/issues/milestones.md @@ -0,0 +1,12 @@ +--- +title: Milestones +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/issues/timeline.md b/content/rest/issues/timeline.md new file mode 100644 index 0000000000..4d7a73e4ca --- /dev/null +++ b/content/rest/issues/timeline.md @@ -0,0 +1,16 @@ +--- +title: Timeline +intro: 'The Timeline Events API can return different types of events triggered by timeline activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[GitHub Events API](/developers/webhooks-and-events/github-event-types)." + +You can use this API to display information about issues and pull request or determine who should be notified of issue comments. \ No newline at end of file diff --git a/data/reusables/rest-reference/licenses/licenses.md b/content/rest/licenses.md similarity index 87% rename from data/reusables/rest-reference/licenses/licenses.md rename to content/rest/licenses.md index 095dcf1599..78619bfa73 100644 --- a/data/reusables/rest-reference/licenses/licenses.md +++ b/content/rest/licenses.md @@ -1,4 +1,17 @@ -The Licenses API returns metadata about popular open source licenses and information about a particular project's license file. +--- +title: Licenses +intro: "The Licenses API lets you to retrieve popular open source licenses and information about a particular project's license file." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/licenses +--- The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's `LICENSE` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation. diff --git a/content/rest/markdown.md b/content/rest/markdown.md new file mode 100644 index 0000000000..2f782424e3 --- /dev/null +++ b/content/rest/markdown.md @@ -0,0 +1,14 @@ +--- +title: Markdown +intro: 'The Markdown API enables you to render a markdown document as an HTML page or as raw text.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/markdown +--- diff --git a/content/rest/reference/meta.md b/content/rest/meta.md similarity index 69% rename from content/rest/reference/meta.md rename to content/rest/meta.md index 4beebe17ec..6ecb71fe20 100644 --- a/content/rest/reference/meta.md +++ b/content/rest/meta.md @@ -1,8 +1,6 @@ --- title: Meta intro: 'The Meta API returns meta information about {% data variables.product.product_name %} including the IP addresses of {% data variables.product.product_name %} services.' -redirect_from: - - /v3/meta versions: fpt: '*' ghes: '*' @@ -11,8 +9,6 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/meta --- - - \ No newline at end of file diff --git a/content/rest/metrics/community.md b/content/rest/metrics/community.md new file mode 100644 index 0000000000..725ad20ea0 --- /dev/null +++ b/content/rest/metrics/community.md @@ -0,0 +1,10 @@ +--- +title: Community +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/reference/metrics.md b/content/rest/metrics/index.md similarity index 72% rename from content/rest/reference/metrics.md rename to content/rest/metrics/index.md index 1f00b23b60..4f450b3a9e 100644 --- a/content/rest/reference/metrics.md +++ b/content/rest/metrics/index.md @@ -4,6 +4,7 @@ intro: 'The repository metrics API allows you to retrieve community profile, sta allowTitleToDifferFromFilename: true redirect_from: - /rest/reference/repository-metrics + - /rest/reference/metrics versions: fpt: '*' ghes: '*' @@ -12,8 +13,8 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /community + - /statistics + - /traffic --- - - diff --git a/data/reusables/rest-reference/metrics/statistics.md b/content/rest/metrics/statistics.md similarity index 76% rename from data/reusables/rest-reference/metrics/statistics.md rename to content/rest/metrics/statistics.md index 7be216fb94..955c527812 100644 --- a/data/reusables/rest-reference/metrics/statistics.md +++ b/content/rest/metrics/statistics.md @@ -1,7 +1,15 @@ -## Statistics - -The Repository Statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different -types of repository activity. +--- +title: Statistics +intro: 'The Repository Statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different types of repository activity.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- ### A word about caching diff --git a/content/rest/metrics/traffic.md b/content/rest/metrics/traffic.md new file mode 100644 index 0000000000..9360f43231 --- /dev/null +++ b/content/rest/metrics/traffic.md @@ -0,0 +1,12 @@ +--- +title: Traffic +intro: 'For repositories that you have push access to, the traffic API provides access to the information provided in your repository graph. ' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "Viewing traffic to a repository." \ No newline at end of file diff --git a/content/rest/reference/migrations.md b/content/rest/migrations/index.md similarity index 73% rename from content/rest/reference/migrations.md rename to content/rest/migrations/index.md index 1cd898ac4f..46ce2d736a 100644 --- a/content/rest/reference/migrations.md +++ b/content/rest/migrations/index.md @@ -5,16 +5,17 @@ redirect_from: - /v3/migrations - /v3/migration - /v3/migration/migrations + - /rest/reference/migrations versions: fpt: '*' ghec: '*' ghes: '>3.3' - ghae: issue-6184 + ghae: '*' topics: - API miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /source-imports + - /users --- - - \ No newline at end of file diff --git a/content/rest/migrations/orgs.md b/content/rest/migrations/orgs.md new file mode 100644 index 0000000000..4ee5218d95 --- /dev/null +++ b/content/rest/migrations/orgs.md @@ -0,0 +1,17 @@ +--- +title: Organization +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.organization_migrations_intro %} \ No newline at end of file diff --git a/data/reusables/rest-reference/migrations/source-imports.md b/content/rest/migrations/source-imports.md similarity index 97% rename from data/reusables/rest-reference/migrations/source-imports.md rename to content/rest/migrations/source-imports.md index c7b46c0a0e..01bd775089 100644 --- a/data/reusables/rest-reference/migrations/source-imports.md +++ b/content/rest/migrations/source-imports.md @@ -1,6 +1,13 @@ -## Source imports - -{% data variables.migrations.source_imports_intro %} +--- +title: Source Imports +intro: '{% data variables.migrations.source_imports_intro %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) to find out the status of the import. diff --git a/data/reusables/rest-reference/migrations/users.md b/content/rest/migrations/users.md similarity index 67% rename from data/reusables/rest-reference/migrations/users.md rename to content/rest/migrations/users.md index d6d76f3ef6..185cc1a43e 100644 --- a/data/reusables/rest-reference/migrations/users.md +++ b/content/rest/migrations/users.md @@ -1,6 +1,17 @@ -## User +--- +title: Users +intro: 'The Users migrations API is only available to authenticated account owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -The User migrations API is only available to authenticated account owners. For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)." +For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)." {% data variables.migrations.user_migrations_intro %} For a list of migration data that you can download, see "[Download a user migration archive](#download-a-user-migration-archive)." diff --git a/data/reusables/rest-reference/oauth-authorizations/oauth-authorizations.md b/content/rest/oauth-authorizations.md similarity index 63% rename from data/reusables/rest-reference/oauth-authorizations/oauth-authorizations.md rename to content/rest/oauth-authorizations.md index c826a88c9c..2f6e8fab75 100644 --- a/data/reusables/rest-reference/oauth-authorizations/oauth-authorizations.md +++ b/content/rest/oauth-authorizations.md @@ -1,3 +1,17 @@ +--- +title: OAuth Authorizations +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/oauth-authorizations +--- + You can use this API to manage the access OAuth applications have to your account. You can only access this API via [Basic Authentication](/rest/overview/other-authentication-methods#basic-authentication) using your username and password, not tokens. If you or your users have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication). \ No newline at end of file diff --git a/data/reusables/rest-reference/orgs/blocking.md b/content/rest/orgs/blocking.md similarity index 53% rename from data/reusables/rest-reference/orgs/blocking.md rename to content/rest/orgs/blocking.md index 6b741c646f..9e0982fa5d 100644 --- a/data/reusables/rest-reference/orgs/blocking.md +++ b/content/rest/orgs/blocking.md @@ -1,3 +1,13 @@ -## Blocking users +--- +title: Blocking users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- The token used to authenticate the call must have the `admin:org` scope in order to make any blocking calls for an organization. Otherwise, the response returns `HTTP 404`. \ No newline at end of file diff --git a/content/rest/orgs/custom-roles.md b/content/rest/orgs/custom-roles.md new file mode 100644 index 0000000000..6944dff7d0 --- /dev/null +++ b/content/rest/orgs/custom-roles.md @@ -0,0 +1,14 @@ +--- +title: Custom Repository Roles +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/orgs/custom_roles +--- diff --git a/content/rest/reference/orgs.md b/content/rest/orgs/index.md similarity index 71% rename from content/rest/reference/orgs.md rename to content/rest/orgs/index.md index 84624b295e..917eba0b84 100644 --- a/content/rest/reference/orgs.md +++ b/content/rest/orgs/index.md @@ -4,6 +4,7 @@ intro: 'The Organizations API gives you access to control and manage all your {% allowTitleToDifferFromFilename: true redirect_from: - /v3/orgs + - /rest/reference/orgs versions: fpt: '*' ghes: '*' @@ -12,8 +13,11 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /blocking + - /custom-roles + - /members + - /outside-collaborators + - /webhooks --- - - \ No newline at end of file diff --git a/content/rest/orgs/members.md b/content/rest/orgs/members.md new file mode 100644 index 0000000000..40c46bda07 --- /dev/null +++ b/content/rest/orgs/members.md @@ -0,0 +1,12 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/orgs/orgs.md b/content/rest/orgs/orgs.md new file mode 100644 index 0000000000..d9d89ac9cb --- /dev/null +++ b/content/rest/orgs/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/content/rest/orgs/outside-collaborators.md b/content/rest/orgs/outside-collaborators.md new file mode 100644 index 0000000000..8975f3a093 --- /dev/null +++ b/content/rest/orgs/outside-collaborators.md @@ -0,0 +1,12 @@ +--- +title: Outside Collaborators +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/data/reusables/rest-reference/orgs/webhooks.md b/content/rest/orgs/webhooks.md similarity index 91% rename from data/reusables/rest-reference/orgs/webhooks.md rename to content/rest/orgs/webhooks.md index 2d5221fcde..97ae08ff1c 100644 --- a/data/reusables/rest-reference/orgs/webhooks.md +++ b/content/rest/orgs/webhooks.md @@ -1,4 +1,15 @@ -## Webhooks +--- +title: Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in an organization. {% data reusables.webhooks.webhooks-rest-api-links %} diff --git a/content/rest/overview/api-previews.md b/content/rest/overview/api-previews.md index f10c88d8c6..fd5cd16cb8 100644 --- a/content/rest/overview/api-previews.md +++ b/content/rest/overview/api-previews.md @@ -4,7 +4,7 @@ intro: You can use API previews to try out new features and provide feedback bef redirect_from: - /v3/previews versions: - ghes: '*' + ghes: '<3.4' ghae: '*' topics: - API @@ -51,15 +51,6 @@ Get a [list of events](/rest/reference/issues#timeline) for an issue or pull req {% endif %} -{% ifversion ghes %} -## Pre-receive environments - -Create, list, update, and delete environments for pre-receive hooks. - -**Custom media type:** `eye-scream-preview` -**Announced:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) -{% endif %} - {% ifversion ghes < 3.3 %} ## Projects @@ -97,7 +88,7 @@ View all [codes of conduct](/rest/reference/codes-of-conduct) or get which code {% endif %} -{% ifversion ghae or ghes %} +{% ifversion ghes < 3.3 %} ## Global webhooks diff --git a/content/rest/overview/openapi-description.md b/content/rest/overview/openapi-description.md index 61866869f9..0a2468036c 100644 --- a/content/rest/overview/openapi-description.md +++ b/content/rest/overview/openapi-description.md @@ -27,4 +27,4 @@ There are many uses for an OpenAPI description. For example, you could: * Validate and test a {% data variables.product.company_short %} REST API integration. * Explore and interact with the {% data variables.product.product_name %} REST API using third-party tools, such as Insomnia or Postman. -For example, {% data variables.product.company_short %} uses the REST OpenAPI description to generate the {% data variables.product.product_name %} [REST API reference documentation](/rest/reference). +For example, {% data variables.product.company_short %} uses the REST OpenAPI description to generate the {% data variables.product.product_name %} [REST API reference documentation](/rest). diff --git a/data/reusables/rest-reference/packages/packages.md b/content/rest/packages.md similarity index 83% rename from data/reusables/rest-reference/packages/packages.md rename to content/rest/packages.md index 87c94f8857..32204571ad 100644 --- a/data/reusables/rest-reference/packages/packages.md +++ b/content/rest/packages.md @@ -1,3 +1,16 @@ +--- +title: Packages +intro: 'With the {% data variables.product.prodname_registry %} API, you can manage packages for your {% data variables.product.prodname_dotcom %} repositories and organizations.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/packages +--- + The {% data variables.product.prodname_registry %} API enables you to manage packages using the REST API.{% ifversion fpt or ghec or ghes > 3.1 or ghae %} To learn more about restoring or deleting packages, see "[Restoring and deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)."{% endif %} To use this API, you must authenticate using a personal access token. @@ -7,4 +20,4 @@ To use this API, you must authenticate using a personal access token. If your `package_type` is `npm`, `maven`, `rubygems`, or `nuget`, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. If your package is in the {% data variables.product.prodname_container_registry %}, then your `package_type` is `container` and your token does not need the `repo` scope to access or manage this `package_type`. `container` packages offer granular permissions separate from a repository. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)." -If you want to use the {% data variables.product.prodname_registry %} API to access resources in an organization with SSO enabled, then you must enable SSO for your personal access token. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} \ No newline at end of file +If you want to use the {% data variables.product.prodname_registry %} API to access resources in an organization with SSO enabled, then you must enable SSO for your personal access token. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} diff --git a/content/rest/pages.md b/content/rest/pages.md new file mode 100644 index 0000000000..2864c8aae6 --- /dev/null +++ b/content/rest/pages.md @@ -0,0 +1,14 @@ +--- +title: Pages +intro: 'The GitHub Pages API allows you to interact with GitHub Pages sites and build information.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/pages +--- \ No newline at end of file diff --git a/content/rest/projects/cards.md b/content/rest/projects/cards.md new file mode 100644 index 0000000000..f92c719935 --- /dev/null +++ b/content/rest/projects/cards.md @@ -0,0 +1,12 @@ +--- +title: Cards +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/projects/collaborators.md b/content/rest/projects/collaborators.md new file mode 100644 index 0000000000..a68e1809bc --- /dev/null +++ b/content/rest/projects/collaborators.md @@ -0,0 +1,13 @@ +--- +title: Collaborators +intro: "This API allows you to interact with an organization's projects." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/content/rest/projects/columns.md b/content/rest/projects/columns.md new file mode 100644 index 0000000000..e3c0985574 --- /dev/null +++ b/content/rest/projects/columns.md @@ -0,0 +1,12 @@ +--- +title: Columns +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/reference/projects.md b/content/rest/projects/index.md similarity index 67% rename from content/rest/reference/projects.md rename to content/rest/projects/index.md index 0819ebad74..7afcf086c6 100644 --- a/content/rest/reference/projects.md +++ b/content/rest/projects/index.md @@ -3,6 +3,7 @@ title: Projects intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' redirect_from: - /v3/projects + - /rest/reference/projects versions: fpt: '*' ghes: '*' @@ -11,8 +12,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /projects + - /cards + - /collaborators + - /columns --- - - \ No newline at end of file diff --git a/content/rest/projects/projects.md b/content/rest/projects/projects.md new file mode 100644 index 0000000000..ff85668198 --- /dev/null +++ b/content/rest/projects/projects.md @@ -0,0 +1,12 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/content/rest/pulls/comments.md b/content/rest/pulls/comments.md new file mode 100644 index 0000000000..c18aa3d812 --- /dev/null +++ b/content/rest/pulls/comments.md @@ -0,0 +1,26 @@ +--- +title: Review Comments +intro: 'Pull request review comments are comments on a portion of the unified diff made during a pull request review.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Commit comments and issue comments are different from pull request review comments. You apply commit comments directly to a commit and you apply issue comments without referencing a portion of the unified diff. For more information, see "[Create a commit comment](/rest/reference/commits#create-a-commit-comment)" and "[Create an issue comment](/rest/reference/issues#create-an-issue-comment)." + +### Custom media types for pull request review comments + +These are the supported media types for pull request review comments. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/content/rest/reference/pulls.md b/content/rest/pulls/index.md similarity index 65% rename from content/rest/reference/pulls.md rename to content/rest/pulls/index.md index 90834e5cab..17a7f54a5d 100644 --- a/content/rest/reference/pulls.md +++ b/content/rest/pulls/index.md @@ -3,6 +3,7 @@ title: Pulls intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' redirect_from: - /v3/pulls + - /rest/reference/pulls versions: fpt: '*' ghes: '*' @@ -11,8 +12,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /pulls + - /comments + - /review-requests + - /reviews --- - - diff --git a/data/reusables/rest-reference/pulls/pulls.md b/content/rest/pulls/pulls.md similarity index 90% rename from data/reusables/rest-reference/pulls/pulls.md rename to content/rest/pulls/pulls.md index 5110c930ed..7e094d8d90 100644 --- a/data/reusables/rest-reference/pulls/pulls.md +++ b/content/rest/pulls/pulls.md @@ -1,3 +1,16 @@ +--- +title: Pulls +intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](/rest/reference/issues#comments). Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like manipulating assignees, labels and milestones, are provided within [the Issues API](/rest/reference/issues). diff --git a/data/reusables/rest-reference/pulls/review-requests.md b/content/rest/pulls/review-requests.md similarity index 62% rename from data/reusables/rest-reference/pulls/review-requests.md rename to content/rest/pulls/review-requests.md index e43273b516..dc43b989bb 100644 --- a/data/reusables/rest-reference/pulls/review-requests.md +++ b/content/rest/pulls/review-requests.md @@ -1,3 +1,14 @@ -## Review requests +--- +title: Review Requests +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request. \ No newline at end of file diff --git a/content/rest/pulls/reviews.md b/content/rest/pulls/reviews.md new file mode 100644 index 0000000000..8912d09ecb --- /dev/null +++ b/content/rest/pulls/reviews.md @@ -0,0 +1,13 @@ +--- +title: Reviews +intro: 'Pull Request Reviews are groups of Pull Request Review Comments on the Pull Request, grouped together with a state and optional body comment.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/data/reusables/rest-reference/rate-limit/rate-limit.md b/content/rest/rate-limit.md similarity index 82% rename from data/reusables/rest-reference/rate-limit/rate-limit.md rename to content/rest/rate-limit.md index 03eb732cf5..502ba87c86 100644 --- a/data/reusables/rest-reference/rate-limit/rate-limit.md +++ b/content/rest/rate-limit.md @@ -1,3 +1,18 @@ +--- +title: Rate limit +intro: 'With the Rate Limit API, you can check the current rate limit status of various REST APIs.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/rate-limit +--- + The REST API overview documentation describes the [rate limit rules](/rest/overview/resources-in-the-rest-api#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below. ### Understanding your rate limit status @@ -15,4 +30,4 @@ objects: * The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint. -For more information on the headers and values in the rate limit response, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limit-http-headers)." \ No newline at end of file +For more information on the headers and values in the rate limit response, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limit-http-headers)." diff --git a/content/rest/reference/reactions.md b/content/rest/reactions.md similarity index 50% rename from content/rest/reference/reactions.md rename to content/rest/reactions.md index 2fa41e8a65..6ba29b6b1d 100644 --- a/content/rest/reference/reactions.md +++ b/content/rest/reactions.md @@ -1,8 +1,6 @@ --- title: Reactions intro: 'The Reactions API enables you to create, list and delete the reactions on comments.' -redirect_from: - - /v3/reactions versions: fpt: '*' ghes: '*' @@ -11,8 +9,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/reactions --- - \ No newline at end of file +### Reaction types + +When creating a reaction, the allowed values for the `content` parameter are as follows (with the corresponding emoji for reference): + +{% data reusables.repositories.reaction_list %} \ No newline at end of file diff --git a/content/rest/reference/actions.md b/content/rest/reference/actions.md deleted file mode 100644 index 683cb89180..0000000000 --- a/content/rest/reference/actions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Actions -intro: 'With the Actions API, you can manage and control {% data variables.product.prodname_actions %} for an organization or repository.' -redirect_from: - - /v3/actions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/content/rest/reference/billing.md b/content/rest/reference/billing.md deleted file mode 100644 index 42a5e06e06..0000000000 --- a/content/rest/reference/billing.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Billing -intro: 'With the Billing API, you can monitor the charges and usage {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} for a user or organization.' -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.4' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/checks.md b/content/rest/reference/checks.md deleted file mode 100644 index 2075cb128b..0000000000 --- a/content/rest/reference/checks.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Checks -intro: 'With the Checks API, you can build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' -redirect_from: - - /v3/checks -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/code-scanning.md b/content/rest/reference/code-scanning.md deleted file mode 100644 index f10dc933ac..0000000000 --- a/content/rest/reference/code-scanning.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Code scanning -intro: The Code Scanning API enables you to retrieve and update the code scanning alerts and analyses from a repository. -redirect_from: - - /v3/code-scanning -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: reference -topics: - - API - - Code scanning - - REST -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/content/rest/reference/codes-of-conduct.md b/content/rest/reference/codes-of-conduct.md deleted file mode 100644 index 9756ad7e7e..0000000000 --- a/content/rest/reference/codes-of-conduct.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Codes of conduct -intro: The Codes of Conduct API lets you to retrieve the information about a particular repository's code of conduct. -redirect_from: - - /v3/codes_of_conduct - - /v3/codes-of-conduct -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/dependabot.md b/content/rest/reference/dependabot.md deleted file mode 100644 index 5fe2940b7c..0000000000 --- a/content/rest/reference/dependabot.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Dependabot -intro: 'With the {% data variables.product.prodname_dependabot %} Secrets API, you can manage and control {% data variables.product.prodname_dependabot %} secrets for an organization or repository.' -versions: - fpt: '*' - ghes: '>=3.4' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/deploy_keys.md b/content/rest/reference/deploy_keys.md deleted file mode 100644 index 2a49dbdf47..0000000000 --- a/content/rest/reference/deploy_keys.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Deploy Keys -intro: 'The Deploy Keys API allows to create an SSH key that is stored on your server and grants access to a GitHub repository.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/enterprise-admin.md b/content/rest/reference/enterprise-admin.md deleted file mode 100644 index c68a10d42d..0000000000 --- a/content/rest/reference/enterprise-admin.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: GitHub Enterprise administration -intro: You can use these endpoints to administer your enterprise. -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/enterprise-admin - - /v3/enterprise -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 -shortTitle: Enterprise administration ---- - - diff --git a/content/rest/reference/git.md b/content/rest/reference/git.md deleted file mode 100644 index 8a9a9499b4..0000000000 --- a/content/rest/reference/git.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Git database -intro: 'The Git Database API enables you to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update Git references (branch heads and tags).' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/git -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/gitignore.md b/content/rest/reference/gitignore.md deleted file mode 100644 index 65610e6aad..0000000000 --- a/content/rest/reference/gitignore.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Gitignore -intro: The Gitignore API fetches `.gitignore` templates that can be used to ignore files and directories. -redirect_from: - - /v3/gitignore -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/index.md b/content/rest/reference/index.md deleted file mode 100644 index 0e7e598001..0000000000 --- a/content/rest/reference/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Reference -shortTitle: Reference -intro: View reference documentation to learn about the resources available in the GitHub REST API. -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -children: - - /actions - - /activity - - /apps - - /billing - - /branches - - /checks - - /codes-of-conduct - - /code-scanning - - /codespaces - - /collaborators - - /commits - - /dependabot - - /dependency-graph - - /deploy_keys - - /deployments - - /emojis - - /enterprise-admin - - /gists - - /git - - /gitignore - - /interactions - - /issues - - /licenses - - /markdown - - /meta - - /metrics - - /migrations - - /oauth-authorizations - - /orgs - - /packages - - /pages - - /projects - - /pulls - - /rate-limit - - /reactions - - /releases - - /repos - - /scim - - /search - - /secret-scanning - - /teams - - /users - - /webhooks ---- - diff --git a/content/rest/reference/interactions.md b/content/rest/reference/interactions.md deleted file mode 100644 index 68e28585fe..0000000000 --- a/content/rest/reference/interactions.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Interactions -intro: 'With the Interactions API, people with owner or admin access can set the interaction limit for the users in their organizations and repositories.' -redirect_from: - - /v3/interactions -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/licenses.md b/content/rest/reference/licenses.md deleted file mode 100644 index 1aa9a0ad42..0000000000 --- a/content/rest/reference/licenses.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Licenses -intro: The Licenses API lets you to retrieve popular open source licenses and information about a particular project's license file. -redirect_from: - - /v3/licenses -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/markdown.md b/content/rest/reference/markdown.md deleted file mode 100644 index e17fb2faa9..0000000000 --- a/content/rest/reference/markdown.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Markdown -intro: The Markdown API enables you to render a markdown document as an HTML page or as raw text. -redirect_from: - - /v3/markdown -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/oauth-authorizations.md b/content/rest/reference/oauth-authorizations.md deleted file mode 100644 index 7a13f85bc9..0000000000 --- a/content/rest/reference/oauth-authorizations.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: OAuth Authorizations -redirect_from: - - /v3/oauth_authorizations - - /v3/oauth-authorizations -versions: - ghes: '*' -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/packages.md b/content/rest/reference/packages.md deleted file mode 100644 index 3acc1a320f..0000000000 --- a/content/rest/reference/packages.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Packages -intro: 'With the {% data variables.product.prodname_registry %} API, you can manage packages for your {% data variables.product.prodname_dotcom %} repositories and organizations.' -product: '{% data reusables.gated-features.packages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/pages.md b/content/rest/reference/pages.md deleted file mode 100644 index 5b379f1697..0000000000 --- a/content/rest/reference/pages.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Pages -intro: The GitHub Pages API allows you to interact with GitHub Pages sites and build information. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/rate-limit.md b/content/rest/reference/rate-limit.md deleted file mode 100644 index 749db57d44..0000000000 --- a/content/rest/reference/rate-limit.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Rate limit -intro: 'With the Rate Limit API, you can check the current rate limit status of various REST APIs.' -redirect_from: - - /v3/rate_limit - - /v3/rate-limit -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/scim.md b/content/rest/reference/scim.md deleted file mode 100644 index 33d757f397..0000000000 --- a/content/rest/reference/scim.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: SCIM -intro: 'You can control and manage your {% data variables.product.product_name %} organization members access using SCIM API.' -redirect_from: - - /v3/scim -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/search.md b/content/rest/reference/search.md deleted file mode 100644 index a4f3279f65..0000000000 --- a/content/rest/reference/search.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Search -intro: 'The {% data variables.product.product_name %} Search API lets you to search for the specific item efficiently.' -redirect_from: - - /v3/search -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/content/rest/reference/secret-scanning.md b/content/rest/reference/secret-scanning.md deleted file mode 100644 index 178993687e..0000000000 --- a/content/rest/reference/secret-scanning.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Secret scanning -intro: 'Use the secret scanning API to retrieve and update secret alerts from a repository.' -versions: - ghes: '*' - ghec: '*' - ghae: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/content/rest/reference/webhooks.md b/content/rest/reference/webhooks.md deleted file mode 100644 index c59eb213e7..0000000000 --- a/content/rest/reference/webhooks.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Webhooks -intro: The webhooks API allows you to create and manage webhooks for your repositories. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/content/rest/releases/assets.md b/content/rest/releases/assets.md new file mode 100644 index 0000000000..44956c13a1 --- /dev/null +++ b/content/rest/releases/assets.md @@ -0,0 +1,13 @@ +--- +title: Release Assets +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/content/rest/reference/releases.md b/content/rest/releases/index.md similarity index 64% rename from content/rest/reference/releases.md rename to content/rest/releases/index.md index 1a7f4306f2..c3447b9110 100644 --- a/content/rest/reference/releases.md +++ b/content/rest/releases/index.md @@ -10,8 +10,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /releases + - /assets +redirect_from: + - /rest/reference/releases --- - - diff --git a/content/rest/releases/releases.md b/content/rest/releases/releases.md new file mode 100644 index 0000000000..fa1cb398fc --- /dev/null +++ b/content/rest/releases/releases.md @@ -0,0 +1,19 @@ +--- +title: Releases +intro: 'The Releases API allows you to create, modify, and delete releases and release assets. +' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% note %} + +**Note:** The Releases API replaces the Downloads API. You can retrieve the download count and browser download URL from the endpoints in this API that return releases and release assets. + +{% endnote %} \ No newline at end of file diff --git a/content/rest/repos/autolinks.md b/content/rest/repos/autolinks.md new file mode 100644 index 0000000000..ba9b5afafd --- /dev/null +++ b/content/rest/repos/autolinks.md @@ -0,0 +1,16 @@ +--- +title: Autolinks +intro: 'To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets.' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." + +{% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. \ No newline at end of file diff --git a/data/reusables/rest-reference/repos/contents.md b/content/rest/repos/contents.md similarity index 77% rename from data/reusables/rest-reference/repos/contents.md rename to content/rest/repos/contents.md index fb8e81d285..a402506eeb 100644 --- a/data/reusables/rest-reference/repos/contents.md +++ b/content/rest/repos/contents.md @@ -1,6 +1,17 @@ -## Contents +--- +title: Contents +intro: 'These API endpoints let you create, modify, and delete Base64 encoded content in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- -These API endpoints let you create, modify, and delete Base64 encoded content in a repository. To request the raw format or rendered HTML (when supported), use custom media types for repository contents. +To request the raw format or rendered HTML (when supported), use custom media types for repository contents. ### Custom media types for repository contents diff --git a/content/rest/repos/forks.md b/content/rest/repos/forks.md new file mode 100644 index 0000000000..5a7928f9aa --- /dev/null +++ b/content/rest/repos/forks.md @@ -0,0 +1,12 @@ +--- +title: Forks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/reference/repos.md b/content/rest/repos/index.md similarity index 71% rename from translations/es-ES/content/rest/reference/repos.md rename to content/rest/repos/index.md index 51710d0f0c..7232e7da73 100644 --- a/translations/es-ES/content/rest/reference/repos.md +++ b/content/rest/repos/index.md @@ -4,6 +4,7 @@ intro: 'The Repos API allows to create, manage and control the workflow of publi allowTitleToDifferFromFilename: true redirect_from: - /v3/repos + - /rest/reference/repos versions: fpt: '*' ghes: '*' @@ -12,8 +13,11 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /repos + - /autolinks + - /contents + - /forks + - /lfs + - /tags --- - - \ No newline at end of file diff --git a/content/rest/repos/lfs.md b/content/rest/repos/lfs.md new file mode 100644 index 0000000000..3b11137030 --- /dev/null +++ b/content/rest/repos/lfs.md @@ -0,0 +1,13 @@ +--- +title: Git LFS +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/content/rest/repos/repos.md b/content/rest/repos/repos.md new file mode 100644 index 0000000000..8941c62602 --- /dev/null +++ b/content/rest/repos/repos.md @@ -0,0 +1,13 @@ +--- +title: Repositories +intro: 'The Repos API allows to create, manage and control the workflow of public and private GitHub Enterprise Server repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/content/rest/repos/tags.md b/content/rest/repos/tags.md new file mode 100644 index 0000000000..7685300da2 --- /dev/null +++ b/content/rest/repos/tags.md @@ -0,0 +1,10 @@ +--- +title: Tags +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/data/reusables/rest-reference/scim/scim.md b/content/rest/scim.md similarity index 92% rename from data/reusables/rest-reference/scim/scim.md rename to content/rest/scim.md index 9cc068e1ab..8f63ea1bb9 100644 --- a/data/reusables/rest-reference/scim/scim.md +++ b/content/rest/scim.md @@ -1,3 +1,16 @@ +--- +title: SCIM +intro: 'You can control and manage your GitHub organization members access using SCIM API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/scim +--- + ### SCIM Provisioning for Organizations The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.product_name %} organization membership. The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). The {% data variables.product.product_name %} SCIM endpoint that an IdP should use is: `{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`. @@ -38,4 +51,4 @@ Name | Type | Description GET /scim/v2/organizations/{org}/Users/{scim_user_id} ``` -{% endnote %} \ No newline at end of file +{% endnote %} diff --git a/data/reusables/rest-reference/search/search.md b/content/rest/search.md similarity index 97% rename from data/reusables/rest-reference/search/search.md rename to content/rest/search.md index aa27affdbe..a463da9363 100644 --- a/data/reusables/rest-reference/search/search.md +++ b/content/rest/search.md @@ -1,3 +1,18 @@ +--- +title: Search +intro: 'The GitHub Search API lets you to search for the specific item efficiently.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/search +--- + The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. You can narrow your search using queries. To learn more about the search query syntax, see "[Constructing a search query](/rest/reference/search#constructing-a-search-query)." @@ -157,4 +172,4 @@ The second text match occurred in the `body` property of one of the issue's comm } ] } -``` \ No newline at end of file +``` diff --git a/data/reusables/rest-reference/secret-scanning/secret-scanning.md b/content/rest/secret-scanning.md similarity index 79% rename from data/reusables/rest-reference/secret-scanning/secret-scanning.md rename to content/rest/secret-scanning.md index b87a52494e..fad846994e 100644 --- a/data/reusables/rest-reference/secret-scanning/secret-scanning.md +++ b/content/rest/secret-scanning.md @@ -1,3 +1,17 @@ +--- +title: Secret Scanning +intro: 'Use the Secret Scanning API to retrieve and update secret alerts from a repository.' +versions: + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/secret-scanning +--- + {% data reusables.secret-scanning.api-beta %} The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae %}: diff --git a/content/rest/teams/discussion-comments.md b/content/rest/teams/discussion-comments.md new file mode 100644 index 0000000000..0dde5647e0 --- /dev/null +++ b/content/rest/teams/discussion-comments.md @@ -0,0 +1,14 @@ +--- +title: Discussion Comments +intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/content/rest/teams/discussions.md b/content/rest/teams/discussions.md new file mode 100644 index 0000000000..1a6cc51805 --- /dev/null +++ b/content/rest/teams/discussions.md @@ -0,0 +1,14 @@ +--- +title: Discussions +intro: "The Team Discussions API allows you to get, create, edit, and delete discussion posts on a team's page." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/data/reusables/rest-reference/teams/external-groups.md b/content/rest/teams/external-groups.md similarity index 67% rename from data/reusables/rest-reference/teams/external-groups.md rename to content/rest/teams/external-groups.md index b0409a0f05..ab172bd084 100644 --- a/data/reusables/rest-reference/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -1,6 +1,14 @@ -## External groups - -The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization. +--- +title: External Groups +intro: 'The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.' +versions: + fpt: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. diff --git a/content/rest/reference/teams.md b/content/rest/teams/index.md similarity index 66% rename from content/rest/reference/teams.md rename to content/rest/teams/index.md index 2b6c9d7a8d..fc2c3a44cb 100644 --- a/content/rest/reference/teams.md +++ b/content/rest/teams/index.md @@ -3,6 +3,7 @@ title: Teams intro: 'With the Teams API, you can create and manage teams in your {% data variables.product.product_name %} organization.' redirect_from: - /v3/teams + - /rest/reference/teams versions: fpt: '*' ghes: '*' @@ -11,8 +12,11 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /teams + - /discussion-comments + - /discussions + - /external-groups + - /members + - /team-sync --- - - \ No newline at end of file diff --git a/data/reusables/rest-reference/teams/members.md b/content/rest/teams/members.md similarity index 87% rename from data/reusables/rest-reference/teams/members.md rename to content/rest/teams/members.md index 2b8896f4f5..fdcee06601 100644 --- a/data/reusables/rest-reference/teams/members.md +++ b/content/rest/teams/members.md @@ -1,4 +1,15 @@ -## Members +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). diff --git a/content/rest/teams/team-sync.md b/content/rest/teams/team-sync.md new file mode 100644 index 0000000000..3b6dfa15dd --- /dev/null +++ b/content/rest/teams/team-sync.md @@ -0,0 +1,21 @@ +--- +title: Team Synchronization +intro: 'The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." + +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% note %} + +**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". + +{% endnote %} \ No newline at end of file diff --git a/content/rest/teams/teams.md b/content/rest/teams/teams.md new file mode 100644 index 0000000000..fa741a215e --- /dev/null +++ b/content/rest/teams/teams.md @@ -0,0 +1,14 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your GitHub organization.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. diff --git a/content/rest/users/blocking.md b/content/rest/users/blocking.md new file mode 100644 index 0000000000..297347554f --- /dev/null +++ b/content/rest/users/blocking.md @@ -0,0 +1,11 @@ +--- +title: Blocking Users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/data/reusables/rest-reference/users/emails.md b/content/rest/users/emails.md similarity index 55% rename from data/reusables/rest-reference/users/emails.md rename to content/rest/users/emails.md index 5e67e0e34b..1526e6e0a6 100644 --- a/data/reusables/rest-reference/users/emails.md +++ b/content/rest/users/emails.md @@ -1,3 +1,13 @@ -## Emails +--- +title: Emails +intro: '' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- Management of email addresses via the API requires that you authenticate through basic auth, or through OAuth with a correct scope for the endpoint. \ No newline at end of file diff --git a/content/rest/users/followers.md b/content/rest/users/followers.md new file mode 100644 index 0000000000..b93b9303cd --- /dev/null +++ b/content/rest/users/followers.md @@ -0,0 +1,12 @@ +--- +title: Followers +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/data/reusables/rest-reference/users/gpg-keys.md b/content/rest/users/gpg-keys.md similarity index 70% rename from data/reusables/rest-reference/users/gpg-keys.md rename to content/rest/users/gpg-keys.md index e8b4f3254e..8cc12ab55d 100644 --- a/data/reusables/rest-reference/users/gpg-keys.md +++ b/content/rest/users/gpg-keys.md @@ -1,3 +1,14 @@ -## GPG keys +--- +title: GPG Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- The data returned in the `public_key` response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what is returned by the APIs on this page. This key is not suitable to be used directly by programs like GPG. \ No newline at end of file diff --git a/content/rest/reference/users.md b/content/rest/users/index.md similarity index 64% rename from content/rest/reference/users.md rename to content/rest/users/index.md index 3377e9daa3..22145785f5 100644 --- a/content/rest/reference/users.md +++ b/content/rest/users/index.md @@ -3,6 +3,7 @@ title: Users intro: The Users API allows to get public and private information about the authenticated user. redirect_from: - /v3/users + - /rest/reference/users versions: fpt: '*' ghes: '*' @@ -11,8 +12,11 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /users + - /blocking + - /emails + - /followers + - /gpg-keys + - /keys --- - - \ No newline at end of file diff --git a/content/rest/users/keys.md b/content/rest/users/keys.md new file mode 100644 index 0000000000..ac61f9554f --- /dev/null +++ b/content/rest/users/keys.md @@ -0,0 +1,13 @@ +--- +title: Git SSH Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/data/reusables/rest-reference/users/users.md b/content/rest/users/users.md similarity index 72% rename from data/reusables/rest-reference/users/users.md rename to content/rest/users/users.md index d7e21a1ad2..e299587e74 100644 --- a/data/reusables/rest-reference/users/users.md +++ b/content/rest/users/users.md @@ -1 +1,14 @@ +--- +title: Users +intro: 'The Users API allows to get public and private information about the authenticated user.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a `{username}` parameter then the response will be for the logged in user (and you must pass [authentication information](/rest/overview/resources-in-the-rest-api#authentication) with your request).{% ifversion fpt or ghes or ghec %} Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the `user` scope.{% endif %} \ No newline at end of file diff --git a/data/reusables/rest-reference/webhooks/webhooks.md b/content/rest/webhooks/index.md similarity index 81% rename from data/reusables/rest-reference/webhooks/webhooks.md rename to content/rest/webhooks/index.md index bd242312d6..fb833f3c0b 100644 --- a/data/reusables/rest-reference/webhooks/webhooks.md +++ b/content/rest/webhooks/index.md @@ -1,3 +1,23 @@ +--- +title: Webhooks +intro: The webhooks API allows you to create and manage webhooks for your repositories. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /repo-config + - /repo-deliveries + - /repos +redirect_from: + - /rest/reference/webhooks +--- + Repository webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in a repository. {% data reusables.webhooks.webhooks-rest-api-links %} If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks). @@ -56,4 +76,4 @@ Name | Type | Description ``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. ``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. ``hub.callback``|`string` | The URI to receive the updates to the topic. -``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 2.22 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. \ No newline at end of file +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 3.0 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. \ No newline at end of file diff --git a/content/rest/webhooks/repo-config.md b/content/rest/webhooks/repo-config.md new file mode 100644 index 0000000000..5653146886 --- /dev/null +++ b/content/rest/webhooks/repo-config.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Configuration +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/content/rest/webhooks/repo-deliveries.md b/content/rest/webhooks/repo-deliveries.md new file mode 100644 index 0000000000..ee3f49cc36 --- /dev/null +++ b/content/rest/webhooks/repo-deliveries.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Deliveries +intro: '' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/content/rest/webhooks/repos.md b/content/rest/webhooks/repos.md new file mode 100644 index 0000000000..51d4dd89a8 --- /dev/null +++ b/content/rest/webhooks/repos.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/data/features/codeql-runner-supported.yml b/data/features/codeql-runner-supported.yml index f1ea3ca57b..897bc7a079 100644 --- a/data/features/codeql-runner-supported.yml +++ b/data/features/codeql-runner-supported.yml @@ -1,6 +1,5 @@ # Tracking deprecation of CodeQL runner +# https://github.blog/changelog/2022-04-05-codeql-runner-is-now-deprecated/ + versions: - fpt: '*' - ghec: '*' - ghes: '*' - ghae: '*' + ghes: '<=3.3' diff --git a/data/features/org-profile-pin-private.yml b/data/features/org-profile-pin-private.yml new file mode 100644 index 0000000000..bd30226a3e --- /dev/null +++ b/data/features/org-profile-pin-private.yml @@ -0,0 +1,7 @@ +# Issue #6171 +# Documentation for the "Org profile pin private/internal repos" +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.6' + ghae: 'issue-6171' diff --git a/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md b/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md new file mode 100644 index 0000000000..05e72ec744 --- /dev/null +++ b/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md @@ -0,0 +1 @@ +If you use ephemeral runners and have disabled automatic updates, before you upgrade {% data variables.product.product_location %}, you should first upgrade your self-hosted runners to the version of the runner application that your upgraded instance will run. Upgrading {% data variables.product.product_location %} before you upgrade ephemeral runners may result in your runners going offline. For more information, see "[Upgrading {% data variables.product.product_name %}](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)." \ No newline at end of file diff --git a/data/reusables/code-scanning/alerts-found-in-generated-code.md b/data/reusables/code-scanning/alerts-found-in-generated-code.md new file mode 100644 index 0000000000..3e509e813d --- /dev/null +++ b/data/reusables/code-scanning/alerts-found-in-generated-code.md @@ -0,0 +1,3 @@ +For compiled languages like Java, C, C++, and C#, {% data variables.product.prodname_codeql %} analyzes all of the code which was built during the workflow run. To limit the amount of code being analyzed, build only the code which you wish to analyze by specifying your own build steps in a `run` block. You can combine specifying your own build steps with using the `paths` or `paths-ignore` filters on the `pull_request` and `push` events to ensure that your workflow only runs when specific code is changed. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)." + +For languages like Go, JavaScript, Python, and TypeScript, that {% data variables.product.prodname_codeql %} analyzes without compiling the source code, you can specify additional configuration options to limit the amount of code to analyze. For more information, see "[Specifying directories to scan](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)." \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/actions.md b/data/reusables/rest-reference/actions/actions.md deleted file mode 100644 index 2c15a34d7c..0000000000 --- a/data/reusables/rest-reference/actions/actions.md +++ /dev/null @@ -1 +0,0 @@ -The {% data variables.product.prodname_actions %} API enables you to manage {% data variables.product.prodname_actions %} using the REST API. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/artifacts.md b/data/reusables/rest-reference/actions/artifacts.md deleted file mode 100644 index 2ff66e8301..0000000000 --- a/data/reusables/rest-reference/actions/artifacts.md +++ /dev/null @@ -1,5 +0,0 @@ -## Artifacts - -The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts. {% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." - -{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/secrets.md b/data/reusables/rest-reference/actions/secrets.md deleted file mode 100644 index e0770bb2c8..0000000000 --- a/data/reusables/rest-reference/actions/secrets.md +++ /dev/null @@ -1,5 +0,0 @@ -## Secrets - -The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." - -{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/workflow-jobs.md b/data/reusables/rest-reference/actions/workflow-jobs.md deleted file mode 100644 index 83d98e6aa9..0000000000 --- a/data/reusables/rest-reference/actions/workflow-jobs.md +++ /dev/null @@ -1,5 +0,0 @@ -## Workflow jobs - -The Workflow Jobs API allows you to view logs and workflow jobs. {% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". - -{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/workflow-runs.md b/data/reusables/rest-reference/actions/workflow-runs.md deleted file mode 100644 index 0f38e2b7a2..0000000000 --- a/data/reusables/rest-reference/actions/workflow-runs.md +++ /dev/null @@ -1,5 +0,0 @@ -## Workflow runs - -The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs. {% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)." - -{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/data/reusables/rest-reference/actions/workflows.md b/data/reusables/rest-reference/actions/workflows.md deleted file mode 100644 index db7872db7e..0000000000 --- a/data/reusables/rest-reference/actions/workflows.md +++ /dev/null @@ -1,5 +0,0 @@ -## Workflows - -The Workflows API allows you to view workflows for a repository. {% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)." - -{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/data/reusables/rest-reference/activity/watching.md b/data/reusables/rest-reference/activity/watching.md deleted file mode 100644 index 5b3466366f..0000000000 --- a/data/reusables/rest-reference/activity/watching.md +++ /dev/null @@ -1,3 +0,0 @@ -## Watching - -Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." \ No newline at end of file diff --git a/data/reusables/rest-reference/apps/installations.md b/data/reusables/rest-reference/apps/installations.md deleted file mode 100644 index 04ff1208c1..0000000000 --- a/data/reusables/rest-reference/apps/installations.md +++ /dev/null @@ -1,5 +0,0 @@ -## Installations - -The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations. An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." - -To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." \ No newline at end of file diff --git a/data/reusables/rest-reference/branches/branch-protection.md b/data/reusables/rest-reference/branches/branch-protection.md deleted file mode 100644 index 18ad55ffe7..0000000000 --- a/data/reusables/rest-reference/branches/branch-protection.md +++ /dev/null @@ -1 +0,0 @@ -## Protected branches \ No newline at end of file diff --git a/data/reusables/rest-reference/checks/checks.md b/data/reusables/rest-reference/checks/checks.md deleted file mode 100644 index 21a498f3f9..0000000000 --- a/data/reusables/rest-reference/checks/checks.md +++ /dev/null @@ -1 +0,0 @@ -You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." \ No newline at end of file diff --git a/data/reusables/rest-reference/checks/runs.md b/data/reusables/rest-reference/checks/runs.md deleted file mode 100644 index b8141f42ea..0000000000 --- a/data/reusables/rest-reference/checks/runs.md +++ /dev/null @@ -1 +0,0 @@ -## Check Runs \ No newline at end of file diff --git a/data/reusables/rest-reference/codespaces/machines.md b/data/reusables/rest-reference/codespaces/machines.md deleted file mode 100644 index e8bc5519da..0000000000 --- a/data/reusables/rest-reference/codespaces/machines.md +++ /dev/null @@ -1,4 +0,0 @@ -## Machines -The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user. For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)." - -You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)." \ No newline at end of file diff --git a/data/reusables/rest-reference/collaborators/invitations.md b/data/reusables/rest-reference/collaborators/invitations.md deleted file mode 100644 index 0fc7273d09..0000000000 --- a/data/reusables/rest-reference/collaborators/invitations.md +++ /dev/null @@ -1,11 +0,0 @@ -## Invitations - -The Repository Invitations API allows users or external services to invite other users to collaborate on a repo. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. - -Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted -access to invitations **without** also granting access to repository code, while the -`repo` scope grants permission to code as well as invitations. - -### Invite a user to a repository - -Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/reference/collaborators#add-a-repository-collaborator)." \ No newline at end of file diff --git a/data/reusables/rest-reference/commits/statuses.md b/data/reusables/rest-reference/commits/statuses.md deleted file mode 100644 index aa0285bd6b..0000000000 --- a/data/reusables/rest-reference/commits/statuses.md +++ /dev/null @@ -1,24 +0,0 @@ -## Commit statuses - -The status API allows external services to mark commits with an `error`, -`failure`, `pending`, or `success` state, which is then reflected in pull requests -involving those commits. - -Statuses can also include an optional `description` and `target_url`, and -we highly recommend providing them as they make statuses much more -useful in the GitHub UI. - -As an example, one common use is for continuous integration -services to mark commits as passing or failing builds using status. The -`target_url` would be the full URL to the build output, and the -`description` would be the high level summary of what happened with the -build. - -Statuses can include a `context` to indicate what service is providing that status. -For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can -then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. - -Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the -`repo` scope grants permission to code as well as statuses. - -If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks). \ No newline at end of file diff --git a/data/reusables/rest-reference/deployments/environments.md b/data/reusables/rest-reference/deployments/environments.md deleted file mode 100644 index be50201aaf..0000000000 --- a/data/reusables/rest-reference/deployments/environments.md +++ /dev/null @@ -1,5 +0,0 @@ -## Environments - -The Environments API allows you to create, configure, and delete environments. For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." - -{% data reusables.gated-features.environments %} \ No newline at end of file diff --git a/data/reusables/rest-reference/deployments/statuses.md b/data/reusables/rest-reference/deployments/statuses.md deleted file mode 100644 index 60cce3a426..0000000000 --- a/data/reusables/rest-reference/deployments/statuses.md +++ /dev/null @@ -1 +0,0 @@ -## Deployment statuses \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/admin-stats.md b/data/reusables/rest-reference/enterprise-admin/admin-stats.md deleted file mode 100644 index fb24fe9d97..0000000000 --- a/data/reusables/rest-reference/enterprise-admin/admin-stats.md +++ /dev/null @@ -1,3 +0,0 @@ -## Admin stats - -The Admin Stats API provides a variety of metrics about your installation. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/audit-log.md b/data/reusables/rest-reference/enterprise-admin/audit-log.md deleted file mode 100644 index 2c34651022..0000000000 --- a/data/reusables/rest-reference/enterprise-admin/audit-log.md +++ /dev/null @@ -1 +0,0 @@ -## Audit log \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/billing.md b/data/reusables/rest-reference/enterprise-admin/billing.md deleted file mode 100644 index 2a527b5c41..0000000000 --- a/data/reusables/rest-reference/enterprise-admin/billing.md +++ /dev/null @@ -1 +0,0 @@ -## Billing \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/global-webhooks.md b/data/reusables/rest-reference/enterprise-admin/global-webhooks.md deleted file mode 100644 index aedf28792b..0000000000 --- a/data/reusables/rest-reference/enterprise-admin/global-webhooks.md +++ /dev/null @@ -1,5 +0,0 @@ -## Global webhooks - -Global webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise. Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. - -*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/license.md b/data/reusables/rest-reference/enterprise-admin/license.md deleted file mode 100644 index a1ba325405..0000000000 --- a/data/reusables/rest-reference/enterprise-admin/license.md +++ /dev/null @@ -1,3 +0,0 @@ -## License - -The License API provides information on your Enterprise license. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/orgs.md b/data/reusables/rest-reference/enterprise-admin/orgs.md deleted file mode 100644 index bd5d2847da..0000000000 --- a/data/reusables/rest-reference/enterprise-admin/orgs.md +++ /dev/null @@ -1,3 +0,0 @@ -## Organizations - -The Organization Administration API allows you to create organizations on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/data/reusables/rest-reference/enterprise-admin/users.md b/data/reusables/rest-reference/enterprise-admin/users.md deleted file mode 100644 index 0c8a6b1489..0000000000 --- a/data/reusables/rest-reference/enterprise-admin/users.md +++ /dev/null @@ -1,3 +0,0 @@ -## Users - -The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise. *It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. \ No newline at end of file diff --git a/data/reusables/rest-reference/git/commits.md b/data/reusables/rest-reference/git/commits.md deleted file mode 100644 index e91343e9c4..0000000000 --- a/data/reusables/rest-reference/git/commits.md +++ /dev/null @@ -1,5 +0,0 @@ -## Commits - -A Git commit is a snapshot of the hierarchy ([Git tree](/rest/reference/git#trees)) and the contents of the files ([Git blob](/rest/reference/git#blobs)) in a Git repository. -These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects) -to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/data/reusables/rest-reference/git/git.md b/data/reusables/rest-reference/git/git.md deleted file mode 100644 index 302b1c9768..0000000000 --- a/data/reusables/rest-reference/git/git.md +++ /dev/null @@ -1 +0,0 @@ -The Git Database API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the Git Database API, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)." \ No newline at end of file diff --git a/data/reusables/rest-reference/git/refs.md b/data/reusables/rest-reference/git/refs.md deleted file mode 100644 index 539e79ce88..0000000000 --- a/data/reusables/rest-reference/git/refs.md +++ /dev/null @@ -1,8 +0,0 @@ -## References - -A Git reference (`git ref`) is just a file that contains a Git commit SHA-1 hash. -When referring to a Git commit, you can use the Git reference, which is an -easy-to-remember name, rather than the hash. The Git reference can be rewritten -to point to a new commit. A branch is just a Git reference that stores the new Git -commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v1/Git-Internals-Git-References) -to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/data/reusables/rest-reference/git/tags.md b/data/reusables/rest-reference/git/tags.md deleted file mode 100644 index fb160d4661..0000000000 --- a/data/reusables/rest-reference/git/tags.md +++ /dev/null @@ -1,3 +0,0 @@ -## Tags - -A Git tag is similar to a [Git reference](/rest/reference/git#refs), but the Git commit that it points to never changes. Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags) to your Git database on {% data variables.product.product_name %}. The Git tags API only supports [annotated tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags), not lightweight tags. diff --git a/data/reusables/rest-reference/git/trees.md b/data/reusables/rest-reference/git/trees.md deleted file mode 100644 index f2f3365460..0000000000 --- a/data/reusables/rest-reference/git/trees.md +++ /dev/null @@ -1,3 +0,0 @@ -## Trees - -A Git tree object creates the hierarchy between files in a Git repository. You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/data/reusables/rest-reference/interactions/interactions.md b/data/reusables/rest-reference/interactions/interactions.md deleted file mode 100644 index 72871be2bc..0000000000 --- a/data/reusables/rest-reference/interactions/interactions.md +++ /dev/null @@ -1 +0,0 @@ -Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. \ No newline at end of file diff --git a/data/reusables/rest-reference/issues/assignees.md b/data/reusables/rest-reference/issues/assignees.md deleted file mode 100644 index 4de70582af..0000000000 --- a/data/reusables/rest-reference/issues/assignees.md +++ /dev/null @@ -1 +0,0 @@ -## Assignees \ No newline at end of file diff --git a/data/reusables/rest-reference/issues/comments.md b/data/reusables/rest-reference/issues/comments.md deleted file mode 100644 index 9470deea69..0000000000 --- a/data/reusables/rest-reference/issues/comments.md +++ /dev/null @@ -1,8 +0,0 @@ -## Comments - -The Issue Comments API supports listing, viewing, editing, and creating -comments on issues and pull requests. - -Issue Comments use [these custom media types](#custom-media-types). -You can read more about the use of media types in the API -[here](/rest/overview/media-types). \ No newline at end of file diff --git a/data/reusables/rest-reference/issues/events.md b/data/reusables/rest-reference/issues/events.md deleted file mode 100644 index ccc025c923..0000000000 --- a/data/reusables/rest-reference/issues/events.md +++ /dev/null @@ -1,3 +0,0 @@ -## Events - -The Issue Events API can return different types of events triggered by activity in issues and pull requests. For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[Events API](/developers/webhooks-and-events/github-event-types)." \ No newline at end of file diff --git a/data/reusables/rest-reference/issues/labels.md b/data/reusables/rest-reference/issues/labels.md deleted file mode 100644 index 1aae808e42..0000000000 --- a/data/reusables/rest-reference/issues/labels.md +++ /dev/null @@ -1 +0,0 @@ -## Labels \ No newline at end of file diff --git a/data/reusables/rest-reference/issues/milestones.md b/data/reusables/rest-reference/issues/milestones.md deleted file mode 100644 index f00f9170b7..0000000000 --- a/data/reusables/rest-reference/issues/milestones.md +++ /dev/null @@ -1 +0,0 @@ -## Milestones \ No newline at end of file diff --git a/data/reusables/rest-reference/issues/timeline.md b/data/reusables/rest-reference/issues/timeline.md deleted file mode 100644 index 55361ae691..0000000000 --- a/data/reusables/rest-reference/issues/timeline.md +++ /dev/null @@ -1,5 +0,0 @@ -## Timeline - -The Timeline Events API can return different types of events triggered by timeline activity in issues and pull requests. For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[GitHub Events API](/developers/webhooks-and-events/github-event-types)." - -You can use this API to display information about issues and pull request or determine who should be notified of issue comments. \ No newline at end of file diff --git a/data/reusables/rest-reference/metrics/community.md b/data/reusables/rest-reference/metrics/community.md deleted file mode 100644 index 9667d0fb9b..0000000000 --- a/data/reusables/rest-reference/metrics/community.md +++ /dev/null @@ -1 +0,0 @@ -## Community \ No newline at end of file diff --git a/data/reusables/rest-reference/metrics/traffic.md b/data/reusables/rest-reference/metrics/traffic.md deleted file mode 100644 index 744223c2bf..0000000000 --- a/data/reusables/rest-reference/metrics/traffic.md +++ /dev/null @@ -1,4 +0,0 @@ -## Traffic - -For repositories that you have push access to, the traffic API provides access -to the information provided in your repository graph. For more information, see "Viewing traffic to a repository." \ No newline at end of file diff --git a/data/reusables/rest-reference/migrations/orgs.md b/data/reusables/rest-reference/migrations/orgs.md deleted file mode 100644 index 7391b9f24d..0000000000 --- a/data/reusables/rest-reference/migrations/orgs.md +++ /dev/null @@ -1,5 +0,0 @@ -## Organization - -The Migrations API is only available to authenticated organization owners. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." - -{% data variables.migrations.organization_migrations_intro %} \ No newline at end of file diff --git a/data/reusables/rest-reference/orgs/custom_roles.md b/data/reusables/rest-reference/orgs/custom_roles.md deleted file mode 100644 index 310339895f..0000000000 --- a/data/reusables/rest-reference/orgs/custom_roles.md +++ /dev/null @@ -1 +0,0 @@ -## Custom repository roles \ No newline at end of file diff --git a/data/reusables/rest-reference/orgs/members.md b/data/reusables/rest-reference/orgs/members.md deleted file mode 100644 index 5a030fc745..0000000000 --- a/data/reusables/rest-reference/orgs/members.md +++ /dev/null @@ -1 +0,0 @@ -## Members \ No newline at end of file diff --git a/data/reusables/rest-reference/orgs/outside-collaborators.md b/data/reusables/rest-reference/orgs/outside-collaborators.md deleted file mode 100644 index b24a6b92bd..0000000000 --- a/data/reusables/rest-reference/orgs/outside-collaborators.md +++ /dev/null @@ -1 +0,0 @@ -## Outside collaborators \ No newline at end of file diff --git a/data/reusables/rest-reference/pages/pages.md b/data/reusables/rest-reference/pages/pages.md deleted file mode 100644 index e93328930d..0000000000 --- a/data/reusables/rest-reference/pages/pages.md +++ /dev/null @@ -1,14 +0,0 @@ -The {% data variables.product.prodname_pages %} API retrieves information about your {% data variables.product.prodname_pages %} configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners{% ifversion not ghae %}, even if the websites are public{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)." - -In {% data variables.product.prodname_pages %} API endpoints with a `status` key in their response, the value can be one of: -* `null`: The site has yet to be built. -* `queued`: The build has been requested but not yet begun. -* `building`:The build is in progress. -* `built`: The site has been built. -* `errored`: Indicates an error occurred during the build. - -In {% data variables.product.prodname_pages %} API endpoints that return GitHub Pages site information, the JSON responses include these fields: -* `html_url`: The absolute URL (including scheme) of the rendered Pages site. For example, `https://username.github.io`. -* `source`: An object that contains the source branch and directory for the rendered Pages site. This includes: - - `branch`: The repository branch used to publish your [site's source files](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). For example, _main_ or _gh-pages_. - - `path`: The repository directory from which the site publishes. Will be either `/` or `/docs`. \ No newline at end of file diff --git a/data/reusables/rest-reference/projects/cards.md b/data/reusables/rest-reference/projects/cards.md deleted file mode 100644 index eecf4863b5..0000000000 --- a/data/reusables/rest-reference/projects/cards.md +++ /dev/null @@ -1 +0,0 @@ -## Cards \ No newline at end of file diff --git a/data/reusables/rest-reference/projects/collaborators.md b/data/reusables/rest-reference/projects/collaborators.md deleted file mode 100644 index ad1a9b82aa..0000000000 --- a/data/reusables/rest-reference/projects/collaborators.md +++ /dev/null @@ -1,3 +0,0 @@ -## Collaborators - -This API allows you to interact with an organization's projects. \ No newline at end of file diff --git a/data/reusables/rest-reference/projects/columns.md b/data/reusables/rest-reference/projects/columns.md deleted file mode 100644 index 65b83e8f4b..0000000000 --- a/data/reusables/rest-reference/projects/columns.md +++ /dev/null @@ -1 +0,0 @@ -## Columns \ No newline at end of file diff --git a/data/reusables/rest-reference/pulls/comments.md b/data/reusables/rest-reference/pulls/comments.md deleted file mode 100644 index 0bcf72ba4d..0000000000 --- a/data/reusables/rest-reference/pulls/comments.md +++ /dev/null @@ -1,14 +0,0 @@ -## Review comments - -Pull request review comments are comments on a portion of the unified diff made during a pull request review. Commit comments and issue comments are different from pull request review comments. You apply commit comments directly to a commit and you apply issue comments without referencing a portion of the unified diff. For more information, see "[Create a commit comment](/rest/reference/commits#create-a-commit-comment)" and "[Create an issue comment](/rest/reference/issues#create-an-issue-comment)." - -### Custom media types for pull request review comments - -These are the supported media types for pull request review comments. - - application/vnd.github.VERSION.raw+json - application/vnd.github.VERSION.text+json - application/vnd.github.VERSION.html+json - application/vnd.github.VERSION.full+json - -For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/data/reusables/rest-reference/pulls/reviews.md b/data/reusables/rest-reference/pulls/reviews.md deleted file mode 100644 index c3c4df8aa4..0000000000 --- a/data/reusables/rest-reference/pulls/reviews.md +++ /dev/null @@ -1,4 +0,0 @@ -## Reviews - -Pull Request Reviews are groups of Pull Request Review Comments on the Pull -Request, grouped together with a state and optional body comment. \ No newline at end of file diff --git a/data/reusables/rest-reference/reations/reactions.md b/data/reusables/rest-reference/reations/reactions.md deleted file mode 100644 index d2feff37dd..0000000000 --- a/data/reusables/rest-reference/reations/reactions.md +++ /dev/null @@ -1,5 +0,0 @@ -### Reaction types - -When creating a reaction, the allowed values for the `content` parameter are as follows (with the corresponding emoji for reference): - -{% data reusables.repositories.reaction_list %} \ No newline at end of file diff --git a/data/reusables/rest-reference/releases/assets.md b/data/reusables/rest-reference/releases/assets.md deleted file mode 100644 index 902620cfeb..0000000000 --- a/data/reusables/rest-reference/releases/assets.md +++ /dev/null @@ -1 +0,0 @@ -## Release assets \ No newline at end of file diff --git a/data/reusables/rest-reference/releases/releases.md b/data/reusables/rest-reference/releases/releases.md deleted file mode 100644 index 3e9d852eef..0000000000 --- a/data/reusables/rest-reference/releases/releases.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Note:** The Releases API replaces the Downloads API. You can retrieve the download count and browser download URL from the endpoints in this API that return releases and release assets. - -{% endnote %} \ No newline at end of file diff --git a/data/reusables/rest-reference/repos/autolinks.md b/data/reusables/rest-reference/repos/autolinks.md deleted file mode 100644 index 17893b81d6..0000000000 --- a/data/reusables/rest-reference/repos/autolinks.md +++ /dev/null @@ -1,5 +0,0 @@ -## Autolinks - -To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." - -{% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. \ No newline at end of file diff --git a/data/reusables/rest-reference/repos/forks.md b/data/reusables/rest-reference/repos/forks.md deleted file mode 100644 index 993277272d..0000000000 --- a/data/reusables/rest-reference/repos/forks.md +++ /dev/null @@ -1 +0,0 @@ -## Forks \ No newline at end of file diff --git a/data/reusables/rest-reference/repos/lfs.md b/data/reusables/rest-reference/repos/lfs.md deleted file mode 100644 index 5a48e59434..0000000000 --- a/data/reusables/rest-reference/repos/lfs.md +++ /dev/null @@ -1,2 +0,0 @@ - -## Git LFS \ No newline at end of file diff --git a/data/reusables/rest-reference/teams/discussion-comments.md b/data/reusables/rest-reference/teams/discussion-comments.md deleted file mode 100644 index cb11be4d23..0000000000 --- a/data/reusables/rest-reference/teams/discussion-comments.md +++ /dev/null @@ -1,3 +0,0 @@ -## Discussion comments - -The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post. Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/data/reusables/rest-reference/teams/discussions.md b/data/reusables/rest-reference/teams/discussions.md deleted file mode 100644 index 7a8248384e..0000000000 --- a/data/reusables/rest-reference/teams/discussions.md +++ /dev/null @@ -1,3 +0,0 @@ -## Discussions - -The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/data/reusables/rest-reference/teams/team-sync.md b/data/reusables/rest-reference/teams/team-sync.md deleted file mode 100644 index 98b63eb770..0000000000 --- a/data/reusables/rest-reference/teams/team-sync.md +++ /dev/null @@ -1,11 +0,0 @@ -## Team synchronization - -The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups. To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." - -You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." - -{% note %} - -**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". - -{% endnote %} \ No newline at end of file diff --git a/data/reusables/rest-reference/teams/teams.md b/data/reusables/rest-reference/teams/teams.md deleted file mode 100644 index 474b518f9f..0000000000 --- a/data/reusables/rest-reference/teams/teams.md +++ /dev/null @@ -1 +0,0 @@ -This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. \ No newline at end of file diff --git a/data/reusables/rest-reference/users/blocking.md b/data/reusables/rest-reference/users/blocking.md deleted file mode 100644 index 5f87595b05..0000000000 --- a/data/reusables/rest-reference/users/blocking.md +++ /dev/null @@ -1 +0,0 @@ -## Blocking users \ No newline at end of file diff --git a/data/reusables/rest-reference/users/followers.md b/data/reusables/rest-reference/users/followers.md deleted file mode 100644 index fe69d95988..0000000000 --- a/data/reusables/rest-reference/users/followers.md +++ /dev/null @@ -1 +0,0 @@ -## Followers \ No newline at end of file diff --git a/data/reusables/rest-reference/users/keys.md b/data/reusables/rest-reference/users/keys.md deleted file mode 100644 index c97ff53f27..0000000000 --- a/data/reusables/rest-reference/users/keys.md +++ /dev/null @@ -1 +0,0 @@ -## Git SSH keys \ No newline at end of file diff --git a/data/reusables/rest-reference/webhooks/repo-config.md b/data/reusables/rest-reference/webhooks/repo-config.md deleted file mode 100644 index 055bbb9fa1..0000000000 --- a/data/reusables/rest-reference/webhooks/repo-config.md +++ /dev/null @@ -1 +0,0 @@ -## Repository webhook configuration \ No newline at end of file diff --git a/data/reusables/rest-reference/webhooks/repo-deliveries.md b/data/reusables/rest-reference/webhooks/repo-deliveries.md deleted file mode 100644 index bd0366dee6..0000000000 --- a/data/reusables/rest-reference/webhooks/repo-deliveries.md +++ /dev/null @@ -1 +0,0 @@ -## Repository webhook deliveries \ No newline at end of file diff --git a/data/reusables/rest-reference/webhooks/repos.md b/data/reusables/rest-reference/webhooks/repos.md deleted file mode 100644 index ce7734c9d9..0000000000 --- a/data/reusables/rest-reference/webhooks/repos.md +++ /dev/null @@ -1 +0,0 @@ -## Repository webhooks \ No newline at end of file diff --git a/data/reusables/webhooks/pull_request_review_thread_short_desc.md b/data/reusables/webhooks/pull_request_review_thread_short_desc.md new file mode 100644 index 0000000000..7d835cbe5a --- /dev/null +++ b/data/reusables/webhooks/pull_request_review_thread_short_desc.md @@ -0,0 +1 @@ +Activity related to a comment thread on a pull request being marked as resolved or unresolved. {% data reusables.webhooks.action_type_desc %} \ No newline at end of file diff --git a/data/reusables/webhooks/pull_request_thread_properties.md b/data/reusables/webhooks/pull_request_thread_properties.md new file mode 100644 index 0000000000..b592f19ab5 --- /dev/null +++ b/data/reusables/webhooks/pull_request_thread_properties.md @@ -0,0 +1,5 @@ +Key | Type | Description +----|------|------------ +`action` | `string` | The action that was performed. Can be one of:
    • `resolved` - A comment thread on a pull request was marked as resolved.
    • `unresolved` - A previously resolved comment thread on a pull request was marked as unresolved.
    +`pull_request` | `object` | The [pull request](/rest/reference/pulls) the thread pertains to. +`thread` | `object` | The thread that was affected. diff --git a/data/reusables/webhooks/secret_scanning_alert_event_short_desc.md b/data/reusables/webhooks/secret_scanning_alert_event_short_desc.md index fc3439a85f..8d68509ba6 100644 --- a/data/reusables/webhooks/secret_scanning_alert_event_short_desc.md +++ b/data/reusables/webhooks/secret_scanning_alert_event_short_desc.md @@ -1 +1,2 @@ -Activity related to secret scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see the "[secret scanning API](/rest/reference/secret-scanning)." +Activity related to secret scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see the "[secret scanning API](/rest/secret-scanning)." + diff --git a/data/ui.yml b/data/ui.yml index 5af9944a20..6c2c2fdc5f 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -126,6 +126,7 @@ products: preview_header_is_required: This header is required preview_notice_to_change: This API is under preview and subject to change works_with_github_apps: Works with GitHub Apps + api_reference: REST API reference footer: all_rights_reserved: All rights reserved terms: Terms diff --git a/lib/get-mini-toc-items.js b/lib/get-mini-toc-items.js index 3d3faeae5b..9b5bf6cfa9 100644 --- a/lib/get-mini-toc-items.js +++ b/lib/get-mini-toc-items.js @@ -1,7 +1,12 @@ import cheerio from 'cheerio' import { range } from 'lodash-es' -export default function getMiniTocItems(html, maxHeadingLevel = 2, headingScope = '') { +export default function getMiniTocItems( + html, + maxHeadingLevel = 2, + headingScope = '', + isRestPage = false +) { const $ = cheerio.load(html, { xmlMode: true }) // eg `h2, h3` or `h2, h3, h4` depending on maxHeadingLevel @@ -38,7 +43,9 @@ export default function getMiniTocItems(html, maxHeadingLevel = 2, headingScope // remove any tags but leave content $('strong', item).map((i, el) => $(el).replaceWith($(el).contents())) - const contents = `${$(item).html()}` + const contents = isRestPage + ? { href: `${href}`, title: `${$(item).html()}` } + : `${$(item).html()}` const headingLevel = parseInt($(item)[0].name.match(/\d+/)[0], 10) || 0 // the `2` from `h2` const platform = $(item).parent('.extended-markdown').attr('class') || '' diff --git a/lib/path-utils.js b/lib/path-utils.js index 5053a85799..46db6e47db 100644 --- a/lib/path-utils.js +++ b/lib/path-utils.js @@ -97,6 +97,10 @@ export function getProductStringFromPath(href) { if (pathParts.includes('early-access')) return 'early-access' + // For rest pages the currentProduct should be rest + // We use this to show SidebarRest, which is a different sidebar than the rest of the site + if (pathParts[1] === 'rest') return 'rest' + return productIds.includes(pathParts[2]) ? pathParts[2] : pathParts[1] } diff --git a/lib/redirects/static/client-side-rest-api-redirects.json b/lib/redirects/static/client-side-rest-api-redirects.json index 8942c8e74c..9578ae7952 100644 --- a/lib/redirects/static/client-side-rest-api-redirects.json +++ b/lib/redirects/static/client-side-rest-api-redirects.json @@ -1,161 +1,948 @@ { - "/rest/reference/repos#list-repository-collaborators": "/rest/reference/collaborators#list-repository-collaborators", - "/rest/reference/repos#check-if-a-user-is-a-repository-collaborator": "/rest/reference/collaborators#check-if-a-user-is-a-repository-collaborator", - "/rest/reference/repos#add-a-repository-collaborator": "/rest/reference/collaborators#add-a-repository-collaborator", - "/rest/reference/repos#remove-a-repository-collaborator": "/rest/reference/collaborators#remove-a-repository-collaborator", - "/rest/reference/repos#get-repository-permissions-for-a-user": "/rest/reference/collaborators#get-repository-permissions-for-a-user", - "/rest/reference/repos#list-commit-comments-for-a-repository": "/rest/reference/commits#list-commit-comments-for-a-repository", - "/rest/reference/repos#get-a-commit-comment": "/rest/reference/commits#get-a-commit-comment", - "/rest/reference/repos#update-a-commit-comment": "/rest/reference/commits#update-a-commit-comment", - "/rest/reference/repos#delete-a-commit-comment": "/rest/reference/commits#delete-a-commit-comment", - "/rest/reference/repos#list-commits": "/rest/reference/commits#list-commits", - "/rest/reference/repos#list-branches-for-head-commit": "/rest/reference/commits#list-branches-for-head-commit", - "/rest/reference/repos#list-commit-comments": "/rest/reference/commits#list-commit-comments", - "/rest/reference/repos#create-a-commit-comment": "/rest/reference/commits#create-a-commit-comment", - "/rest/reference/repos#list-pull-requests-associated-with-a-commit": "/rest/reference/commits#list-pull-requests-associated-with-a-commit", - "/rest/reference/repos#get-a-commit": "/rest/reference/commits#get-a-commit", - "/rest/reference/repos#get-the-combined-status-for-a-specific-reference": "/rest/reference/commits#get-the-combined-status-for-a-specific-reference", - "/rest/reference/repos#list-commit-statuses-for-a-reference": "/rest/reference/commits#list-commit-statuses-for-a-reference", - "/rest/reference/repos#get-community-profile-metrics": "/rest/reference/metrics#get-community-profile-metrics", - "/rest/reference/repos#compare-two-commits": "/rest/reference/commits#compare-two-commits", - "/rest/reference/repos#get-all-environments": "/rest/reference/deployments#get-all-environments", - "/rest/reference/repos#get-an-environment": "/rest/reference/deployments#get-an-environment", - "/rest/reference/repos#create-or-update-an-environment": "/rest/reference/deployments#create-or-update-an-environment", - "/rest/reference/repos#delete-an-environment": "/rest/reference/deployments#delete-an-environment", - "/rest/reference/repos#list-repository-invitations": "/rest/reference/collaborators#list-repository-invitations", - "/rest/reference/repos#update-a-repository-invitation": "/rest/reference/collaborators#update-a-repository-invitation", - "/rest/reference/repos#delete-a-repository-invitation": "/rest/reference/collaborators#delete-a-repository-invitation", - "/rest/reference/repos#list-deploy-keys": "/rest/reference/deploy_keys#list-deploy-keys", - "/rest/reference/repos#create-a-deploy-key": "/rest/reference/deploy_keys#create-a-deploy-key", - "/rest/reference/repos#get-a-deploy-key": "/rest/reference/deploy_keys#get-a-deploy-key", - "/rest/reference/repos#delete-a-deploy-key": "/rest/reference/deploy_keys#delete-a-deploy-key", - "/rest/reference/repos#deploy-keys": "/rest/reference/deploy_keys", - "/rest/reference/deployments#list-deploy-keys": "/rest/reference/deploy_keys#list-deploy-keys", - "/rest/reference/deployments#create-a-deploy-key": "/rest/reference/deploy_keys#create-a-deploy-key", - "/rest/reference/deployments#get-a-deploy-key": "/rest/reference/deploy_keys#get-a-deploy-key", - "/rest/reference/deployments#delete-a-deploy-key": "/rest/reference/deploy_keys#delete-a-deploy-key", - "/rest/reference/deployments#deploy-keys": "/rest/reference/deploy_keys", - "/rest/reference/repos#get-a-github-pages-site": "/rest/reference/pages#get-a-github-pages-site", - "/rest/reference/repos#create-a-github-pages-site": "/rest/reference/pages#create-a-github-pages-site", - "/rest/reference/repos#update-information-about-a-github-pages-site": "/rest/reference/pages#update-information-about-a-github-pages-site", - "/rest/reference/repos#delete-a-github-pages-site": "/rest/reference/pages#delete-a-github-pages-site", - "/rest/reference/repos#list-github-pages-builds": "/rest/reference/pages#list-github-pages-builds", - "/rest/reference/repos#request-a-github-pages-build": "/rest/reference/pages#request-a-github-pages-build", - "/rest/reference/repos#get-latest-pages-build": "/rest/reference/pages#get-latest-pages-build", - "/rest/reference/repos#get-github-pages-build": "/rest/reference/pages#get-github-pages-build", - "/rest/reference/repos#get-a-dns-health-check-for-github-pages": "/rest/reference/pages#get-a-dns-health-check-for-github-pages", - "/rest/reference/repos#get-the-weekly-commit-activity": "/rest/reference/metrics#get-the-weekly-commit-activity", - "/rest/reference/repos#get-the-last-year-of-commit-activity": "/rest/reference/metrics#get-the-last-year-of-commit-activity", - "/rest/reference/repos#get-all-contributor-commit-activity": "/rest/reference/metrics#get-all-contributor-commit-activity", - "/rest/reference/repos#get-the-weekly-commit-count": "/rest/reference/metrics#get-the-weekly-commit-count", - "/rest/reference/repos#get-the-hourly-commit-count-for-each-day": "/rest/reference/metrics#get-the-hourly-commit-count-for-each-day", - "/rest/reference/repos#create-a-commit-status": "/rest/reference/commits#create-a-commit-status", - "/rest/reference/repos#get-repository-clones": "/rest/reference/metrics#get-repository-clones", - "/rest/reference/repos#get-top-referral-paths": "/rest/reference/metrics#get-top-referral-paths", - "/rest/reference/repos#get-top-referral-sources": "/rest/reference/metrics#get-top-referral-sources", - "/rest/reference/repos#get-page-views": "/rest/reference/metrics#get-page-views", - "/rest/reference/repos#list-repository-invitations-for-the-authenticated-user": "/rest/reference/collaborators#list-repository-invitations-for-the-authenticated-user", - "/rest/reference/repos#accept-a-repository-invitation": "/rest/reference/collaborators#accept-a-repository-invitation", - "/rest/reference/repos#decline-a-repository-invitation": "/rest/reference/collaborators#decline-a-repository-invitation", - "/rest/reference/repos#list-branches": "/rest/reference/branches#list-branches", - "/rest/reference/repos#get-a-branch": "/rest/reference/branches#get-a-branch", - "/rest/reference/repos#rename-a-branch": "/rest/reference/branches#rename-a-branch", - "/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository": "/rest/reference/branches#sync-a-fork-branch-with-the-upstream-repository", - "/rest/reference/repos#merge-a-branch": "/rest/reference/branches#merge-a-branch", - "/rest/reference/repos#add-app-access-restrictions": "/rest/reference/branches#add-app-access-restrictions", - "/rest/reference/repos#add-status-check-contexts": "/rest/reference/branches#add-status-check-contexts", - "/rest/reference/repos#add-team-access-restrictions": "/rest/reference/branches#add-team-access-restrictions", - "/rest/reference/repos#add-user-access-restrictions": "/rest/reference/branches#add-user-access-restrictions", - "/rest/reference/repos#create-commit-signature-protection": "/rest/reference/branches#create-commit-signature-protection", - "/rest/reference/repos#delete-access-restrictions": "/rest/reference/branches#delete-access-restrictions", - "/rest/reference/repos#delete-admin-branch-protection": "/rest/reference/branches#delete-admin-branch-protection", - "/rest/reference/repos#delete-branch-protection": "/rest/reference/branches#delete-branch-protection", - "/rest/reference/repos#delete-commit-signature-protection": "/rest/reference/branches#delete-commit-signature-protection", - "/rest/reference/repos#delete-pull-request-review-protection": "/rest/reference/branches#delete-pull-request-review-protection", - "/rest/reference/repos#get-access-restrictions": "/rest/reference/branches#get-access-restrictions", - "/rest/reference/repos#get-admin-branch-protection": "/rest/reference/branches#get-admin-branch-protection", - "/rest/reference/repos#get-all-status-check-contexts": "/rest/reference/branches#get-all-status-check-contexts", - "/rest/reference/repos#list-apps-with-access-to-the-protected-branch": "/rest/reference/branches#list-apps-with-access-to-the-protected-branch", - "/rest/reference/repos#update-pull-request-review-protection": "/rest/reference/branches#update-pull-request-review-protection", - "/rest/reference/repos#get-branch-protection": "/rest/reference/branches#get-branch-protection", - "/rest/reference/repos#get-commit-signature-protection": "/rest/reference/branches#get-commit-signature-protection", - "/rest/reference/repos#get-pull-request-review-protection": "/rest/reference/branches#get-pull-request-review-protection", - "/rest/reference/repos#get-status-checks-protection": "/rest/reference/branches#get-status-checks-protection", - "/rest/reference/repos#list-teams-with-access-to-the-protected-branch": "/rest/reference/branches#list-teams-with-access-to-the-protected-branch", - "/rest/reference/repos#list-users-with-access-to-the-protected-branch": "/rest/reference/branches#list-users-with-access-to-the-protected-branch", - "/rest/reference/repos#remove-app-access-restrictions": "/rest/reference/branches#remove-app-access-restrictions", - "/rest/reference/repos#remove-status-check-contexts": "/rest/reference/branches#remove-status-check-contexts", - "/rest/reference/repos#remove-status-check-protection": "/rest/reference/branches#remove-status-check-protection", - "/rest/reference/repos#remove-team-access-restrictions": "/rest/reference/branches#remove-team-access-restrictions", - "/rest/reference/repos#remove-user-access-restrictions": "/rest/reference/branches#remove-user-access-restrictions", - "/rest/reference/repos#set-admin-branch-protection": "/rest/reference/branches#set-admin-branch-protection", - "/rest/reference/repos#set-app-access-restrictions": "/rest/reference/branches#set-app-access-restrictions", - "/rest/reference/repos#set-status-check-contexts": "/rest/reference/branches#set-status-check-contexts", - "/rest/reference/repos#set-team-access-restrictions": "/rest/reference/branches#set-team-access-restrictions", - "/rest/reference/repos#set-user-access-restrictions": "/rest/reference/branches#set-user-access-restrictions", - "/rest/reference/repos#update-branch-protection": "/rest/reference/branches#update-branch-protection", - "/rest/reference/repos#update-status-check-protection": "/rest/reference/branches#update-status-check-protection", - "/rest/reference/repos#create-a-deployment-status": "/rest/reference/deployments#create-a-deployment-status", - "/rest/reference/repos#list-deployment-statuses": "/rest/reference/deployments#list-deployment-statuses", - "/rest/reference/repos#get-a-deployment-status": "/rest/reference/deployments#get-a-deployment-status", - "/rest/reference/repos#list-deployments": "/rest/reference/deployments#list-deployments", - "/rest/reference/repos#create-a-deployment": "/rest/reference/deployments#create-a-deployment", - "/rest/reference/repos#get-a-deployment": "/rest/reference/deployments#get-a-deployment", - "/rest/reference/repos#delete-a-deployment": "/rest/reference/deployments#delete-a-deployment", - "/rest/reference/repos#list-releases": "/rest/reference/releases#list-releases", - "/rest/reference/repos#create-a-release": "/rest/reference/releases#create-a-release", - "/rest/reference/repos#generate-release-notes": "/rest/reference/releases#generate-release-notes", - "/rest/reference/repos#get-the-latest-release": "/rest/reference/releases#get-the-latest-release", - "/rest/reference/repos#get-a-release-by-tag-name": "/rest/reference/releases#get-a-release-by-tag-name", - "/rest/reference/repos#get-a-release": "/rest/reference/releases#get-a-release", - "/rest/reference/repos#update-a-release": "/rest/reference/releases#update-a-release", - "/rest/reference/repos#delete-a-release": "/rest/reference/releases#delete-a-release", - "/rest/reference/repos#delete-a-release-asset": "/rest/reference/releases#delete-a-release-asset", - "/rest/reference/repos#get-a-release-asset": "/rest/reference/releases#get-a-release-asset", - "/rest/reference/repos#list-release-assets": "/rest/reference/releases#list-release-assets", - "/rest/reference/repos#update-a-release-asset": "/rest/reference/releases#update-a-release-asset", - "/rest/reference/repos#upload-a-release-asset": "/rest/reference/releases#upload-a-release-asset", - "/rest/reference/repos#list-repository-webhooks": "/rest/reference/webhooks#list-repository-webhooks", - "/rest/reference/repos#create-a-repository-webhook": "/rest/reference/webhooks#create-a-repository-webhook", - "/rest/reference/repos#get-a-repository-webhook": "/rest/reference/webhooks#get-a-repository-webhook", - "/rest/reference/repos#update-a-repository-webhook": "/rest/reference/webhooks#update-a-repository-webhook", - "/rest/reference/repos#delete-a-repository-webhook": "/rest/reference/webhooks#delete-a-repository-webhook", - "/rest/reference/repos#ping-a-repository-webhook": "/rest/reference/webhooks#ping-a-repository-webhook", - "/rest/reference/repos#test-the-push-repository-webhook": "/rest/reference/webhooks#test-the-push-repository-webhook", - "/rest/reference/repos#get-a-webhook-configuration-for-a-repository": "/rest/reference/webhooks#get-a-webhook-configuration-for-a-repository", - "/rest/reference/repos#update-a-webhook-configuration-for-a-repository": "/rest/reference/webhooks#update-a-webhook-configuration-for-a-repository", - "/rest/reference/repos#get-a-delivery-for-a-repository-webhook": "/rest/reference/webhooks#get-a-delivery-for-a-repository-webhook", - "/rest/reference/repos#list-deliveries-for-a-repository-webhook": "/rest/reference/webhooks#list-deliveries-for-a-repository-webhook", - "/rest/reference/repos#redeliver-a-delivery-for-a-repository-webhook": "/rest/reference/webhooks#redeliver-a-delivery-for-a-repository-webhook", - "/rest/reference/enterprise-admin#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise": "/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise", - "/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/reference/actions#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", - "/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise": "/rest/reference/actions#create-a-registration-token-for-an-enterprise", - "/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise": "/rest/reference/actions#create-a-remove-token-for-an-enterprise", - "/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise": "/rest/reference/actions#create-self-hosted-runner-group-for-an-enterprise", - "/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise": "/rest/reference/actions#delete-self-hosted-runner-from-an-enterprise", - "/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise": "/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-enterprise", - "/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise": "/rest/reference/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise", - "/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise": "/rest/reference/actions#enable-a-selected-organization-for-github-actions-in-an-enterprise", - "/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise": "/rest/reference/actions#get-allowed-actions-for-an-enterprise", - "/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise": "/rest/reference/actions#get-github-actions-permissions-for-an-enterprise", - "/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise": "/rest/reference/actions#get-a-self-hosted-runner-for-an-enterprise", - "/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise": "/rest/reference/actions#get-a-self-hosted-runner-group-for-an-enterprise", - "/rest/reference/enterprise-admin#list-labels-for-a-self-hosted-runner-for-an-enterprise": "/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-enterprise", - "/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise": "/rest/reference/actions#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise", - "/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise": "/rest/reference/actions#list-runner-applications-for-an-enterprise", - "/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise": "/rest/reference/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", - "/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise": "/rest/reference/actions#list-self-hosted-runner-groups-for-an-enterprise", - "/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise": "/rest/reference/actions#list-self-hosted-runners-for-an-enterprise", - "/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise": "/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-enterprise", - "/rest/reference/enterprise-admin#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise": "/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise", - "/rest/reference/enterprise-admin#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise": "/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise", - "/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/reference/actions#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", - "/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise": "/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-enterprise", - "/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise": "/rest/reference/actions#set-allowed-actions-for-an-enterprise", - "/rest/reference/enterprise-admin#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise": "/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise", - "/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise": "/rest/reference/actions#set-github-actions-permissions-for-an-enterprise", - "/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/reference/actions#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", - "/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise": "/rest/reference/actions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", - "/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise": "/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-enterprise", - "/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise": "/rest/reference/actions#update-a-self-hosted-runner-group-for-an-enterprise" + "/rest/repos#list-repository-collaborators": "/rest/collaborators/collaborators#list-repository-collaborators", + "/rest/repos#check-if-a-user-is-a-repository-collaborator": "/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator", + "/rest/repos#add-a-repository-collaborator": "/rest/collaborators/collaborators#add-a-repository-collaborator", + "/rest/repos#remove-a-repository-collaborator": "/rest/collaborators/collaborators#remove-a-repository-collaborator", + "/rest/repos#get-repository-permissions-for-a-user": "/rest/collaborators/collaborators#get-repository-permissions-for-a-user", + "/rest/repos#list-commit-comments-for-a-repository": "/rest/commits/comments#list-commit-comments-for-a-repository", + "/rest/repos#get-a-commit-comment": "/rest/commits/comments#get-a-commit-comment", + "/rest/repos#update-a-commit-comment": "/rest/commits/comments#update-a-commit-comment", + "/rest/repos#delete-a-commit-comment": "/rest/commits/comments#delete-a-commit-comment", + "/rest/repos#list-commits": "/rest/commits/commits#list-commits", + "/rest/repos#list-branches-for-head-commit": "/rest/commits/commits#list-branches-for-head-commit", + "/rest/repos#list-commit-comments": "/rest/commits/comments#list-commit-comments", + "/rest/repos#create-a-commit-comment": "/rest/commits/comments#create-a-commit-comment", + "/rest/repos#list-pull-requests-associated-with-a-commit": "/rest/commits/commits#list-pull-requests-associated-with-a-commit", + "/rest/repos#get-a-commit": "/rest/commits/commits#get-a-commit", + "/rest/repos#get-the-combined-status-for-a-specific-reference": "/rest/commits/statuses#get-the-combined-status-for-a-specific-reference", + "/rest/repos#list-commit-statuses-for-a-reference": "/rest/commits/statuses#list-commit-statuses-for-a-reference", + "/rest/repos#get-community-profile-metrics": "/rest/metrics/community#get-community-profile-metrics", + "/rest/repos#compare-two-commits": "/rest/commits/commits#compare-two-commits", + "/rest/repos#get-all-environments": "/rest/deployments/environments#get-all-environments", + "/rest/repos#get-an-environment": "/rest/deployments/environments#get-an-environment", + "/rest/repos#create-or-update-an-environment": "/rest/deployments/environments#create-or-update-an-environment", + "/rest/repos#delete-an-environment": "/rest/deployments/environments#delete-an-environment", + "/rest/repos#list-repository-invitations": "/rest/collaborators/invitations#list-repository-invitations", + "/rest/repos#update-a-repository-invitation": "/rest/collaborators/invitations#update-a-repository-invitation", + "/rest/repos#delete-a-repository-invitation": "/rest/collaborators/invitations#delete-a-repository-invitation", + "/rest/repos#list-deploy-keys": "/rest/deploy-keys#list-deploy-keys", + "/rest/repos#create-a-deploy-key": "/rest/deploy-keys#create-a-deploy-key", + "/rest/repos#get-a-deploy-key": "/rest/deploy-keys#get-a-deploy-key", + "/rest/repos#delete-a-deploy-key": "/rest/deploy-keys#delete-a-deploy-key", + "/rest/repos#get-a-github-pages-site": "/rest/pages#get-a-github-pages-site", + "/rest/repos#create-a-github-pages-site": "/rest/pages#create-a-github-pages-site", + "/rest/repos#update-information-about-a-github-pages-site": "/rest/pages#update-information-about-a-github-pages-site", + "/rest/repos#delete-a-github-pages-site": "/rest/pages#delete-a-github-pages-site", + "/rest/repos#list-github-pages-builds": "/rest/pages#list-github-pages-builds", + "/rest/repos#request-a-github-pages-build": "/rest/pages#request-a-github-pages-build", + "/rest/repos#get-latest-pages-build": "/rest/pages#get-latest-pages-build", + "/rest/repos#get-github-pages-build": "/rest/pages#get-github-pages-build", + "/rest/repos#get-a-dns-health-check-for-github-pages": "/rest/pages#get-a-dns-health-check-for-github-pages", + "/rest/repos#get-the-weekly-commit-activity": "/rest/metrics/statistics#get-the-weekly-commit-activity", + "/rest/repos#get-the-last-year-of-commit-activity": "/rest/metrics/statistics#get-the-last-year-of-commit-activity", + "/rest/repos#get-all-contributor-commit-activity": "/rest/metrics/statistics#get-all-contributor-commit-activity", + "/rest/repos#get-the-weekly-commit-count": "/rest/metrics/statistics#get-the-weekly-commit-count", + "/rest/repos#get-the-hourly-commit-count-for-each-day": "/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day", + "/rest/repos#create-a-commit-status": "/rest/commits/statuses#create-a-commit-status", + "/rest/repos#get-repository-clones": "/rest/metrics/traffic#get-repository-clones", + "/rest/repos#get-top-referral-paths": "/rest/metrics/traffic#get-top-referral-paths", + "/rest/repos#get-top-referral-sources": "/rest/metrics/traffic#get-top-referral-sources", + "/rest/repos#get-page-views": "/rest/metrics/traffic#get-page-views", + "/rest/repos#list-repository-invitations-for-the-authenticated-user": "/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user", + "/rest/repos#accept-a-repository-invitation": "/rest/collaborators/invitations#accept-a-repository-invitation", + "/rest/repos#decline-a-repository-invitation": "/rest/collaborators/invitations#decline-a-repository-invitation", + "/rest/repos#list-branches": "/rest/branches/branches#list-branches", + "/rest/repos#get-a-branch": "/rest/branches/branches#get-a-branch", + "/rest/repos#rename-a-branch": "/rest/branches/branches#rename-a-branch", + "/rest/repos#sync-a-fork-branch-with-the-upstream-repository": "/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository", + "/rest/repos#merge-a-branch": "/rest/branches/branches#merge-a-branch", + "/rest/repos#add-app-access-restrictions": "/rest/branches/branch-protection#add-app-access-restrictions", + "/rest/repos#add-status-check-contexts": "/rest/branches/branch-protection#add-status-check-contexts", + "/rest/repos#add-team-access-restrictions": "/rest/branches/branch-protection#add-team-access-restrictions", + "/rest/repos#add-user-access-restrictions": "/rest/branches/branch-protection#add-user-access-restrictions", + "/rest/repos#create-commit-signature-protection": "/rest/branches/branch-protection#create-commit-signature-protection", + "/rest/repos#delete-access-restrictions": "/rest/branches/branch-protection#delete-access-restrictions", + "/rest/repos#delete-admin-branch-protection": "/rest/branches/branch-protection#delete-admin-branch-protection", + "/rest/repos#delete-branch-protection": "/rest/branches/branch-protection#delete-branch-protection", + "/rest/repos#delete-commit-signature-protection": "/rest/branches/branch-protection#delete-commit-signature-protection", + "/rest/repos#delete-pull-request-review-protection": "/rest/branches/branch-protection#delete-pull-request-review-protection", + "/rest/repos#get-access-restrictions": "/rest/branches/branch-protection#get-access-restrictions", + "/rest/repos#get-admin-branch-protection": "/rest/branches/branch-protection#get-admin-branch-protection", + "/rest/repos#get-all-status-check-contexts": "/rest/branches/branch-protection#get-all-status-check-contexts", + "/rest/repos#list-apps-with-access-to-the-protected-branch": "/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch", + "/rest/repos#update-pull-request-review-protection": "/rest/branches/branch-protection#update-pull-request-review-protection", + "/rest/repos#get-branch-protection": "/rest/branches/branch-protection#get-branch-protection", + "/rest/repos#get-commit-signature-protection": "/rest/branches/branch-protection#get-commit-signature-protection", + "/rest/repos#get-pull-request-review-protection": "/rest/branches/branch-protection#get-pull-request-review-protection", + "/rest/repos#get-status-checks-protection": "/rest/branches/branch-protection#get-status-checks-protection", + "/rest/repos#list-teams-with-access-to-the-protected-branch": "/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch", + "/rest/repos#list-users-with-access-to-the-protected-branch": "/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch", + "/rest/repos#remove-app-access-restrictions": "/rest/branches/branch-protection#remove-app-access-restrictions", + "/rest/repos#remove-status-check-contexts": "/rest/branches/branch-protection#remove-status-check-contexts", + "/rest/repos#remove-status-check-protection": "/rest/branches/branch-protection#remove-status-check-protection", + "/rest/repos#remove-team-access-restrictions": "/rest/branches/branch-protection#remove-team-access-restrictions", + "/rest/repos#remove-user-access-restrictions": "/rest/branches/branch-protection#remove-user-access-restrictions", + "/rest/repos#set-admin-branch-protection": "/rest/branches/branch-protection#set-admin-branch-protection", + "/rest/repos#set-app-access-restrictions": "/rest/branches/branch-protection#set-app-access-restrictions", + "/rest/repos#set-status-check-contexts": "/rest/branches/branch-protection#set-status-check-contexts", + "/rest/repos#set-team-access-restrictions": "/rest/branches/branch-protection#set-team-access-restrictions", + "/rest/repos#set-user-access-restrictions": "/rest/branches/branch-protection#set-user-access-restrictions", + "/rest/repos#update-branch-protection": "/rest/branches/branch-protection#update-branch-protection", + "/rest/repos#update-status-check-protection": "/rest/branches/branch-protection#update-status-check-protection", + "/rest/repos#create-a-deployment-status": "/rest/deployments/statuses#create-a-deployment-status", + "/rest/repos#list-deployment-statuses": "/rest/deployments/statuses#list-deployment-statuses", + "/rest/repos#get-a-deployment-status": "/rest/deployments/statuses#get-a-deployment-status", + "/rest/repos#list-deployments": "/rest/deployments/deployments#list-deployments", + "/rest/repos#create-a-deployment": "/rest/deployments/deployments#create-a-deployment", + "/rest/repos#get-a-deployment": "/rest/deployments/deployments#get-a-deployment", + "/rest/repos#delete-a-deployment": "/rest/deployments/deployments#delete-a-deployment", + "/rest/repos#list-releases": "/rest/releases/releases#list-releases", + "/rest/repos#create-a-release": "/rest/releases/releases#create-a-release", + "/rest/repos#generate-release-notes": "/rest/releases/releases#generate-release-notes", + "/rest/repos#get-the-latest-release": "/rest/releases/releases#get-the-latest-release", + "/rest/repos#get-a-release-by-tag-name": "/rest/releases/releases#get-a-release-by-tag-name", + "/rest/repos#get-a-release": "/rest/releases/releases#get-a-release", + "/rest/repos#update-a-release": "/rest/releases/releases#update-a-release", + "/rest/repos#delete-a-release": "/rest/releases/releases#delete-a-release", + "/rest/repos#delete-a-release-asset": "/rest/releases/assets#delete-a-release-asset", + "/rest/repos#get-a-release-asset": "/rest/releases/assets#get-a-release-asset", + "/rest/repos#list-release-assets": "/rest/releases/assets#list-release-assets", + "/rest/repos#update-a-release-asset": "/rest/releases/assets#update-a-release-asset", + "/rest/repos#upload-a-release-asset": "/rest/releases/assets#upload-a-release-asset", + "/rest/repos#list-repository-webhooks": "/rest/webhooks/repos#list-repository-webhooks", + "/rest/repos#create-a-repository-webhook": "/rest/webhooks/repos#create-a-repository-webhook", + "/rest/repos#get-a-repository-webhook": "/rest/webhooks/repos#get-a-repository-webhook", + "/rest/repos#update-a-repository-webhook": "/rest/webhooks/repos#update-a-repository-webhook", + "/rest/repos#delete-a-repository-webhook": "/rest/webhooks/repos#delete-a-repository-webhook", + "/rest/repos#ping-a-repository-webhook": "/rest/webhooks/repos#ping-a-repository-webhook", + "/rest/repos#test-the-push-repository-webhook": "/rest/webhooks/repos#test-the-push-repository-webhook", + "/rest/repos#get-a-webhook-configuration-for-a-repository": "/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository", + "/rest/repos#update-a-webhook-configuration-for-a-repository": "/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository", + "/rest/repos#get-a-delivery-for-a-repository-webhook": "/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook", + "/rest/repos#list-deliveries-for-a-repository-webhook": "/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook", + "/rest/repos#redeliver-a-delivery-for-a-repository-webhook": "/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook", + "/rest/enterprise-admin#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise", + "/rest/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", + "/rest/enterprise-admin#create-a-registration-token-for-an-enterprise": "/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise", + "/rest/enterprise-admin#create-a-remove-token-for-an-enterprise": "/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise", + "/rest/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#create-self-hosted-runner-group-for-an-enterprise", + "/rest/enterprise-admin#delete-self-hosted-runner-from-an-enterprise": "/rest/actions/self-hosted-runners#delete-self-hosted-runner-from-an-enterprise", + "/rest/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise": "/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise", + "/rest/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise": "/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise", + "/rest/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise": "/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise", + "/rest/enterprise-admin#get-allowed-actions-for-an-enterprise": "/rest/actions/permissions#get-allowed-actions-for-an-enterprise", + "/rest/enterprise-admin#get-github-actions-permissions-for-an-enterprise": "/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise", + "/rest/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise", + "/rest/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise", + "/rest/enterprise-admin#list-labels-for-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise", + "/rest/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise": "/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise", + "/rest/enterprise-admin#list-runner-applications-for-an-enterprise": "/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise", + "/rest/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise": "/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "/rest/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise", + "/rest/enterprise-admin#list-self-hosted-runners-for-an-enterprise": "/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise", + "/rest/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise", + "/rest/enterprise-admin#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise", + "/rest/enterprise-admin#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise", + "/rest/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", + "/rest/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise", + "/rest/enterprise-admin#set-allowed-actions-for-an-enterprise": "/rest/actions/permissions#set-allowed-actions-for-an-enterprise", + "/rest/enterprise-admin#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise", + "/rest/enterprise-admin#set-github-actions-permissions-for-an-enterprise": "/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise", + "/rest/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/actions/self-hosted-runner-groups#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", + "/rest/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise": "/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "/rest/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise", + "/rest/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise", + "/rest/orgs#list-custom-repository-roles-in-an-organization": "/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization", + "/rest/repos#deploy-keys": "/rest/deploy-keys", + "/rest/deployments#deploy-keys": "/rest/deploy-keys", + "/rest/apps#get-the-authenticated-app": "/rest/apps/apps#get-the-authenticated-app", + "/rest/apps#create-a-github-app-from-a-manifest": "/rest/apps/apps#create-a-github-app-from-a-manifest", + "/rest/apps#get-a-webhook-configuration-for-an-app": "/rest/apps/webhooks#get-a-webhook-configuration-for-an-app", + "/rest/apps#webhooks": "/rest/apps/webhooks", + "/rest/apps#update-a-webhook-configuration-for-an-app": "/rest/apps/webhooks#update-a-webhook-configuration-for-an-app", + "/rest/apps#list-deliveries-for-an-app-webhook": "/rest/apps/webhooks#list-deliveries-for-an-app-webhook", + "/rest/apps#get-a-delivery-for-an-app-webhook": "/rest/apps/webhooks#get-a-delivery-for-an-app-webhook", + "/rest/apps#redeliver-a-delivery-for-an-app-webhook": "/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook", + "/rest/apps#list-installations-for-the-authenticated-app": "/rest/apps/apps#list-installations-for-the-authenticated-app", + "/rest/apps#get-an-installation-for-the-authenticated-app": "/rest/apps/apps#get-an-installation-for-the-authenticated-app", + "/rest/apps#delete-an-installation-for-the-authenticated-app": "/rest/apps/apps#delete-an-installation-for-the-authenticated-app", + "/rest/apps/#create-an-installation-access-token-for-an-app": "/rest/apps/apps#create-an-installation-access-token-for-an-app", + "/rest/apps#suspend-an-app-installation": "/rest/apps/apps#suspend-an-app-installation", + "/rest/apps#unsuspend-an-app-installation": "/rest/apps/apps#unsuspend-an-app-installation", + "/rest/apps#delete-an-app-authorization": "/rest/apps/oauth-applications#delete-an-app-authorization", + "/rest/apps#oauth-applications": "/rest/apps/oauth-applications", + "/rest/apps#check-a-token": "/rest/apps/oauth-applications#check-a-token", + "/rest/apps#reset-a-token": "/rest/apps/oauth-applications#reset-a-token", + "/rest/apps#delete-an-app-token": "/rest/apps/oauth-applications#delete-an-app-token", + "/rest/apps#create-a-scoped-access-token": "/rest/apps/oauth-applications#create-a-scoped-access-token", + "/rest/apps/#get-an-app": "/rest/apps/apps#get-an-app", + "/rest/actions#get-github-actions-cache-usage-for-an-enterprise": "/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise", + "/rest/actions#cache": "/rest/actions/cache", + "/rest/actions#get-github-actions-permissions-for-an-enterprise": "/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise", + "/rest/actions#permissions": "/rest/actions/permissions", + "/rest/actions#set-github-actions-permissions-for-an-enterprise": "/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise", + "/rest/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise": "/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "/rest/actions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise": "/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "/rest/actions#enable-a-selected-organization-for-github-actions-in-an-enterprise": "/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise", + "/rest/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise": "/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise", + "/rest/actions#get-allowed-actions-for-an-enterprise": "/rest/actions/permissions#get-allowed-actions-for-an-enterprise", + "/rest/actions#set-allowed-actions-for-an-enterprise": "/rest/actions/permissions#set-allowed-actions-for-an-enterprise", + "/rest/actions#list-self-hosted-runner-groups-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise", + "/rest/actions#self-hosted-runner-groups": "/rest/actions/self-hosted-runner-groups", + "/rest/actions#create-self-hosted-runner-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#create-self-hosted-runner-group-for-an-enterprise", + "/rest/actions#get-a-self-hosted-runner-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise", + "/rest/actions#update-a-self-hosted-runner-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise", + "/rest/actions#delete-a-self-hosted-runner-group-from-an-enterprise": "/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise", + "/rest/actions#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise": "/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise", + "/rest/actions#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/actions/self-hosted-runner-groups#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", + "/rest/actions#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", + "/rest/actions#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise": "/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise", + "/rest/actions#list-self-hosted-runners-in-a-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise", + "/rest/actions#set-self-hosted-runners-in-a-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise", + "/rest/actions#add-a-self-hosted-runner-to-a-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise", + "/rest/actions#remove-a-self-hosted-runner-from-a-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise", + "/rest/actions#list-self-hosted-runners-for-an-enterprise": "/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise", + "/rest/actions#self-hosted-runners": "/rest/actions/self-hosted-runners", + "/rest/actions#list-runner-applications-for-an-enterprise": "/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise", + "/rest/actions#create-a-registration-token-for-an-enterprise": "/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise", + "/rest/actions#create-a-remove-token-for-an-enterprise": "/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise", + "/rest/actions#get-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise", + "/rest/actions#delete-self-hosted-runner-from-an-enterprise": "/rest/actions/self-hosted-runners#delete-self-hosted-runner-from-an-enterprise", + "/rest/actions#list-labels-for-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise", + "/rest/actions#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise", + "/rest/actions#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise", + "/rest/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise", + "/rest/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise": "/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise", + "/rest/enterprise-admin#get-the-audit-log-for-an-enterprise": "/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise", + "/rest/enterprise-admin#audit-log": "/rest/enterprise-admin/audit-log", + "/rest/billing#get-github-actions-billing-for-an-enterprise": "/rest/enterprise-admin/billing#get-github-actions-billing-for-an-enterprise", + "/rest/enterprise-admin#billing": "/rest/enterprise-admin/billing", + "/rest/billing#export-advanced-security-active-committers-data-for-enterprise": "/rest/enterprise-admin/billing#export-advanced-security-active-committers-data-for-enterprise", + "/rest/billing#get-github-packages-billing-for-an-enterprise": "/rest/enterprise-admin/billing#get-github-packages-billing-for-an-enterprise", + "/rest/billing#get-shared-storage-billing-for-an-enterprise": "/rest/enterprise-admin/billing#get-shared-storage-billing-for-an-enterprise", + "/rest/activity#list-public-events": "/rest/activity/events#list-public-events", + "/rest/activity#events": "/rest/activity/events", + "/rest/activity#get-feeds": "/rest/activity/feeds#get-feeds", + "/rest/activity#feeds": "/rest/activity/feeds", + "/rest/gists#list-gists-for-the-authenticated-user": "/rest/gists/gists#list-gists-for-the-authenticated-user", + "/rest/gists#create-a-gist": "/rest/gists/gists#create-a-gist", + "/rest/gists#list-public-gists": "/rest/gists/gists#list-public-gists", + "/rest/gists#list-starred-gists": "/rest/gists/gists#list-starred-gists", + "/rest/gists#get-a-gist": "/rest/gists/gists#get-a-gist", + "/rest/gists/#update-a-gist": "/rest/gists/gists#update-a-gist", + "/rest/gists#delete-a-gist": "/rest/gists/gists#delete-a-gist", + "/rest/gists#list-gist-comments": "/rest/gists/comments#list-gist-comments", + "/rest/gists#comments": "/rest/gists/comments", + "/rest/gists#create-a-gist-comment": "/rest/gists/comments#create-a-gist-comment", + "/rest/gists#get-a-gist-comment": "/rest/gists/comments#get-a-gist-comment", + "/rest/gists#update-a-gist-comment": "/rest/gists/comments#update-a-gist-comment", + "/rest/gists#delete-a-gist-comment": "/rest/gists/comments#delete-a-gist-comment", + "/rest/gists#list-gist-commits": "/rest/gists/gists#list-gist-commits", + "/rest/gists#list-gist-forks": "/rest/gists/gists#list-gist-forks", + "/rest/gists#fork-a-gist": "/rest/gists/gists#fork-a-gist", + "/rest/gists#check-if-a-gist-is-starred": "/rest/gists/gists#check-if-a-gist-is-starred", + "/rest/gists#star-a-gist": "/rest/gists/gists#star-a-gist", + "/rest/gists#unstar-a-gist": "/rest/gists/gists#unstar-a-gist", + "/rest/gists#get-a-gist-revision": "/rest/gists/gists#get-a-gist-revision", + "/rest/apps#list-repositories-accessible-to-the-app-installation": "/rest/apps/installations#list-repositories-accessible-to-the-app-installation", + "/rest/apps#installations": "/rest/apps/installations", + "/rest/apps#revoke-an-installation-access-token": "/rest/apps/installations#revoke-an-installation-access-token", + "/rest/issues#list-issues-assigned-to-the-authenticated-user": "/rest/issues/issues#list-issues-assigned-to-the-authenticated-user", + "/rest/apps#get-a-subscription-plan-for-an-account": "/rest/apps/marketplace#get-a-subscription-plan-for-an-account", + "/rest/apps#marketplace": "/rest/apps/marketplace", + "/rest/apps#list-plans": "/rest/apps/marketplace#list-plans", + "/rest/apps#list-accounts-for-a-plan": "/rest/apps/marketplace#list-accounts-for-a-plan", + "/rest/apps#get-a-subscription-plan-for-an-account-stubbed": "/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed", + "/rest/apps#list-plans-stubbed": "/rest/apps/marketplace#list-plans-stubbed", + "/rest/apps#list-accounts-for-a-plan-stubbed": "/rest/apps/marketplace#list-accounts-for-a-plan-stubbed", + "/rest/activity#list-public-events-for-a-network-of-repositories": "/rest/activity/events#list-public-events-for-a-network-of-repositories", + "/rest/activity#list-notifications-for-the-authenticated-user": "/rest/activity/notifications#list-notifications-for-the-authenticated-user", + "/rest/activity#notifications": "/rest/activity/notifications", + "/rest/activity#mark-notifications-as-read": "/rest/activity/notifications#mark-notifications-as-read", + "/rest/activity#get-a-thread": "/rest/activity/notifications#get-a-thread", + "/rest/activity#mark-a-thread-as-read": "/rest/activity/notifications#mark-a-thread-as-read", + "/rest/activity#get-a-thread-subscription-for-the-authenticated-user": "/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user", + "/rest/activity#set-a-thread-subscription": "/rest/activity/notifications#set-a-thread-subscription", + "/rest/activity#delete-a-thread-subscription": "/rest/activity/notifications#delete-a-thread-subscription", + "/rest/orgs#list-organizations": "/rest/orgs/orgs#list-organizations", + "/rest/orgs#custom-roles": "/rest/orgs/custom-roles", + "/rest/orgs#get-an-organization": "/rest/orgs/orgs#get-an-organization", + "/rest/orgs/#update-an-organization": "/rest/orgs/orgs#update-an-organization", + "/rest/actions#get-github-actions-cache-usage-for-an-organization": "/rest/actions/cache#get-github-actions-cache-usage-for-an-organization", + "/rest/actions#list-repositories-with-github-actions-cache-usage-for-an-organization": "/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization", + "/rest/actions#get-github-actions-permissions-for-an-organization": "/rest/actions/permissions#get-github-actions-permissions-for-an-organization", + "/rest/actions#set-github-actions-permissions-for-an-organization": "/rest/actions/permissions#set-github-actions-permissions-for-an-organization", + "/rest/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization": "/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization", + "/rest/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization": "/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization", + "/rest/actions#enable-a-selected-repository-for-github-actions-in-an-organization": "/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization", + "/rest/actions#disable-a-selected-repository-for-github-actions-in-an-organization": "/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization", + "/rest/actions#get-allowed-actions-for-an-organization": "/rest/actions/permissions#get-allowed-actions-for-an-organization", + "/rest/actions#set-allowed-actions-for-an-organization": "/rest/actions/permissions#set-allowed-actions-for-an-organization", + "/rest/actions#get-default-workflow-permissions": "/rest/actions/permissions#get-default-workflow-permissions", + "/rest/actions#set-default-workflow-permissions": "/rest/actions/permissions#set-default-workflow-permissions", + "/rest/actions#list-self-hosted-runner-groups-for-an-organization": "/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization", + "/rest/actions#create-a-self-hosted-runner-group-for-an-organization": "/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization", + "/rest/actions#get-a-self-hosted-runner-group-for-an-organization": "/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization", + "/rest/actions#update-a-self-hosted-runner-group-for-an-organization": "/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization", + "/rest/actions#delete-a-self-hosted-runner-group-from-an-organization": "/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization", + "/rest/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization": "/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "/rest/actions#set-repository-access-to-a-self-hosted-runner-group-in-an-organization": "/rest/actions/self-hosted-runner-groups#set-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "/rest/actions#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization": "/rest/actions/self-hosted-runner-groups#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization", + "/rest/actions#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization": "/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "/rest/actions#list-self-hosted-runners-in-a-group-for-an-organization": "/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization", + "/rest/actions#set-self-hosted-runners-in-a-group-for-an-organization": "/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization", + "/rest/actions#add-a-self-hosted-runner-to-a-group-for-an-organization": "/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization", + "/rest/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization": "/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization", + "/rest/actions#list-self-hosted-runners-for-an-organization": "/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization", + "/rest/actions#list-runner-applications-for-an-organization": "/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization", + "/rest/actions#create-a-registration-token-for-an-organization": "/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization", + "/rest/actions#create-a-remove-token-for-an-organization": "/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization", + "/rest/actions#get-a-self-hosted-runner-for-an-organization": "/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization", + "/rest/actions#delete-a-self-hosted-runner-from-an-organization": "/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization", + "/rest/actions#list-labels-for-a-self-hosted-runner-for-an-organization": "/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization", + "/rest/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization": "/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization", + "/rest/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization": "/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization", + "/rest/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization": "/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", + "/rest/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization": "/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", + "/rest/actions#list-organization-secrets": "/rest/actions/secrets#list-organization-secrets", + "/rest/actions#secrets": "/rest/actions/secrets", + "/rest/actions#get-an-organization-public-key": "/rest/actions/secrets#get-an-organization-public-key", + "/rest/actions#get-an-organization-secret": "/rest/actions/secrets#get-an-organization-secret", + "/rest/actions#create-or-update-an-organization-secret": "/rest/actions/secrets#create-or-update-an-organization-secret", + "/rest/actions#delete-an-organization-secret": "/rest/actions/secrets#delete-an-organization-secret", + "/rest/actions#list-selected-repositories-for-an-organization-secret": "/rest/actions/secrets#list-selected-repositories-for-an-organization-secret", + "/rest/actions#set-selected-repositories-for-an-organization-secret": "/rest/actions/secrets#set-selected-repositories-for-an-organization-secret", + "/rest/actions#add-selected-repository-to-an-organization-secret": "/rest/actions/secrets#add-selected-repository-to-an-organization-secret", + "/rest/actions#remove-selected-repository-from-an-organization-secret": "/rest/actions/secrets#remove-selected-repository-from-an-organization-secret", + "/rest/orgs#get-audit-log": "/rest/orgs/orgs#get-audit-log", + "/rest/orgs#list-users-blocked-by-an-organization": "/rest/orgs/blocking#list-users-blocked-by-an-organization", + "/rest/orgs#blocking": "/rest/orgs/blocking", + "/rest/orgs#check-if-a-user-is-blocked-by-an-organization": "/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization", + "/rest/orgs#block-a-user-from-an-organization": "/rest/orgs/blocking#block-a-user-from-an-organization", + "/rest/orgs#unblock-a-user-from-an-organization": "/rest/orgs/blocking#unblock-a-user-from-an-organization", + "/rest/orgs#list-saml-sso-authorizations-for-an-organization": "/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization", + "/rest/orgs#remove-a-saml-sso-authorization-for-an-organization": "/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization", + "/rest/dependabot#list-organization-secrets": "/rest/dependabot/secrets#list-organization-secrets", + "/rest/dependabot#secrets": "/rest/dependabot/secrets", + "/rest/dependabot#get-an-organization-public-key": "/rest/dependabot/secrets#get-an-organization-public-key", + "/rest/dependabot#get-an-organization-secret": "/rest/dependabot/secrets#get-an-organization-secret", + "/rest/dependabot#create-or-update-an-organization-secret": "/rest/dependabot/secrets#create-or-update-an-organization-secret", + "/rest/dependabot#delete-an-organization-secret": "/rest/dependabot/secrets#delete-an-organization-secret", + "/rest/dependabot#list-selected-repositories-for-an-organization-secret": "/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret", + "/rest/dependabot#set-selected-repositories-for-an-organization-secret": "/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret", + "/rest/dependabot#add-selected-repository-to-an-organization-secret": "/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret", + "/rest/dependabot#remove-selected-repository-from-an-organization-secret": "/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret", + "/rest/activity#list-public-organization-events": "/rest/activity/events#list-public-organization-events", + "/rest/teams#external-idp-group-info-for-an-organization": "/rest/teams/external-groups#external-idp-group-info-for-an-organization", + "/rest/teams#external-groups": "/rest/teams/external-groups", + "/rest/teams#list-external-idp-groups-for-an-organization": "/rest/teams/external-groups#list-external-idp-groups-for-an-organization", + "/rest/orgs#list-failed-organization-invitations": "/rest/orgs/members#list-failed-organization-invitations", + "/rest/orgs#members": "/rest/orgs/members", + "/rest/orgs#list-organization-webhooks": "/rest/orgs/webhooks#list-organization-webhooks", + "/rest/orgs#webhooks": "/rest/orgs/webhooks", + "/rest/orgs#create-an-organization-webhook": "/rest/orgs/webhooks#create-an-organization-webhook", + "/rest/orgs#get-an-organization-webhook": "/rest/orgs/webhooks#get-an-organization-webhook", + "/rest/orgs#update-an-organization-webhook": "/rest/orgs/webhooks#update-an-organization-webhook", + "/rest/orgs#delete-an-organization-webhook": "/rest/orgs/webhooks#delete-an-organization-webhook", + "/rest/orgs#get-a-webhook-configuration-for-an-organization": "/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization", + "/rest/orgs#update-a-webhook-configuration-for-an-organization": "/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization", + "/rest/orgs#list-deliveries-for-an-organization-webhook": "/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook", + "/rest/orgs#get-a-webhook-delivery-for-an-organization-webhook": "/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook", + "/rest/orgs#redeliver-a-delivery-for-an-organization-webhook": "/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook", + "/rest/orgs#ping-an-organization-webhook": "/rest/orgs/webhooks#ping-an-organization-webhook", + "/rest/apps#get-an-organization-installation-for-the-authenticated-app": "/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app", + "/rest/orgs#list-app-installations-for-an-organization": "/rest/orgs/orgs#list-app-installations-for-an-organization", + "/rest/interactions#get-interaction-restrictions-for-an-organization": "/rest/interactions/orgs#get-interaction-restrictions-for-an-organization", + "/rest/interactions#orgs": "/rest/interactions/orgs", + "/rest/interactions#set-interaction-restrictions-for-an-organization": "/rest/interactions/orgs#set-interaction-restrictions-for-an-organization", + "/rest/interactions#remove-interaction-restrictions-for-an-organization": "/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization", + "/rest/orgs#list-pending-organization-invitations": "/rest/orgs/members#list-pending-organization-invitations", + "/rest/orgs#create-an-organization-invitation": "/rest/orgs/members#create-an-organization-invitation", + "/rest/orgs#cancel-an-organization-invitation": "/rest/orgs/members#cancel-an-organization-invitation", + "/rest/orgs#list-organization-invitation-teams": "/rest/orgs/members#list-organization-invitation-teams", + "/rest/issues#list-organization-issues-assigned-to-the-authenticated-user": "/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user", + "/rest/orgs#list-organization-members": "/rest/orgs/members#list-organization-members", + "/rest/orgs#check-organization-membership-for-a-user": "/rest/orgs/members#check-organization-membership-for-a-user", + "/rest/orgs#remove-an-organization-member": "/rest/orgs/members#remove-an-organization-member", + "/rest/orgs#get-organization-membership-for-a-user": "/rest/orgs/members#get-organization-membership-for-a-user", + "/rest/orgs#set-organization-membership-for-a-user": "/rest/orgs/members#set-organization-membership-for-a-user", + "/rest/orgs#remove-organization-membership-for-a-user": "/rest/orgs/members#remove-organization-membership-for-a-user", + "/rest/migrations#list-organization-migrations": "/rest/migrations/orgs#list-organization-migrations", + "/rest/migrations#orgs": "/rest/migrations/orgs", + "/rest/migrations#start-an-organization-migration": "/rest/migrations/orgs#start-an-organization-migration", + "/rest/migrations#get-an-organization-migration-status": "/rest/migrations/orgs#get-an-organization-migration-status", + "/rest/migrations#download-an-organization-migration-archive": "/rest/migrations/orgs#download-an-organization-migration-archive", + "/rest/migrations#delete-an-organization-migration-archive": "/rest/migrations/orgs#delete-an-organization-migration-archive", + "/rest/migrations#unlock-an-organization-repository": "/rest/migrations/orgs#unlock-an-organization-repository", + "/rest/migrations#list-repositories-in-an-organization-migration": "/rest/migrations/orgs#list-repositories-in-an-organization-migration", + "/rest/orgs#list-outside-collaborators-for-an-organization": "/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization", + "/rest/orgs#outside-collaborators": "/rest/orgs/outside-collaborators", + "/rest/orgs#convert-an-organization-member-to-outside-collaborator": "/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator", + "/rest/orgs#remove-outside-collaborator-from-an-organization": "/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization", + "/rest/projects#list-organization-projects": "/rest/projects/projects#list-organization-projects", + "/rest/projects#create-an-organization-project": "/rest/projects/projects#create-an-organization-project", + "/rest/orgs#list-public-organization-members": "/rest/orgs/members#list-public-organization-members", + "/rest/orgs#check-public-organization-membership-for-a-user": "/rest/orgs/members#check-public-organization-membership-for-a-user", + "/rest/orgs#set-public-organization-membership-for-the-authenticated-user": "/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user", + "/rest/orgs#remove-public-organization-membership-for-the-authenticated-user": "/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user", + "/rest/repos#list-organization-repositories": "/rest/repos/repos#list-organization-repositories", + "/rest/repos#create-an-organization-repository": "/rest/repos/repos#create-an-organization-repository", + "/rest/teams#list-idp-groups-for-an-organization": "/rest/teams/team-sync#list-idp-groups-for-an-organization", + "/rest/teams#team-sync": "/rest/teams/team-sync", + "/rest/teams#list-teams": "/rest/teams/teams#list-teams", + "/rest/teams#create-a-team": "/rest/teams/teams#create-a-team", + "/rest/teams#get-a-team-by-name": "/rest/teams/teams#get-a-team-by-name", + "/rest/teams#update-a-team": "/rest/teams/teams#update-a-team", + "/rest/teams#delete-a-team": "/rest/teams/teams#delete-a-team", + "/rest/teams#list-discussions": "/rest/teams/discussions#list-discussions", + "/rest/teams#discussions": "/rest/teams/discussions", + "/rest/teams#create-a-discussion": "/rest/teams/discussions#create-a-discussion", + "/rest/teams#get-a-discussion": "/rest/teams/discussions#get-a-discussion", + "/rest/teams#update-a-discussion": "/rest/teams/discussions#update-a-discussion", + "/rest/teams#delete-a-discussion": "/rest/teams/discussions#delete-a-discussion", + "/rest/teams#list-discussion-comments": "/rest/teams/discussion-comments#list-discussion-comments", + "/rest/teams#discussion-comments": "/rest/teams/discussion-comments", + "/rest/teams#create-a-discussion-comment": "/rest/teams/discussion-comments#create-a-discussion-comment", + "/rest/teams#get-a-discussion-comment": "/rest/teams/discussion-comments#get-a-discussion-comment", + "/rest/teams#update-a-discussion-comment": "/rest/teams/discussion-comments#update-a-discussion-comment", + "/rest/teams#delete-a-discussion-comment": "/rest/teams/discussion-comments#delete-a-discussion-comment", + "/rest/teams#list-external-idp-group-team-connection": "/rest/teams/external-groups#list-external-idp-group-team-connection", + "/rest/teams#link-external-idp-group-team-connection": "/rest/teams/external-groups#link-external-idp-group-team-connection", + "/rest/teams#unlink-external-idp-group-team-connection": "/rest/teams/external-groups#unlink-external-idp-group-team-connection", + "/rest/teams#list-pending-team-invitations": "/rest/teams/members#list-pending-team-invitations", + "/rest/teams#members": "/rest/teams/members", + "/rest/teams#list-team-members": "/rest/teams/members#list-team-members", + "/rest/teams#get-team-membership-for-a-user": "/rest/teams/members#get-team-membership-for-a-user", + "/rest/teams#add-or-update-team-membership-for-a-user": "/rest/teams/members#add-or-update-team-membership-for-a-user", + "/rest/teams#remove-team-membership-for-a-user": "/rest/teams/members#remove-team-membership-for-a-user", + "/rest/teams#list-team-projects": "/rest/teams/teams#list-team-projects", + "/rest/teams#check-team-permissions-for-a-project": "/rest/teams/teams#check-team-permissions-for-a-project", + "/rest/teams#add-or-update-team-project-permissions": "/rest/teams/teams#add-or-update-team-project-permissions", + "/rest/teams#remove-a-project-from-a-team": "/rest/teams/teams#remove-a-project-from-a-team", + "/rest/teams#list-team-repositories": "/rest/teams/teams#list-team-repositories", + "/rest/teams/#check-team-permissions-for-a-repository": "/rest/teams/teams#check-team-permissions-for-a-repository", + "/rest/teams/#add-or-update-team-repository-permissions": "/rest/teams/teams#add-or-update-team-repository-permissions", + "/rest/teams/#remove-a-repository-from-a-team": "/rest/teams/teams#remove-a-repository-from-a-team", + "/rest/teams#list-idp-groups-for-a-team": "/rest/teams/team-sync#list-idp-groups-for-a-team", + "/rest/teams#create-or-update-idp-group-connections": "/rest/teams/team-sync#create-or-update-idp-group-connections", + "/rest/teams#list-child-teams": "/rest/teams/teams#list-child-teams", + "/rest/projects#get-a-project-card": "/rest/projects/cards#get-a-project-card", + "/rest/projects#cards": "/rest/projects/cards", + "/rest/projects#update-a-project-card": "/rest/projects/cards#update-a-project-card", + "/rest/projects#delete-a-project-card": "/rest/projects/cards#delete-a-project-card", + "/rest/projects#move-a-project-card": "/rest/projects/cards#move-a-project-card", + "/rest/projects#get-a-project-column": "/rest/projects/columns#get-a-project-column", + "/rest/projects#columns": "/rest/projects/columns", + "/rest/projects#update-a-project-column": "/rest/projects/columns#update-a-project-column", + "/rest/projects#delete-a-project-column": "/rest/projects/columns#delete-a-project-column", + "/rest/projects#list-project-cards": "/rest/projects/cards#list-project-cards", + "/rest/projects#create-a-project-card": "/rest/projects/cards#create-a-project-card", + "/rest/projects#move-a-project-column": "/rest/projects/columns#move-a-project-column", + "/rest/projects#get-a-project": "/rest/projects/projects#get-a-project", + "/rest/projects#update-a-project": "/rest/projects/projects#update-a-project", + "/rest/projects#delete-a-project": "/rest/projects/projects#delete-a-project", + "/rest/projects#list-project-collaborators": "/rest/projects/collaborators#list-project-collaborators", + "/rest/projects#collaborators": "/rest/projects/collaborators", + "/rest/projects#add-project-collaborator": "/rest/projects/collaborators#add-project-collaborator", + "/rest/projects#remove-project-collaborator": "/rest/projects/collaborators#remove-project-collaborator", + "/rest/projects#get-project-permission-for-a-user": "/rest/projects/collaborators#get-project-permission-for-a-user", + "/rest/projects#list-project-columns": "/rest/projects/columns#list-project-columns", + "/rest/projects#create-a-project-column": "/rest/projects/columns#create-a-project-column", + "/rest/repos#get-a-repository": "/rest/repos/repos#get-a-repository", + "/rest/repos/#update-a-repository": "/rest/repos/repos#update-a-repository", + "/rest/repos#delete-a-repository": "/rest/repos/repos#delete-a-repository", + "/rest/actions#list-artifacts-for-a-repository": "/rest/actions/artifacts#list-artifacts-for-a-repository", + "/rest/actions#artifacts": "/rest/actions/artifacts", + "/rest/actions#get-an-artifact": "/rest/actions/artifacts#get-an-artifact", + "/rest/actions#delete-an-artifact": "/rest/actions/artifacts#delete-an-artifact", + "/rest/actions#download-an-artifact": "/rest/actions/artifacts#download-an-artifact", + "/rest/actions#get-github-actions-cache-usage-for-a-repository": "/rest/actions/cache#get-github-actions-cache-usage-for-a-repository", + "/rest/actions#get-a-job-for-a-workflow-run": "/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run", + "/rest/actions#workflow-jobs": "/rest/actions/workflow-jobs", + "/rest/actions#download-job-logs-for-a-workflow-run": "/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run", + "/rest/actions#re-run-job-for-workflow-run": "/rest/actions/workflow-runs#re-run-job-for-workflow-run", + "/rest/actions#workflow-runs": "/rest/actions/workflow-runs", + "/rest/actions#get-github-actions-permissions-for-a-repository": "/rest/actions/permissions#get-github-actions-permissions-for-a-repository", + "/rest/actions#set-github-actions-permissions-for-a-repository": "/rest/actions/permissions#set-github-actions-permissions-for-a-repository", + "/rest/actions#get-workflow-access-level-to-a-repository": "/rest/actions/permissions#get-workflow-access-level-to-a-repository", + "/rest/actions#set-workflow-access-to-a-repository": "/rest/actions/permissions#set-workflow-access-to-a-repository", + "/rest/actions#get-allowed-actions-for-a-repository": "/rest/actions/permissions#get-allowed-actions-for-a-repository", + "/rest/actions#set-allowed-actions-for-a-repository": "/rest/actions/permissions#set-allowed-actions-for-a-repository", + "/rest/actions#list-self-hosted-runners-for-a-repository": "/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository", + "/rest/actions#list-runner-applications-for-a-repository": "/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository", + "/rest/actions#create-a-registration-token-for-a-repository": "/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository", + "/rest/actions#create-a-remove-token-for-a-repository": "/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository", + "/rest/actions#get-a-self-hosted-runner-for-a-repository": "/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository", + "/rest/actions#delete-a-self-hosted-runner-from-a-repository": "/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository", + "/rest/actions#list-labels-for-a-self-hosted-runner-for-a-repository": "/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository", + "/rest/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository": "/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository", + "/rest/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository": "/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository", + "/rest/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository": "/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", + "/rest/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository": "/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", + "/rest/actions#list-workflow-runs-for-a-repository": "/rest/actions/workflow-runs#list-workflow-runs-for-a-repository", + "/rest/actions#get-a-workflow-run": "/rest/actions/workflow-runs#get-a-workflow-run", + "/rest/actions#delete-a-workflow-run": "/rest/actions/workflow-runs#delete-a-workflow-run", + "/rest/actions#get-the-review-history-for-a-workflow-run": "/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run", + "/rest/actions#approve-a-workflow-run-for-a-fork-pull-request": "/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request", + "/rest/actions#list-workflow-run-artifacts": "/rest/actions/artifacts#list-workflow-run-artifacts", + "/rest/actions#get-a-workflow-run-attempt": "/rest/actions/workflow-runs#get-a-workflow-run-attempt", + "/rest/actions#list-jobs-for-a-workflow-run-attempt": "/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt", + "/rest/actions#download-workflow-run-attempt-logs": "/rest/actions/workflow-runs#download-workflow-run-attempt-logs", + "/rest/actions#cancel-a-workflow-run": "/rest/actions/workflow-runs#cancel-a-workflow-run", + "/rest/actions#list-jobs-for-a-workflow-run": "/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run", + "/rest/actions#download-workflow-run-logs": "/rest/actions/workflow-runs#download-workflow-run-logs", + "/rest/actions#delete-workflow-run-logs": "/rest/actions/workflow-runs#delete-workflow-run-logs", + "/rest/actions#get-pending-deployments-for-a-workflow-run": "/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run", + "/rest/actions#review-pending-deployments-for-a-workflow-run": "/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run", + "/rest/actions#re-run-a-workflow": "/rest/actions/workflow-runs#re-run-a-workflow", + "/rest/actions#re-run-workflow-failed-jobs": "/rest/actions/workflow-runs#re-run-workflow-failed-jobs", + "/rest/actions#get-workflow-run-usage": "/rest/actions/workflow-runs#get-workflow-run-usage", + "/rest/actions#list-repository-secrets": "/rest/actions/secrets#list-repository-secrets", + "/rest/actions#get-a-repository-public-key": "/rest/actions/secrets#get-a-repository-public-key", + "/rest/actions#get-a-repository-secret": "/rest/actions/secrets#get-a-repository-secret", + "/rest/actions#create-or-update-a-repository-secret": "/rest/actions/secrets#create-or-update-a-repository-secret", + "/rest/actions#delete-a-repository-secret": "/rest/actions/secrets#delete-a-repository-secret", + "/rest/actions#list-repository-workflows": "/rest/actions/workflows#list-repository-workflows", + "/rest/actions#workflows": "/rest/actions/workflows", + "/rest/actions#get-a-workflow": "/rest/actions/workflows#get-a-workflow", + "/rest/actions#disable-a-workflow": "/rest/actions/workflows#disable-a-workflow", + "/rest/actions#create-a-workflow-dispatch-event": "/rest/actions/workflows#create-a-workflow-dispatch-event", + "/rest/actions#enable-a-workflow": "/rest/actions/workflows#enable-a-workflow", + "/rest/actions#list-workflow-runs": "/rest/actions/workflow-runs#list-workflow-runs", + "/rest/actions#get-workflow-usage": "/rest/actions/workflows#get-workflow-usage", + "/rest/issues#list-assignees": "/rest/issues/assignees#list-assignees", + "/rest/issues#assignees": "/rest/issues/assignees", + "/rest/issues#check-if-a-user-can-be-assigned": "/rest/issues/assignees#check-if-a-user-can-be-assigned", + "/restundefined": "/rest/repos/autolinks#undefined", + "/rest/repos#autolinks": "/rest/repos/autolinks", + "/rest/repos#enable-automated-security-fixes": "/rest/repos/repos#enable-automated-security-fixes", + "/rest/repos#disable-automated-security-fixes": "/rest/repos/repos#disable-automated-security-fixes", + "/rest/branches#branches": "/rest/branches/branches", + "/rest/branches#branch-protection": "/rest/branches/branch-protection", + "/rest/checks#create-a-check-run": "/rest/checks/runs#create-a-check-run", + "/rest/checks#runs": "/rest/checks/runs", + "/rest/checks#get-a-check-run": "/rest/checks/runs#get-a-check-run", + "/rest/checks#update-a-check-run": "/rest/checks/runs#update-a-check-run", + "/rest/checks#list-check-run-annotations": "/rest/checks/runs#list-check-run-annotations", + "/rest/checks#rerequest-a-check-run": "/rest/checks/runs#rerequest-a-check-run", + "/rest/checks#create-a-check-suite": "/rest/checks/suites#create-a-check-suite", + "/rest/checks#suites": "/rest/checks/suites", + "/rest/checks#update-repository-preferences-for-check-suites": "/rest/checks/suites#update-repository-preferences-for-check-suites", + "/rest/checks#get-a-check-suite": "/rest/checks/suites#get-a-check-suite", + "/rest/checks#list-check-runs-in-a-check-suite": "/rest/checks/runs#list-check-runs-in-a-check-suite", + "/rest/checks#rerequest-a-check-suite": "/rest/checks/suites#rerequest-a-check-suite", + "/rest/repos#list-codeowners-errors": "/rest/repos/repos#list-codeowners-errors", + "/rest/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user": "/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user", + "/rest/codespaces#create-a-codespace-in-a-repository": "/rest/codespaces/codespaces#create-a-codespace-in-a-repository", + "/rest/codespaces#list-available-machine-types-for-a-repository": "/rest/codespaces/machines#list-available-machine-types-for-a-repository", + "/rest/codespaces#machines": "/rest/codespaces/machines", + "/rest/codespaces#list-repository-secrets": "/rest/codespaces/repository-secrets#list-repository-secrets", + "/rest/codespaces#repository-secrets": "/rest/codespaces/repository-secrets", + "/rest/codespaces#get-a-repository-public-key": "/rest/codespaces/repository-secrets#get-a-repository-public-key", + "/rest/codespaces#get-a-repository-secret": "/rest/codespaces/repository-secrets#get-a-repository-secret", + "/rest/codespaces#create-or-update-a-repository-secret": "/rest/codespaces/repository-secrets#create-or-update-a-repository-secret", + "/rest/codespaces#delete-a-repository-secret": "/rest/codespaces/repository-secrets#delete-a-repository-secret", + "/rest/collaborators#collaborators": "/rest/collaborators/collaborators", + "/rest/commits#comments": "/rest/commits/comments", + "/rest/commits#commits": "/rest/commits/commits", + "/rest/checks#list-check-runs-for-a-git-reference": "/rest/checks/runs#list-check-runs-for-a-git-reference", + "/rest/checks#list-check-suites-for-a-git-reference": "/rest/checks/suites#list-check-suites-for-a-git-reference", + "/rest/commits#statuses": "/rest/commits/statuses", + "/rest/metrics#community": "/rest/metrics/community", + "/rest/repos#get-repository-content": "/rest/repos/contents#get-repository-content", + "/rest/repos#contents": "/rest/repos/contents", + "/rest/repos#create-or-update-file-contents": "/rest/repos/contents#create-or-update-file-contents", + "/rest/repos#delete-a-file": "/rest/repos/contents#delete-a-file", + "/rest/repos#list-repository-contributors": "/rest/repos/repos#list-repository-contributors", + "/rest/dependabot#list-repository-secrets": "/rest/dependabot/secrets#list-repository-secrets", + "/rest/dependabot#get-a-repository-public-key": "/rest/dependabot/secrets#get-a-repository-public-key", + "/rest/dependabot#get-a-repository-secret": "/rest/dependabot/secrets#get-a-repository-secret", + "/rest/dependabot#create-or-update-a-repository-secret": "/rest/dependabot/secrets#create-or-update-a-repository-secret", + "/rest/dependabot#delete-a-repository-secret": "/rest/dependabot/secrets#delete-a-repository-secret", + "/rest/dependency-graph#get-a-diff-of-the-dependencies-between-commits": "/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits", + "/rest/dependency-graph#dependency-review": "/rest/dependency-graph/dependency-review", + "/rest/deployments#deployments": "/rest/deployments/deployments", + "/rest/deployments#statuses": "/rest/deployments/statuses", + "/rest/repos#create-a-repository-dispatch-event": "/rest/repos/repos#create-a-repository-dispatch-event", + "/rest/deployments#environments": "/rest/deployments/environments", + "/rest/activity#list-repository-events": "/rest/activity/events#list-repository-events", + "/rest/repos#list-forks": "/rest/repos/forks#list-forks", + "/rest/repos#forks": "/rest/repos/forks", + "/rest/repos#create-a-fork": "/rest/repos/forks#create-a-fork", + "/rest/git#create-a-blob": "/rest/git/blobs#create-a-blob", + "/rest/git#blobs": "/rest/git/blobs", + "/rest/git#get-a-blob": "/rest/git/blobs#get-a-blob", + "/rest/git#create-a-commit": "/rest/git/commits#create-a-commit", + "/rest/git#commits": "/rest/git/commits", + "/rest/git#get-a-commit": "/rest/git/commits#get-a-commit", + "/rest/git#list-matching-references": "/rest/git/refs#list-matching-references", + "/rest/git#refs": "/rest/git/refs", + "/rest/git#get-a-reference": "/rest/git/refs#get-a-reference", + "/rest/git#create-a-reference": "/rest/git/refs#create-a-reference", + "/rest/git#update-a-reference": "/rest/git/refs#update-a-reference", + "/rest/git#delete-a-reference": "/rest/git/refs#delete-a-reference", + "/rest/git#create-a-tag-object": "/rest/git/tags#create-a-tag-object", + "/rest/git#tags": "/rest/git/tags", + "/rest/git#get-a-tag": "/rest/git/tags#get-a-tag", + "/rest/git#create-a-tree": "/rest/git/trees#create-a-tree", + "/rest/git#trees": "/rest/git/trees", + "/rest/git#get-a-tree": "/rest/git/trees#get-a-tree", + "/rest/webhooks#repos": "/rest/webhooks/repos", + "/rest/webhooks#repo-config": "/rest/webhooks/repo-config", + "/rest/webhooks#repo-deliveries": "/rest/webhooks/repo-deliveries", + "/rest/migrations#get-an-import-status": "/rest/migrations/source-imports#get-an-import-status", + "/rest/migrations#source-imports": "/rest/migrations/source-imports", + "/rest/migrations#start-an-import": "/rest/migrations/source-imports#start-an-import", + "/rest/migrations#update-an-import": "/rest/migrations/source-imports#update-an-import", + "/rest/migrations#cancel-an-import": "/rest/migrations/source-imports#cancel-an-import", + "/rest/migrations#get-commit-authors": "/rest/migrations/source-imports#get-commit-authors", + "/rest/migrations#map-a-commit-author": "/rest/migrations/source-imports#map-a-commit-author", + "/rest/migrations#get-large-files": "/rest/migrations/source-imports#get-large-files", + "/rest/migrations#update-git-lfs-preference": "/rest/migrations/source-imports#update-git-lfs-preference", + "/rest/apps#get-a-repository-installation-for-the-authenticated-app": "/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app", + "/rest/interactions#get-interaction-restrictions-for-a-repository": "/rest/interactions/repos#get-interaction-restrictions-for-a-repository", + "/rest/interactions#repos": "/rest/interactions/repos", + "/rest/interactions#set-interaction-restrictions-for-a-repository": "/rest/interactions/repos#set-interaction-restrictions-for-a-repository", + "/rest/interactions#remove-interaction-restrictions-for-a-repository": "/rest/interactions/repos#remove-interaction-restrictions-for-a-repository", + "/rest/collaborators#invitations": "/rest/collaborators/invitations", + "/rest/issues#list-repository-issues": "/rest/issues/issues#list-repository-issues", + "/rest/issues#create-an-issue": "/rest/issues/issues#create-an-issue", + "/rest/issues#list-issue-comments-for-a-repository": "/rest/issues/comments#list-issue-comments-for-a-repository", + "/rest/issues#comments": "/rest/issues/comments", + "/rest/issues#get-an-issue-comment": "/rest/issues/comments#get-an-issue-comment", + "/rest/issues#update-an-issue-comment": "/rest/issues/comments#update-an-issue-comment", + "/rest/issues#delete-an-issue-comment": "/rest/issues/comments#delete-an-issue-comment", + "/rest/issues#list-issue-events-for-a-repository": "/rest/issues/events#list-issue-events-for-a-repository", + "/rest/issues#events": "/rest/issues/events", + "/rest/issues#get-an-issue-event": "/rest/issues/events#get-an-issue-event", + "/rest/issues#get-an-issue": "/rest/issues/issues#get-an-issue", + "/rest/issues/#update-an-issue": "/rest/issues/issues#update-an-issue", + "/rest/issues#add-assignees-to-an-issue": "/rest/issues/assignees#add-assignees-to-an-issue", + "/rest/issues#remove-assignees-from-an-issue": "/rest/issues/assignees#remove-assignees-from-an-issue", + "/rest/issues#list-issue-comments": "/rest/issues/comments#list-issue-comments", + "/rest/issues#create-an-issue-comment": "/rest/issues/comments#create-an-issue-comment", + "/rest/issues#list-issue-events": "/rest/issues/events#list-issue-events", + "/rest/issues#list-labels-for-an-issue": "/rest/issues/labels#list-labels-for-an-issue", + "/rest/issues#labels": "/rest/issues/labels", + "/rest/issues#add-labels-to-an-issue": "/rest/issues/labels#add-labels-to-an-issue", + "/rest/issues#set-labels-for-an-issue": "/rest/issues/labels#set-labels-for-an-issue", + "/rest/issues#remove-all-labels-from-an-issue": "/rest/issues/labels#remove-all-labels-from-an-issue", + "/rest/issues#remove-a-label-from-an-issue": "/rest/issues/labels#remove-a-label-from-an-issue", + "/rest/issues#lock-an-issue": "/rest/issues/issues#lock-an-issue", + "/rest/issues#unlock-an-issue": "/rest/issues/issues#unlock-an-issue", + "/rest/issues#list-timeline-events-for-an-issue": "/rest/issues/timeline#list-timeline-events-for-an-issue", + "/rest/issues#timeline": "/rest/issues/timeline", + "/rest/issues#list-labels-for-a-repository": "/rest/issues/labels#list-labels-for-a-repository", + "/rest/issues#create-a-label": "/rest/issues/labels#create-a-label", + "/rest/issues#get-a-label": "/rest/issues/labels#get-a-label", + "/rest/issues#update-a-label": "/rest/issues/labels#update-a-label", + "/rest/issues#delete-a-label": "/rest/issues/labels#delete-a-label", + "/rest/repos#list-repository-languages": "/rest/repos/repos#list-repository-languages", + "/rest/repos#enable-git-lfs-for-a-repository": "/rest/repos/lfs#enable-git-lfs-for-a-repository", + "/rest/repos#lfs": "/rest/repos/lfs", + "/rest/repos#disable-git-lfs-for-a-repository": "/rest/repos/lfs#disable-git-lfs-for-a-repository", + "/rest/issues#list-milestones": "/rest/issues/milestones#list-milestones", + "/rest/issues#milestones": "/rest/issues/milestones", + "/rest/issues#create-a-milestone": "/rest/issues/milestones#create-a-milestone", + "/rest/issues#get-a-milestone": "/rest/issues/milestones#get-a-milestone", + "/rest/issues#update-a-milestone": "/rest/issues/milestones#update-a-milestone", + "/rest/issues#delete-a-milestone": "/rest/issues/milestones#delete-a-milestone", + "/rest/issues#list-labels-for-issues-in-a-milestone": "/rest/issues/labels#list-labels-for-issues-in-a-milestone", + "/rest/activity#list-repository-notifications-for-the-authenticated-user": "/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user", + "/rest/activity#mark-repository-notifications-as-read": "/rest/activity/notifications#mark-repository-notifications-as-read", + "/rest/projects#list-repository-projects": "/rest/projects/projects#list-repository-projects", + "/rest/projects#create-a-repository-project": "/rest/projects/projects#create-a-repository-project", + "/rest/pulls#list-pull-requests": "/rest/pulls/pulls#list-pull-requests", + "/rest/pulls#create-a-pull-request": "/rest/pulls/pulls#create-a-pull-request", + "/rest/pulls#list-review-comments-in-a-repository": "/rest/pulls/comments#list-review-comments-in-a-repository", + "/rest/pulls#comments": "/rest/pulls/comments", + "/rest/pulls#get-a-review-comment-for-a-pull-request": "/rest/pulls/comments#get-a-review-comment-for-a-pull-request", + "/rest/pulls#update-a-review-comment-for-a-pull-request": "/rest/pulls/comments#update-a-review-comment-for-a-pull-request", + "/rest/pulls#delete-a-review-comment-for-a-pull-request": "/rest/pulls/comments#delete-a-review-comment-for-a-pull-request", + "/rest/pulls#get-a-pull-request": "/rest/pulls/pulls#get-a-pull-request", + "/rest/pulls/#update-a-pull-request": "/rest/pulls/pulls#update-a-pull-request", + "/rest/codespaces#create-a-codespace-from-a-pull-request": "/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request", + "/rest/pulls#list-review-comments-on-a-pull-request": "/rest/pulls/comments#list-review-comments-on-a-pull-request", + "/rest/pulls#create-a-review-comment-for-a-pull-request": "/rest/pulls/comments#create-a-review-comment-for-a-pull-request", + "/rest/pulls#create-a-reply-for-a-review-comment": "/rest/pulls/comments#create-a-reply-for-a-review-comment", + "/rest/pulls#list-commits-on-a-pull-request": "/rest/pulls/pulls#list-commits-on-a-pull-request", + "/rest/pulls#list-pull-requests-files": "/rest/pulls/pulls#list-pull-requests-files", + "/rest/pulls#check-if-a-pull-request-has-been-merged": "/rest/pulls/pulls#check-if-a-pull-request-has-been-merged", + "/rest/pulls#merge-a-pull-request": "/rest/pulls/pulls#merge-a-pull-request", + "/rest/pulls#list-requested-reviewers-for-a-pull-request": "/rest/pulls/review-requests#list-requested-reviewers-for-a-pull-request", + "/rest/pulls#review-requests": "/rest/pulls/review-requests", + "/rest/pulls#request-reviewers-for-a-pull-request": "/rest/pulls/review-requests#request-reviewers-for-a-pull-request", + "/rest/pulls#remove-requested-reviewers-from-a-pull-request": "/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request", + "/rest/pulls#list-reviews-for-a-pull-request": "/rest/pulls/reviews#list-reviews-for-a-pull-request", + "/rest/pulls#reviews": "/rest/pulls/reviews", + "/rest/pulls#create-a-review-for-a-pull-request": "/rest/pulls/reviews#create-a-review-for-a-pull-request", + "/rest/pulls#get-a-review-for-a-pull-request": "/rest/pulls/reviews#get-a-review-for-a-pull-request", + "/rest/pulls#update-a-review-for-a-pull-request": "/rest/pulls/reviews#update-a-review-for-a-pull-request", + "/rest/pulls#delete-a-pending-review-for-a-pull-request": "/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request", + "/rest/pulls#list-comments-for-a-pull-request-review": "/rest/pulls/reviews#list-comments-for-a-pull-request-review", + "/rest/pulls#dismiss-a-review-for-a-pull-request": "/rest/pulls/reviews#dismiss-a-review-for-a-pull-request", + "/rest/pulls#submit-a-review-for-a-pull-request": "/rest/pulls/reviews#submit-a-review-for-a-pull-request", + "/rest/pulls#update-a-pull-request-branch": "/rest/pulls/pulls#update-a-pull-request-branch", + "/rest/repos#get-a-repository-readme": "/rest/repos/contents#get-a-repository-readme", + "/rest/repos#get-a-repository-directory-readme": "/rest/repos/contents#get-a-repository-directory-readme", + "/rest/releases#releases": "/rest/releases/releases", + "/rest/releases#assets": "/rest/releases/assets", + "/rest/activity#list-stargazers": "/rest/activity/starring#list-stargazers", + "/rest/activity#starring": "/rest/activity/starring", + "/rest/metrics#statistics": "/rest/metrics/statistics", + "/rest/activity#list-watchers": "/rest/activity/watching#list-watchers", + "/rest/activity#watching": "/rest/activity/watching", + "/rest/activity#get-a-repository-subscription": "/rest/activity/watching#get-a-repository-subscription", + "/rest/activity#set-a-repository-subscription": "/rest/activity/watching#set-a-repository-subscription", + "/rest/activity#delete-a-repository-subscription": "/rest/activity/watching#delete-a-repository-subscription", + "/rest/repos#list-repository-tags": "/rest/repos/repos#list-repository-tags", + "/rest/repos#list-tag-protection-state-of-a-repository": "/rest/repos/tags#list-tag-protection-state-of-a-repository", + "/rest/repos#tags": "/rest/repos/tags", + "/rest/repos#create-tag-protection-state-for-a-repository": "/rest/repos/tags#create-tag-protection-state-for-a-repository", + "/rest/repos#delete-tag-protection-state-for-a-repository": "/rest/repos/tags#delete-tag-protection-state-for-a-repository", + "/rest/repos#download-a-repository-archive": "/rest/repos/contents#download-a-repository-archive", + "/rest/repos#list-repository-teams": "/rest/repos/repos#list-repository-teams", + "/rest/repos#get-all-repository-topics": "/rest/repos/repos#get-all-repository-topics", + "/rest/repos#replace-all-repository-topics": "/rest/repos/repos#replace-all-repository-topics", + "/rest/metrics#traffic": "/rest/metrics/traffic", + "/rest/repos#transfer-a-repository": "/rest/repos/repos#transfer-a-repository", + "/rest/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository": "/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository", + "/rest/repos#enable-vulnerability-alerts": "/rest/repos/repos#enable-vulnerability-alerts", + "/rest/repos#disable-vulnerability-alerts": "/rest/repos/repos#disable-vulnerability-alerts", + "/rest/repos#create-a-repository-using-a-template": "/rest/repos/repos#create-a-repository-using-a-template", + "/rest/repos#list-public-repositories": "/rest/repos/repos#list-public-repositories", + "/rest/actions#list-environment-secrets": "/rest/actions/secrets#list-environment-secrets", + "/rest/actions#get-an-environment-public-key": "/rest/actions/secrets#get-an-environment-public-key", + "/rest/actions#get-an-environment-secret": "/rest/actions/secrets#get-an-environment-secret", + "/rest/actions#create-or-update-an-environment-secret": "/rest/actions/secrets#create-or-update-an-environment-secret", + "/rest/actions#delete-an-environment-secret": "/rest/actions/secrets#delete-an-environment-secret", + "/rest/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise": "/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise", + "/rest/enterprise-admin#scim": "/rest/enterprise-admin/scim", + "/rest/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users": "/rest/enterprise-admin/scim#provision-a-scim-enterprise-group-and-invite-users", + "/rest/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group": "/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group", + "/rest/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group": "/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group", + "/rest/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group": "/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group", + "/rest/enterprise-admin#delete-a-scim-group-from-an-enterprise": "/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise", + "/rest/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise": "/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise", + "/rest/enterprise-admin#provision-and-invite-a-scim-enterprise-user": "/rest/enterprise-admin/scim#provision-and-invite-a-scim-enterprise-user", + "/rest/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-user": "/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user", + "/rest/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-user": "/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user", + "/rest/enterprise-admin#update-an-attribute-for-a-scim-enterprise-user": "/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user", + "/rest/enterprise-admin#delete-a-scim-user-from-an-enterprise": "/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise", + "/rest/teams/#get-a-team-legacy": "/rest/teams/teams#get-a-team-legacy", + "/rest/teams/#update-a-team-legacy": "/rest/teams/teams#update-a-team-legacy", + "/rest/teams/#delete-a-team-legacy": "/rest/teams/teams#delete-a-team-legacy", + "/rest/teams#list-discussions-legacy": "/rest/teams/discussions#list-discussions-legacy", + "/rest/teams#create-a-discussion-legacy": "/rest/teams/discussions#create-a-discussion-legacy", + "/rest/teams#get-a-discussion-legacy": "/rest/teams/discussions#get-a-discussion-legacy", + "/rest/teams#update-a-discussion-legacy": "/rest/teams/discussions#update-a-discussion-legacy", + "/rest/teams#delete-a-discussion-legacy": "/rest/teams/discussions#delete-a-discussion-legacy", + "/rest/teams#list-discussion-comments-legacy": "/rest/teams/discussion-comments#list-discussion-comments-legacy", + "/rest/teams#create-a-discussion-comment-legacy": "/rest/teams/discussion-comments#create-a-discussion-comment-legacy", + "/rest/teams#get-a-discussion-comment-legacy": "/rest/teams/discussion-comments#get-a-discussion-comment-legacy", + "/rest/teams#update-a-discussion-comment-legacy": "/rest/teams/discussion-comments#update-a-discussion-comment-legacy", + "/rest/teams#delete-a-discussion-comment-legacy": "/rest/teams/discussion-comments#delete-a-discussion-comment-legacy", + "/rest/teams#list-pending-team-invitations-legacy": "/rest/teams/members#list-pending-team-invitations-legacy", + "/rest/teams#list-team-members-legacy": "/rest/teams/members#list-team-members-legacy", + "/rest/teams#get-team-member-legacy": "/rest/teams/members#get-team-member-legacy", + "/rest/teams#add-team-member-legacy": "/rest/teams/members#add-team-member-legacy", + "/rest/teams#remove-team-member-legacy": "/rest/teams/members#remove-team-member-legacy", + "/rest/teams#get-team-membership-for-a-user-legacy": "/rest/teams/members#get-team-membership-for-a-user-legacy", + "/rest/teams#add-or-update-team-membership-for-a-user-legacy": "/rest/teams/members#add-or-update-team-membership-for-a-user-legacy", + "/rest/teams#remove-team-membership-for-a-user-legacy": "/rest/teams/members#remove-team-membership-for-a-user-legacy", + "/rest/teams/#list-team-projects-legacy": "/rest/teams/teams#list-team-projects-legacy", + "/rest/teams/#check-team-permissions-for-a-project-legacy": "/rest/teams/teams#check-team-permissions-for-a-project-legacy", + "/rest/teams/#add-or-update-team-project-permissions-legacy": "/rest/teams/teams#add-or-update-team-project-permissions-legacy", + "/rest/teams/#remove-a-project-from-a-team-legacy": "/rest/teams/teams#remove-a-project-from-a-team-legacy", + "/rest/teams/#list-team-repositories-legacy": "/rest/teams/teams#list-team-repositories-legacy", + "/rest/teams/#check-team-permissions-for-a-repository-legacy": "/rest/teams/teams#check-team-permissions-for-a-repository-legacy", + "/rest/teams/#add-or-update-team-repository-permissions-legacy": "/rest/teams/teams#add-or-update-team-repository-permissions-legacy", + "/rest/teams/#remove-a-repository-from-a-team-legacy": "/rest/teams/teams#remove-a-repository-from-a-team-legacy", + "/rest/teams#list-idp-groups-for-a-team-legacy": "/rest/teams/team-sync#list-idp-groups-for-a-team-legacy", + "/rest/teams#create-or-update-idp-group-connections-legacy": "/rest/teams/team-sync#create-or-update-idp-group-connections-legacy", + "/rest/teams/#list-child-teams-legacy": "/rest/teams/teams#list-child-teams-legacy", + "/rest/users#get-the-authenticated-user": "/rest/users/users#get-the-authenticated-user", + "/rest/users/#update-the-authenticated-user": "/rest/users/users#update-the-authenticated-user", + "/rest/users#list-users-blocked-by-the-authenticated-user": "/rest/users/blocking#list-users-blocked-by-the-authenticated-user", + "/rest/users#blocking": "/rest/users/blocking", + "/rest/users#check-if-a-user-is-blocked-by-the-authenticated-user": "/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user", + "/rest/users#block-a-user": "/rest/users/blocking#block-a-user", + "/rest/users#unblock-a-user": "/rest/users/blocking#unblock-a-user", + "/rest/codespaces#list-codespaces-for-the-authenticated-user": "/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user", + "/rest/codespaces#create-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user", + "/rest/codespaces#list-secrets-for-the-authenticated-user": "/rest/codespaces/secrets#list-secrets-for-the-authenticated-user", + "/rest/codespaces#secrets": "/rest/codespaces/secrets", + "/rest/codespaces#get-public-key-for-the-authenticated-user": "/rest/codespaces/secrets#get-public-key-for-the-authenticated-user", + "/rest/codespaces#get-a-secret-for-the-authenticated-user": "/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user", + "/rest/codespaces#create-or-update-a-secret-for-the-authenticated-user": "/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user", + "/rest/codespaces#delete-a-secret-for-the-authenticated-user": "/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user", + "/rest/codespaces#list-selected-repositories-for-a-user-secret": "/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret", + "/rest/codespaces#set-selected-repositories-for-a-user-secret": "/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret", + "/rest/codespaces#add-a-selected-repository-to-a-user-secret": "/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret", + "/rest/codespaces#remove-a-selected-repository-from-a-user-secret": "/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret", + "/rest/codespaces#get-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user", + "/rest/codespaces#update-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user", + "/rest/codespaces#delete-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user", + "/rest/codespaces#list-machine-types-for-a-codespace": "/rest/codespaces/machines#list-machine-types-for-a-codespace", + "/rest/codespaces#start-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user", + "/rest/codespaces#stop-a-codespace-for-the-authenticated-user": "/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user", + "/rest/users#set-primary-email-visibility-for-the-authenticated-user": "/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user", + "/rest/users#emails": "/rest/users/emails", + "/rest/users#list-email-addresses-for-the-authenticated-user": "/rest/users/emails#list-email-addresses-for-the-authenticated-user", + "/rest/users#add-an-email-address-for-the-authenticated-user": "/rest/users/emails#add-an-email-address-for-the-authenticated-user", + "/rest/users#delete-an-email-address-for-the-authenticated-user": "/rest/users/emails#delete-an-email-address-for-the-authenticated-user", + "/rest/users#list-followers-of-the-authenticated-user": "/rest/users/followers#list-followers-of-the-authenticated-user", + "/rest/users#followers": "/rest/users/followers", + "/rest/users#list-the-people-the-authenticated-user-follows": "/rest/users/followers#list-the-people-the-authenticated-user-follows", + "/rest/users#check-if-a-person-is-followed-by-the-authenticated-user": "/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user", + "/rest/users#follow-a-user": "/rest/users/followers#follow-a-user", + "/rest/users#unfollow-a-user": "/rest/users/followers#unfollow-a-user", + "/rest/users#list-gpg-keys-for-the-authenticated-user": "/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user", + "/rest/users#gpg-keys": "/rest/users/gpg-keys", + "/rest/users#create-a-gpg-key-for-the-authenticated-user": "/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user", + "/rest/users#get-a-gpg-key-for-the-authenticated-user": "/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user", + "/rest/users#delete-a-gpg-key-for-the-authenticated-user": "/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user", + "/rest/apps#list-app-installations-accessible-to-the-user-access-token": "/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token", + "/rest/apps#list-repositories-accessible-to-the-user-access-token": "/rest/apps/installations#list-repositories-accessible-to-the-user-access-token", + "/rest/apps#add-a-repository-to-an-app-installation": "/rest/apps/installations#add-a-repository-to-an-app-installation", + "/rest/apps#remove-a-repository-from-an-app-installation": "/rest/apps/installations#remove-a-repository-from-an-app-installation", + "/rest/interactions#get-interaction-restrictions-for-your-public-repositories": "/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories", + "/rest/interactions#user": "/rest/interactions/user", + "/rest/interactions#set-interaction-restrictions-for-your-public-repositories": "/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories", + "/rest/interactions#remove-interaction-restrictions-from-your-public-repositories": "/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories", + "/rest/issues#list-user-account-issues-assigned-to-the-authenticated-user": "/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user", + "/rest/users#list-public-ssh-keys-for-the-authenticated-user": "/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user", + "/rest/users#keys": "/rest/users/keys", + "/rest/users#create-a-public-ssh-key-for-the-authenticated-user": "/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user", + "/rest/users#get-a-public-ssh-key-for-the-authenticated-user": "/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user", + "/rest/users#delete-a-public-ssh-key-for-the-authenticated-user": "/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user", + "/rest/apps#list-subscriptions-for-the-authenticated-user": "/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user", + "/rest/apps#list-subscriptions-for-the-authenticated-user-stubbed": "/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed", + "/rest/orgs#list-organization-memberships-for-the-authenticated-user": "/rest/orgs/members#list-organization-memberships-for-the-authenticated-user", + "/rest/orgs#get-an-organization-membership-for-the-authenticated-user": "/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user", + "/rest/orgs#update-an-organization-membership-for-the-authenticated-user": "/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user", + "/rest/migrations#list-user-migrations": "/rest/migrations/users#list-user-migrations", + "/rest/migrations#users": "/rest/migrations/users", + "/rest/migrations#start-a-user-migration": "/rest/migrations/users#start-a-user-migration", + "/rest/migrations#get-a-user-migration-status": "/rest/migrations/users#get-a-user-migration-status", + "/rest/migrations#download-a-user-migration-archive": "/rest/migrations/users#download-a-user-migration-archive", + "/rest/migrations#delete-a-user-migration-archive": "/rest/migrations/users#delete-a-user-migration-archive", + "/rest/migrations#unlock-a-user-repository": "/rest/migrations/users#unlock-a-user-repository", + "/rest/migrations#list-repositories-for-a-user-migration": "/rest/migrations/users#list-repositories-for-a-user-migration", + "/rest/orgs#list-organizations-for-the-authenticated-user": "/rest/orgs/orgs#list-organizations-for-the-authenticated-user", + "/rest/projects#create-a-user-project": "/rest/projects/projects#create-a-user-project", + "/rest/users#list-public-email-addresses-for-the-authenticated-user": "/rest/users/emails#list-public-email-addresses-for-the-authenticated-user", + "/rest/repos#list-repositories-for-the-authenticated-user": "/rest/repos/repos#list-repositories-for-the-authenticated-user", + "/rest/repos#create-a-repository-for-the-authenticated-user": "/rest/repos/repos#create-a-repository-for-the-authenticated-user", + "/rest/activity#list-repositories-starred-by-the-authenticated-user": "/rest/activity/starring#list-repositories-starred-by-the-authenticated-user", + "/rest/activity#check-if-a-repository-is-starred-by-the-authenticated-user": "/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user", + "/rest/activity#star-a-repository-for-the-authenticated-user": "/rest/activity/starring#star-a-repository-for-the-authenticated-user", + "/rest/activity#unstar-a-repository-for-the-authenticated-user": "/rest/activity/starring#unstar-a-repository-for-the-authenticated-user", + "/rest/activity#list-repositories-watched-by-the-authenticated-user": "/rest/activity/watching#list-repositories-watched-by-the-authenticated-user", + "/rest/teams#list-teams-for-the-authenticated-user": "/rest/teams/teams#list-teams-for-the-authenticated-user", + "/rest/users#list-users": "/rest/users/users#list-users", + "/rest/users#get-a-user": "/rest/users/users#get-a-user", + "/rest/activity#list-events-for-the-authenticated-user": "/rest/activity/events#list-events-for-the-authenticated-user", + "/rest/activity#list-organization-events-for-the-authenticated-user": "/rest/activity/events#list-organization-events-for-the-authenticated-user", + "/rest/activity#list-public-events-for-a-user": "/rest/activity/events#list-public-events-for-a-user", + "/rest/users#list-followers-of-a-user": "/rest/users/followers#list-followers-of-a-user", + "/rest/users#list-the-people-a-user-follows": "/rest/users/followers#list-the-people-a-user-follows", + "/rest/users#check-if-a-user-follows-another-user": "/rest/users/followers#check-if-a-user-follows-another-user", + "/rest/gists#list-gists-for-a-user": "/rest/gists/gists#list-gists-for-a-user", + "/rest/users#list-gpg-keys-for-a-user": "/rest/users/gpg-keys#list-gpg-keys-for-a-user", + "/rest/users#get-contextual-information-for-a-user": "/rest/users/users#get-contextual-information-for-a-user", + "/rest/apps#get-a-user-installation-for-the-authenticated-app": "/rest/apps/apps#get-a-user-installation-for-the-authenticated-app", + "/rest/users#list-public-keys-for-a-user": "/rest/users/keys#list-public-keys-for-a-user", + "/rest/orgs#list-organizations-for-a-user": "/rest/orgs/orgs#list-organizations-for-a-user", + "/rest/projects#list-user-projects": "/rest/projects/projects#list-user-projects", + "/rest/activity#list-events-received-by-the-authenticated-user": "/rest/activity/events#list-events-received-by-the-authenticated-user", + "/rest/activity#list-public-events-received-by-a-user": "/rest/activity/events#list-public-events-received-by-a-user", + "/rest/repos#list-repositories-for-a-user": "/rest/repos/repos#list-repositories-for-a-user", + "/rest/activity#list-repositories-starred-by-a-user": "/rest/activity/starring#list-repositories-starred-by-a-user", + "/rest/activity#list-repositories-watched-by-a-user": "/rest/activity/watching#list-repositories-watched-by-a-user", + "/rest/enterprise-admin#list-global-webhooks": "/rest/enterprise-admin/global-webhooks#list-global-webhooks", + "/rest/enterprise-admin#global-webhooks": "/rest/enterprise-admin/global-webhooks", + "/rest/enterprise-admin#create-a-global-webhook": "/rest/enterprise-admin/global-webhooks#create-a-global-webhook", + "/rest/enterprise-admin#get-a-global-webhook": "/rest/enterprise-admin/global-webhooks#get-a-global-webhook", + "/rest/enterprise-admin#update-a-global-webhook": "/rest/enterprise-admin/global-webhooks#update-a-global-webhook", + "/rest/enterprise-admin#delete-a-global-webhook": "/rest/enterprise-admin/global-webhooks#delete-a-global-webhook", + "/rest/enterprise-admin#ping-a-global-webhook": "/rest/enterprise-admin/global-webhooks#ping-a-global-webhook", + "/rest/enterprise-admin#list-public-keys": "/rest/enterprise-admin/users#list-public-keys", + "/rest/enterprise-admin#users": "/rest/enterprise-admin/users", + "/rest/enterprise-admin#delete-a-public-key": "/rest/enterprise-admin/users#delete-a-public-key", + "/rest/enterprise-admin#update-ldap-mapping-for-a-team": "/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team", + "/rest/enterprise-admin#ldap": "/rest/enterprise-admin/ldap", + "/rest/enterprise-admin#sync-ldap-mapping-for-a-team": "/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team", + "/rest/enterprise-admin#update-ldap-mapping-for-a-user": "/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user", + "/rest/enterprise-admin#sync-ldap-mapping-for-a-user": "/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user", + "/rest/enterprise-admin#create-an-organization": "/rest/enterprise-admin/orgs#create-an-organization", + "/rest/enterprise-admin#orgs": "/rest/enterprise-admin/orgs", + "/rest/enterprise-admin#update-an-organization-name": "/rest/enterprise-admin/orgs#update-an-organization-name", + "/rest/enterprise-admin#list-pre-receive-environments": "/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments", + "/rest/enterprise-admin#pre-receive-environments": "/rest/enterprise-admin/pre-receive-environments", + "/rest/enterprise-admin#create-a-pre-receive-environment": "/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment", + "/rest/enterprise-admin#get-a-pre-receive-environment": "/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment", + "/rest/enterprise-admin#update-a-pre-receive-environment": "/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment", + "/rest/enterprise-admin#delete-a-pre-receive-environment": "/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment", + "/rest/enterprise-admin#start-a-pre-receive-environment-download": "/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download", + "/rest/enterprise-admin#get-the-download-status-for-a-pre-receive-environment": "/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment", + "/rest/enterprise-admin#list-pre-receive-hooks": "/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks", + "/rest/enterprise-admin#pre-receive-hooks": "/rest/enterprise-admin/pre-receive-hooks", + "/rest/enterprise-admin#create-a-pre-receive-hook": "/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook", + "/rest/enterprise-admin#get-a-pre-receive-hook": "/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook", + "/rest/enterprise-admin#update-a-pre-receive-hook": "/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook", + "/rest/enterprise-admin#delete-a-pre-receive-hook": "/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook", + "/rest/enterprise-admin#list-personal-access-tokens": "/rest/enterprise-admin/users#list-personal-access-tokens", + "/rest/enterprise-admin#delete-a-personal-access-token": "/rest/enterprise-admin/users#delete-a-personal-access-token", + "/rest/enterprise-admin#create-a-user": "/rest/enterprise-admin/users#create-a-user", + "/rest/enterprise-admin#update-the-username-for-a-user": "/rest/enterprise-admin/users#update-the-username-for-a-user", + "/rest/enterprise-admin#delete-a-user": "/rest/enterprise-admin/users#delete-a-user", + "/rest/enterprise-admin#create-an-impersonation-oauth-token": "/rest/enterprise-admin/users#create-an-impersonation-oauth-token", + "/rest/enterprise-admin#delete-an-impersonation-oauth-token": "/rest/enterprise-admin/users#delete-an-impersonation-oauth-token", + "/rest/apps#revoke-a-grant-for-an-application": "/rest/apps/oauth-applications#revoke-a-grant-for-an-application", + "/rest/apps#check-an-authorization": "/rest/apps/oauth-applications#check-an-authorization", + "/rest/apps#reset-an-authorization": "/rest/apps/oauth-applications#reset-an-authorization", + "/rest/apps#revoke-an-authorization-for-an-application": "/rest/apps/oauth-applications#revoke-an-authorization-for-an-application", + "/rest/enterprise-admin#get-license-information": "/rest/enterprise-admin/license#get-license-information", + "/rest/enterprise-admin#license": "/rest/enterprise-admin/license", + "/rest/enterprise-admin#get-statistics": "/rest/enterprise-admin/admin-stats#get-statistics", + "/rest/enterprise-admin#admin-stats": "/rest/enterprise-admin/admin-stats", + "/rest/enterprise-admin#get-comment-statistics": "/rest/enterprise-admin/admin-stats#get-comment-statistics", + "/rest/enterprise-admin#get-gist-statistics": "/rest/enterprise-admin/admin-stats#get-gist-statistics", + "/rest/enterprise-admin#get-hooks-statistics": "/rest/enterprise-admin/admin-stats#get-hooks-statistics", + "/rest/enterprise-admin#get-issues-statistics": "/rest/enterprise-admin/admin-stats#get-issues-statistics", + "/rest/enterprise-admin#get-milestone-statistics": "/rest/enterprise-admin/admin-stats#get-milestone-statistics", + "/rest/enterprise-admin#get-organization-statistics": "/rest/enterprise-admin/admin-stats#get-organization-statistics", + "/rest/enterprise-admin#get-pages-statistics": "/rest/enterprise-admin/admin-stats#get-pages-statistics", + "/rest/enterprise-admin#get-pull-requests-statistics": "/rest/enterprise-admin/admin-stats#get-pull-requests-statistics", + "/rest/enterprise-admin#get-repository-statistics": "/rest/enterprise-admin/admin-stats#get-repository-statistics", + "/rest/enterprise-admin#get-users-statistics": "/rest/enterprise-admin/admin-stats#get-users-statistics", + "/rest/enterprise-admin#list-pre-receive-hooks-for-an-organization": "/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization", + "/rest/enterprise-admin#org-pre-receive-hooks": "/rest/enterprise-admin/org-pre-receive-hooks", + "/rest/enterprise-admin#get-a-pre-receive-hook-for-an-organization": "/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization", + "/rest/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization": "/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization", + "/rest/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization": "/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization", + "/rest/apps#create-a-content-attachment": "/rest/apps/installations#create-a-content-attachment", + "/rest/enterprise-admin#list-pre-receive-hooks-for-a-repository": "/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository", + "/rest/enterprise-admin#repo-pre-receive-hooks": "/rest/enterprise-admin/repo-pre-receive-hooks", + "/rest/enterprise-admin#get-a-pre-receive-hook-for-a-repository": "/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository", + "/rest/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository": "/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository", + "/rest/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository": "/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository", + "/rest/enterprise-admin#get-the-configuration-status": "/rest/enterprise-admin/management-console#get-the-configuration-status", + "/rest/enterprise-admin#management-console": "/rest/enterprise-admin/management-console", + "/rest/enterprise-admin#start-a-configuration-process": "/rest/enterprise-admin/management-console#start-a-configuration-process", + "/rest/enterprise-admin#get-the-maintenance-status": "/rest/enterprise-admin/management-console#get-the-maintenance-status", + "/rest/enterprise-admin#enable-or-disable-maintenance-mode": "/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode", + "/rest/enterprise-admin#get-settings": "/rest/enterprise-admin/management-console#get-settings", + "/rest/enterprise-admin#set-settings": "/rest/enterprise-admin/management-console#set-settings", + "/rest/enterprise-admin#get-all-authorized-ssh-keys": "/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys", + "/rest/enterprise-admin#add-an-authorized-ssh-key": "/rest/enterprise-admin/management-console#add-an-authorized-ssh-key", + "/rest/enterprise-admin#remove-an-authorized-ssh-key": "/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key", + "/rest/enterprise-admin#create-a-github-enterprise-server-license": "/rest/enterprise-admin/management-console#create-a-github-enterprise-server-license", + "/rest/enterprise-admin#upgrade-a-license": "/rest/enterprise-admin/management-console#upgrade-a-license", + "/rest/enterprise-admin#promote-a-user-to-be-a-site-administrator": "/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator", + "/rest/enterprise-admin#demote-a-site-administrator": "/rest/enterprise-admin/users#demote-a-site-administrator", + "/rest/enterprise-admin#suspend-a-user": "/rest/enterprise-admin/users#suspend-a-user", + "/rest/enterprise-admin#unsuspend-a-user": "/rest/enterprise-admin/users#unsuspend-a-user", + "/rest/repos#list-repository-cache-replication-status": "/rest/repos/repos#list-repository-cache-replication-status" } \ No newline at end of file diff --git a/lib/redirects/static/developer.json b/lib/redirects/static/developer.json index aa635c4523..a4ead6bf75 100644 --- a/lib/redirects/static/developer.json +++ b/lib/redirects/static/developer.json @@ -598,12 +598,12 @@ "/enterprise/2.20/v3/troubleshooting": "/enterprise-server@2.20/rest/overview/troubleshooting", "/github-ae@latest/v3/troubleshooting": "/github-ae@latest/rest/overview/troubleshooting", "/free-pro-team@latest/rest/reference/actions": "/rest/reference/actions", - "/v3/actions": "/rest/reference/actions", + "/v3/actions": "/rest/actions", "/free-pro-team@latest/v3/actions": "/rest/reference/actions", "/enterprise/rest/reference/actions": "/enterprise-server@latest/rest/reference/actions", "/enterprise/v3/actions": "/enterprise-server@latest/rest/reference/actions", "/free-pro-team@latest/rest/reference/activity": "/rest/reference/activity", - "/v3/activity": "/rest/reference/activity", + "/v3/activity": "/rest/activity", "/free-pro-team@latest/v3/activity": "/rest/reference/activity", "/enterprise/rest/reference/activity": "/enterprise-server@latest/rest/reference/activity", "/enterprise/v3/activity": "/enterprise-server@latest/rest/reference/activity", @@ -612,7 +612,7 @@ "/enterprise/2.20/v3/activity": "/enterprise-server@2.20/rest/reference/activity", "/github-ae@latest/v3/activity": "/github-ae@latest/rest/reference/activity", "/free-pro-team@latest/rest/reference/apps": "/rest/reference/apps", - "/v3/apps": "/rest/reference/apps", + "/v3/apps": "/rest/apps", "/free-pro-team@latest/v3/apps": "/rest/reference/apps", "/enterprise/rest/reference/apps": "/enterprise-server@latest/rest/reference/apps", "/enterprise/v3/apps": "/enterprise-server@latest/rest/reference/apps", @@ -622,7 +622,7 @@ "/github-ae@latest/v3/apps": "/github-ae@latest/rest/reference/apps", "/free-pro-team@latest/rest/reference/billing": "/rest/reference/billing", "/free-pro-team@latest/rest/reference/checks": "/rest/reference/checks", - "/v3/checks": "/rest/reference/checks", + "/v3/checks": "/rest/checks", "/free-pro-team@latest/v3/checks": "/rest/reference/checks", "/enterprise/rest/reference/checks": "/enterprise-server@latest/rest/reference/checks", "/enterprise/v3/checks": "/enterprise-server@latest/rest/reference/checks", @@ -631,14 +631,14 @@ "/enterprise/2.20/v3/checks": "/enterprise-server@2.20/rest/reference/checks", "/github-ae@latest/v3/checks": "/github-ae@latest/rest/reference/checks", "/free-pro-team@latest/rest/reference/code-scanning": "/rest/reference/code-scanning", - "/v3/code-scanning": "/rest/reference/code-scanning", + "/v3/code-scanning": "/rest/code-scanning", "/free-pro-team@latest/v3/code-scanning": "/rest/reference/code-scanning", "/enterprise/rest/reference/code-scanning": "/enterprise-server@latest/rest/reference/code-scanning", "/enterprise/v3/code-scanning": "/enterprise-server@latest/rest/reference/code-scanning", "/free-pro-team@latest/rest/reference/codes-of-conduct": "/rest/reference/codes-of-conduct", - "/v3/codes_of_conduct": "/rest/reference/codes-of-conduct", + "/v3/codes_of_conduct": "/rest/codes-of-conduct", "/free-pro-team@latest/v3/codes_of_conduct": "/rest/reference/codes-of-conduct", - "/v3/codes-of-conduct": "/rest/reference/codes-of-conduct", + "/v3/codes-of-conduct": "/rest/codes-of-conduct", "/free-pro-team@latest/v3/codes-of-conduct": "/rest/reference/codes-of-conduct", "/enterprise/rest/reference/codes-of-conduct": "/enterprise-server@latest/rest/reference/codes-of-conduct", "/enterprise/v3/codes_of_conduct": "/enterprise-server@latest/rest/reference/codes-of-conduct", @@ -651,9 +651,9 @@ "/github-ae@latest/v3/codes_of_conduct": "/github-ae@latest/rest/reference/codes-of-conduct", "/github-ae@latest/v3/codes-of-conduct": "/github-ae@latest/rest/reference/codes-of-conduct", "/free-pro-team@latest/rest/reference/emojis": "/rest/reference/emojis", - "/v3/emojis": "/rest/reference/emojis", + "/v3/emojis": "/rest/emojis", "/free-pro-team@latest/v3/emojis": "/rest/reference/emojis", - "/v3/misc": "/rest/reference/emojis", + "/v3/misc": "/rest/emojis", "/free-pro-team@latest/v3/misc": "/rest/reference/emojis", "/enterprise/rest/reference/emojis": "/enterprise-server@latest/rest/reference/emojis", "/enterprise/v3/emojis": "/enterprise-server@latest/rest/reference/emojis", @@ -666,9 +666,9 @@ "/github-ae@latest/v3/emojis": "/github-ae@latest/rest/reference/emojis", "/github-ae@latest/v3/misc": "/github-ae@latest/rest/reference/emojis", "/free-pro-team@latest/rest/reference/enterprise-admin": "/rest/reference/enterprise-admin", - "/v3/enterprise-admin": "/rest/reference/enterprise-admin", + "/v3/enterprise-admin": "/rest/enterprise-admin", "/free-pro-team@latest/v3/enterprise-admin": "/rest/reference/enterprise-admin", - "/v3/enterprise": "/rest/reference/enterprise-admin", + "/v3/enterprise": "/rest/enterprise-admin", "/free-pro-team@latest/v3/enterprise": "/rest/reference/enterprise-admin", "/enterprise/rest/reference/enterprise-admin": "/enterprise-server@latest/rest/reference/enterprise-admin", "/enterprise/v3/enterprise-admin": "/enterprise-server@latest/rest/reference/enterprise-admin", @@ -681,7 +681,7 @@ "/github-ae@latest/v3/enterprise-admin": "/github-ae@latest/rest/reference/enterprise-admin", "/github-ae@latest/v3/enterprise": "/github-ae@latest/rest/reference/enterprise-admin", "/free-pro-team@latest/rest/reference/gists": "/rest/reference/gists", - "/v3/gists": "/rest/reference/gists", + "/v3/gists": "/rest/gists", "/free-pro-team@latest/v3/gists": "/rest/reference/gists", "/enterprise/rest/reference/gists": "/enterprise-server@latest/rest/reference/gists", "/enterprise/v3/gists": "/enterprise-server@latest/rest/reference/gists", @@ -690,7 +690,7 @@ "/enterprise/2.20/v3/gists": "/enterprise-server@2.20/rest/reference/gists", "/github-ae@latest/v3/gists": "/github-ae@latest/rest/reference/gists", "/free-pro-team@latest/rest/reference/git": "/rest/reference/git", - "/v3/git": "/rest/reference/git", + "/v3/git": "/rest/git", "/free-pro-team@latest/v3/git": "/rest/reference/git", "/enterprise/rest/reference/git": "/enterprise-server@latest/rest/reference/git", "/enterprise/v3/git": "/enterprise-server@latest/rest/reference/git", @@ -699,7 +699,7 @@ "/enterprise/2.20/v3/git": "/enterprise-server@2.20/rest/reference/git", "/github-ae@latest/v3/git": "/github-ae@latest/rest/reference/git", "/free-pro-team@latest/rest/reference/gitignore": "/rest/reference/gitignore", - "/v3/gitignore": "/rest/reference/gitignore", + "/v3/gitignore": "/rest/gitignore", "/free-pro-team@latest/v3/gitignore": "/rest/reference/gitignore", "/enterprise/rest/reference/gitignore": "/enterprise-server@latest/rest/reference/gitignore", "/enterprise/v3/gitignore": "/enterprise-server@latest/rest/reference/gitignore", @@ -711,10 +711,10 @@ "/enterprise/rest/reference": "/enterprise-server@latest/rest/reference", "/enterprise/2.20/rest/reference": "/enterprise-server@2.20/rest/reference", "/free-pro-team@latest/rest/reference/interactions": "/rest/reference/interactions", - "/v3/interactions": "/rest/reference/interactions", + "/v3/interactions": "/rest/interactions", "/free-pro-team@latest/v3/interactions": "/rest/reference/interactions", "/free-pro-team@latest/rest/reference/issues": "/rest/reference/issues", - "/v3/issues": "/rest/reference/issues", + "/v3/issues": "/rest/issues", "/free-pro-team@latest/v3/issues": "/rest/reference/issues", "/enterprise/rest/reference/issues": "/enterprise-server@latest/rest/reference/issues", "/enterprise/v3/issues": "/enterprise-server@latest/rest/reference/issues", @@ -723,7 +723,7 @@ "/enterprise/2.20/v3/issues": "/enterprise-server@2.20/rest/reference/issues", "/github-ae@latest/v3/issues": "/github-ae@latest/rest/reference/issues", "/free-pro-team@latest/rest/reference/licenses": "/rest/reference/licenses", - "/v3/licenses": "/rest/reference/licenses", + "/v3/licenses": "/rest/licenses", "/free-pro-team@latest/v3/licenses": "/rest/reference/licenses", "/enterprise/rest/reference/licenses": "/enterprise-server@latest/rest/reference/licenses", "/enterprise/v3/licenses": "/enterprise-server@latest/rest/reference/licenses", @@ -732,7 +732,7 @@ "/enterprise/2.20/v3/licenses": "/enterprise-server@2.20/rest/reference/licenses", "/github-ae@latest/v3/licenses": "/github-ae@latest/rest/reference/licenses", "/free-pro-team@latest/rest/reference/markdown": "/rest/reference/markdown", - "/v3/markdown": "/rest/reference/markdown", + "/v3/markdown": "/rest/markdown", "/free-pro-team@latest/v3/markdown": "/rest/reference/markdown", "/enterprise/rest/reference/markdown": "/enterprise-server@latest/rest/reference/markdown", "/enterprise/v3/markdown": "/enterprise-server@latest/rest/reference/markdown", @@ -741,7 +741,7 @@ "/enterprise/2.20/v3/markdown": "/enterprise-server@2.20/rest/reference/markdown", "/github-ae@latest/v3/markdown": "/github-ae@latest/rest/reference/markdown", "/free-pro-team@latest/rest/reference/meta": "/rest/reference/meta", - "/v3/meta": "/rest/reference/meta", + "/v3/meta": "/rest/meta", "/free-pro-team@latest/v3/meta": "/rest/reference/meta", "/enterprise/rest/reference/meta": "/enterprise-server@latest/rest/reference/meta", "/enterprise/v3/meta": "/enterprise-server@latest/rest/reference/meta", @@ -750,11 +750,11 @@ "/enterprise/2.20/v3/meta": "/enterprise-server@2.20/rest/reference/meta", "/github-ae@latest/v3/meta": "/github-ae@latest/rest/reference/meta", "/free-pro-team@latest/rest/reference/migrations": "/rest/reference/migrations", - "/v3/migrations": "/rest/reference/migrations", + "/v3/migrations": "/rest/migrations", "/free-pro-team@latest/v3/migrations": "/rest/reference/migrations", - "/v3/migration": "/rest/reference/migrations", + "/v3/migration": "/rest/migrations", "/free-pro-team@latest/v3/migration": "/rest/reference/migrations", - "/v3/migration/migrations": "/rest/reference/migrations", + "/v3/migration/migrations": "/rest/migrations", "/free-pro-team@latest/v3/migration/migrations": "/rest/reference/migrations", "/enterprise/rest/reference/oauth-authorizations": "/enterprise-server@latest/rest/reference/oauth-authorizations", "/enterprise/v3/oauth_authorizations": "/enterprise-server@latest/rest/reference/oauth-authorizations", @@ -765,7 +765,7 @@ "/enterprise-server@2.20/v3/oauth-authorizations": "/enterprise-server@2.20/rest/reference/oauth-authorizations", "/enterprise/2.20/v3/oauth-authorizations": "/enterprise-server@2.20/rest/reference/oauth-authorizations", "/free-pro-team@latest/rest/reference/orgs": "/rest/reference/orgs", - "/v3/orgs": "/rest/reference/orgs", + "/v3/orgs": "/rest/orgs", "/free-pro-team@latest/v3/orgs": "/rest/reference/orgs", "/enterprise/rest/reference/orgs": "/enterprise-server@latest/rest/reference/orgs", "/enterprise/v3/orgs": "/enterprise-server@latest/rest/reference/orgs", @@ -774,7 +774,7 @@ "/enterprise/2.20/v3/orgs": "/enterprise-server@2.20/rest/reference/orgs", "/github-ae@latest/v3/orgs": "/github-ae@latest/rest/reference/orgs", "/free-pro-team@latest/rest/reference/permissions-required-for-github-apps": "/rest/reference/permissions-required-for-github-apps", - "/v3/apps/permissions": "/rest/reference/permissions-required-for-github-apps", + "/v3/apps/permissions": "/rest/overview/permissions-required-for-github-apps", "/free-pro-team@latest/v3/apps/permissions": "/rest/reference/permissions-required-for-github-apps", "/enterprise/rest/reference/permissions-required-for-github-apps": "/enterprise-server@latest/rest/reference/permissions-required-for-github-apps", "/enterprise/v3/apps/permissions": "/enterprise-server@latest/rest/reference/permissions-required-for-github-apps", @@ -783,7 +783,7 @@ "/enterprise/2.20/v3/apps/permissions": "/enterprise-server@2.20/rest/reference/permissions-required-for-github-apps", "/github-ae@latest/v3/apps/permissions": "/github-ae@latest/rest/reference/permissions-required-for-github-apps", "/free-pro-team@latest/rest/reference/projects": "/rest/reference/projects", - "/v3/projects": "/rest/reference/projects", + "/v3/projects": "/rest/projects", "/free-pro-team@latest/v3/projects": "/rest/reference/projects", "/enterprise/rest/reference/projects": "/enterprise-server@latest/rest/reference/projects", "/enterprise/v3/projects": "/enterprise-server@latest/rest/reference/projects", @@ -792,7 +792,7 @@ "/enterprise/2.20/v3/projects": "/enterprise-server@2.20/rest/reference/projects", "/github-ae@latest/v3/projects": "/github-ae@latest/rest/reference/projects", "/free-pro-team@latest/rest/reference/pulls": "/rest/reference/pulls", - "/v3/pulls": "/rest/reference/pulls", + "/v3/pulls": "/rest/pulls", "/free-pro-team@latest/v3/pulls": "/rest/reference/pulls", "/enterprise/rest/reference/pulls": "/enterprise-server@latest/rest/reference/pulls", "/enterprise/v3/pulls": "/enterprise-server@latest/rest/reference/pulls", @@ -801,9 +801,9 @@ "/enterprise/2.20/v3/pulls": "/enterprise-server@2.20/rest/reference/pulls", "/github-ae@latest/v3/pulls": "/github-ae@latest/rest/reference/pulls", "/free-pro-team@latest/rest/reference/rate-limit": "/rest/reference/rate-limit", - "/v3/rate_limit": "/rest/reference/rate-limit", + "/v3/rate_limit": "/rest/rate-limit", "/free-pro-team@latest/v3/rate_limit": "/rest/reference/rate-limit", - "/v3/rate-limit": "/rest/reference/rate-limit", + "/v3/rate-limit": "/rest/rate-limit", "/free-pro-team@latest/v3/rate-limit": "/rest/reference/rate-limit", "/enterprise/rest/reference/rate-limit": "/enterprise-server@latest/rest/reference/rate-limit", "/enterprise/v3/rate_limit": "/enterprise-server@latest/rest/reference/rate-limit", @@ -816,7 +816,7 @@ "/github-ae@latest/v3/rate_limit": "/github-ae@latest/rest/reference/rate-limit", "/github-ae@latest/v3/rate-limit": "/github-ae@latest/rest/reference/rate-limit", "/free-pro-team@latest/rest/reference/reactions": "/rest/reference/reactions", - "/v3/reactions": "/rest/reference/reactions", + "/v3/reactions": "/rest/reactions", "/free-pro-team@latest/v3/reactions": "/rest/reference/reactions", "/enterprise/rest/reference/reactions": "/enterprise-server@latest/rest/reference/reactions", "/enterprise/v3/reactions": "/enterprise-server@latest/rest/reference/reactions", @@ -825,7 +825,7 @@ "/enterprise/2.20/v3/reactions": "/enterprise-server@2.20/rest/reference/reactions", "/github-ae@latest/v3/reactions": "/github-ae@latest/rest/reference/reactions", "/free-pro-team@latest/rest/reference/repos": "/rest/reference/repos", - "/v3/repos": "/rest/reference/repos", + "/v3/repos": "/rest/repos", "/free-pro-team@latest/v3/repos": "/rest/reference/repos", "/enterprise/rest/reference/repos": "/enterprise-server@latest/rest/reference/repos", "/enterprise/v3/repos": "/enterprise-server@latest/rest/reference/repos", @@ -834,10 +834,10 @@ "/enterprise/2.20/v3/repos": "/enterprise-server@2.20/rest/reference/repos", "/github-ae@latest/v3/repos": "/github-ae@latest/rest/reference/repos", "/free-pro-team@latest/rest/reference/scim": "/rest/reference/scim", - "/v3/scim": "/rest/reference/scim", + "/v3/scim": "/rest/scim", "/free-pro-team@latest/v3/scim": "/rest/reference/scim", "/free-pro-team@latest/rest/reference/search": "/rest/reference/search", - "/v3/search": "/rest/reference/search", + "/v3/search": "/rest/search", "/free-pro-team@latest/v3/search": "/rest/reference/search", "/enterprise/rest/reference/search": "/enterprise-server@latest/rest/reference/search", "/enterprise/v3/search": "/enterprise-server@latest/rest/reference/search", @@ -847,7 +847,7 @@ "/github-ae@latest/v3/search": "/github-ae@latest/rest/reference/search", "/free-pro-team@latest/rest/reference/secret-scanning": "/rest/reference/secret-scanning", "/free-pro-team@latest/rest/reference/teams": "/rest/reference/teams", - "/v3/teams": "/rest/reference/teams", + "/v3/teams": "/rest/teams", "/free-pro-team@latest/v3/teams": "/rest/reference/teams", "/enterprise/rest/reference/teams": "/enterprise-server@latest/rest/reference/teams", "/enterprise/v3/teams": "/enterprise-server@latest/rest/reference/teams", @@ -856,7 +856,7 @@ "/enterprise/2.20/v3/teams": "/enterprise-server@2.20/rest/reference/teams", "/github-ae@latest/v3/teams": "/github-ae@latest/rest/reference/teams", "/free-pro-team@latest/rest/reference/users": "/rest/reference/users", - "/v3/users": "/rest/reference/users", + "/v3/users": "/rest/users", "/free-pro-team@latest/v3/users": "/rest/reference/users", "/enterprise/rest/reference/users": "/enterprise-server@latest/rest/reference/users", "/enterprise/v3/users": "/enterprise-server@latest/rest/reference/users", @@ -3110,108 +3110,108 @@ "/enterprise/v4/union/reviewdismissalallowanceactor": "/enterprise-server@latest/graphql/reference/unions#reviewdismissalallowanceactor", "/enterprise/v4/union/searchresultitem": "/enterprise-server@latest/graphql/reference/unions#searchresultitem", "/enterprise/v4/union/statuscheckrollupcontext": "/enterprise-server@latest/graphql/reference/unions#statuscheckrollupcontext", - "/v3/actions/artifacts": "/rest/reference/actions#artifacts", - "/v3/actions/secrets": "/rest/reference/actions#secrets", - "/v3/actions/self-hosted-runners": "/rest/reference/actions#self-hosted-runners", - "/v3/actions/self_hosted_runners": "/rest/reference/actions#self-hosted-runners", - "/v3/actions/workflow-jobs": "/rest/reference/actions#workflow-jobs", - "/v3/actions/workflow-runs": "/rest/reference/actions#workflow-runs", - "/v3/actions/workflow_jobs": "/rest/reference/actions#workflow-jobs", - "/v3/actions/workflow_runs": "/rest/reference/actions#workflow-runs", - "/v3/actions/workflows": "/rest/reference/actions#workflows", - "/v3/activity/events": "/rest/reference/activity#events", - "/v3/activity/feeds": "/rest/reference/activity#feeds", - "/v3/activity/notifications": "/rest/reference/activity#notifications", - "/v3/activity/starring": "/rest/reference/activity#starring", - "/v3/activity/watching": "/rest/reference/activity#watching", - "/v3/apps/installations": "/rest/reference/apps#installations", - "/v3/apps/marketplace": "/rest/reference/apps#marketplace", - "/v3/apps/oauth_applications": "/rest/reference/apps#oauth-applications", - "/v3/checks/runs": "/rest/reference/checks#runs", - "/v3/checks/suites": "/rest/reference/checks#suites", - "/v3/enterprise-admin/admin_stats": "/enterprise-server@latest/rest/reference/enterprise-admin#admin-stats", - "/v3/enterprise-admin/global_webhooks": "/enterprise-server@latest/rest/reference/enterprise-admin#global-webhooks", - "/v3/enterprise-admin/ldap": "/enterprise-server@latest/rest/reference/enterprise-admin#ldap", - "/v3/enterprise-admin/license": "/enterprise-server@latest/rest/reference/enterprise-admin#license", - "/v3/enterprise-admin/management_console": "/enterprise-server@latest/rest/reference/enterprise-admin#management-console", - "/v3/enterprise-admin/orgs": "/enterprise-server@latest/rest/reference/enterprise-admin#orgs", - "/v3/enterprise-admin/pre_receive_environments": "/enterprise-server@latest/rest/reference/enterprise-admin#pre-receive-environments", - "/v3/enterprise-admin/pre_receive_hooks": "/enterprise-server@latest/rest/reference/enterprise-admin#pre-receive-hooks", - "/v3/enterprise-admin/search_indexing": "/enterprise-server@latest/rest/reference/enterprise-admin#search-indexing", - "/v3/enterprise-admin/users": "/enterprise-server@latest/rest/reference/enterprise-admin#users", - "/v3/enterprise/admin_stats": "/enterprise-server@latest/rest/reference/enterprise-admin#admin-stats", - "/v3/enterprise/global_webhooks": "/enterprise-server@latest/rest/reference/enterprise-admin#global-webhooks", - "/v3/enterprise/ldap": "/enterprise-server@latest/rest/reference/enterprise-admin#ldap", - "/v3/enterprise/license": "/enterprise-server@latest/rest/reference/enterprise-admin#license", - "/v3/enterprise/management_console": "/enterprise-server@latest/rest/reference/enterprise-admin#management-console", - "/v3/enterprise/org_pre_receive_hooks": "/enterprise-server@latest/rest/reference/enterprise-admin#organization-pre-receive-hooks", - "/v3/enterprise/orgs": "/enterprise-server@latest/rest/reference/enterprise-admin#orgs", - "/v3/enterprise/pre_receive_environments": "/enterprise-server@latest/rest/reference/enterprise-admin#pre-receive-environments", - "/v3/enterprise/pre_receive_hooks": "/enterprise-server@latest/rest/reference/enterprise-admin#pre-receive-hooks", - "/v3/enterprise/repo_pre_receive_hooks": "/enterprise-server@latest/rest/reference/enterprise-admin#repository-pre-receive-hooks", - "/v3/enterprise/search_indexing": "/enterprise-server@latest/rest/reference/enterprise-admin#search-indexing", - "/v3/enterprise/users": "/enterprise-server@latest/rest/reference/enterprise-admin#users", - "/v3/gists/comments": "/rest/reference/gists#comments", - "/v3/git/blobs": "/rest/reference/git#blobs", - "/v3/git/commits": "/rest/reference/git#commits", - "/v3/git/refs": "/rest/reference/git#refs", - "/v3/git/tags": "/rest/reference/git#tags", - "/v3/git/trees": "/rest/reference/git#trees", - "/v3/integrations/installations": "/developers/apps#installations", - "/v3/interactions/orgs": "/rest/reference/interactions#orgs", - "/v3/interactions/repos": "/rest/reference/interactions#repos", - "/v3/issues/assignees": "/rest/reference/issues#assignees", - "/v3/issues/comments": "/rest/reference/issues#comments", - "/v3/issues/events": "/rest/reference/issues#events", - "/v3/issues/labels": "/rest/reference/issues#labels", - "/v3/issues/milestones": "/rest/reference/issues#milestones", - "/v3/issues/timeline": "/rest/reference/issues#timeline", - "/v3/migration/source_imports": "/rest/reference/migrations#source-imports", - "/v3/migrations/orgs": "/rest/reference/migrations#orgs", - "/v3/migrations/source_imports": "/rest/reference/migrations#source-imports", - "/v3/migrations/users": "/rest/reference/migrations#users", - "/v3/oauth_authorizations": "/enterprise-server@latest/rest/reference/oauth-authorizations", - "/v3/orgs/blocking": "/rest/reference/orgs#blocking", - "/v3/orgs/hooks": "/rest/reference/orgs#webhooks", - "/v3/orgs/members": "/rest/reference/orgs#members", - "/v3/orgs/migrations": "/rest/reference/orgs#migrations", - "/v3/orgs/outside_collaborators": "/rest/reference/orgs#outside-collaborators", - "/v3/orgs/pre_receive_hooks": "/enterprise-server@latest/rest/reference/enterprise-admin#organization-pre-receive-hooks", - "/v3/orgs/teams": "/rest/reference/orgs#teams", - "/v3/projects/cards": "/rest/reference/projects#cards", - "/v3/projects/collaborators": "/rest/reference/projects#collaborators", - "/v3/projects/columns": "/rest/reference/projects#columns", - "/v3/pulls/comments": "/rest/reference/pulls#comments", - "/v3/pulls/review_requests": "/rest/reference/pulls#review-requests", - "/v3/pulls/reviews": "/rest/reference/pulls#reviews", - "/v3/repos/branches": "/rest/reference/repos#branches", - "/v3/repos/collaborators": "/rest/reference/repos#collaborators", - "/v3/repos/comments": "/rest/reference/repos#comments", - "/v3/repos/commits": "/rest/reference/repos#commits", - "/v3/repos/community": "/rest/reference/repos#community", - "/v3/repos/contents": "/rest/reference/repos#contents", - "/v3/repos/deployments": "/rest/reference/repos#deployments", - "/v3/repos/downloads": "/rest/reference/repos#downloads", - "/v3/repos/forks": "/rest/reference/repos#forks", - "/v3/repos/hooks": "/rest/reference/repos#webhooks", - "/v3/repos/invitations": "/rest/reference/repos#invitations", - "/v3/repos/keys": "/rest/reference/repos#keys", - "/v3/repos/merging": "/rest/reference/repos#merging", - "/v3/repos/pages": "/rest/reference/repos#pages", - "/v3/repos/pre_receive_hooks": "/enterprise-server@latest/rest/reference/enterprise-admin#repository-pre-receive-hooks", - "/v3/repos/releases": "/rest/reference/repos#releases", - "/v3/repos/statistics": "/rest/reference/repos#statistics", - "/v3/repos/statuses": "/rest/reference/repos#statuses", - "/v3/repos/traffic": "/rest/reference/repos#traffic", - "/v3/teams/discussion_comments": "/rest/reference/teams#discussion-comments", - "/v3/teams/discussions": "/rest/reference/teams#discussions", - "/v3/teams/members": "/rest/reference/teams#members", - "/v3/teams/team_sync": "/rest/reference/teams#team-sync", - "/v3/users/blocking": "/rest/reference/users#blocking", - "/v3/users/emails": "/rest/reference/users#emails", - "/v3/users/followers": "/rest/reference/users#followers", - "/v3/users/gpg_keys": "/rest/reference/users#gpg-keys", - "/v3/users/keys": "/rest/reference/users#keys", + "/v3/actions/artifacts": "/rest/actions/artifacts", + "/v3/actions/secrets": "/rest/actions/secrets", + "/v3/actions/self-hosted-runners": "/rest/actions/self-hosted-runners", + "/v3/actions/self_hosted_runners": "/rest/actions/self-hosted-runners", + "/v3/actions/workflow-jobs": "/rest/actions/workflow-jobs", + "/v3/actions/workflow-runs": "/rest/actions/workflow-runs", + "/v3/actions/workflow_jobs": "/rest/actions/workflow-jobs", + "/v3/actions/workflow_runs": "/rest/actions/workflow-runs", + "/v3/actions/workflows": "/rest/actions/workflows", + "/v3/activity/events": "/rest/activity/events", + "/v3/activity/feeds": "/rest/activity/feeds", + "/v3/activity/notifications": "/rest/activity/notifications", + "/v3/activity/starring": "/rest/activity/starring", + "/v3/activity/watching": "/rest/activity/watching", + "/v3/apps/installations": "/rest/apps/installations", + "/v3/apps/marketplace": "/rest/apps/marketplace", + "/v3/apps/oauth_applications": "/rest/apps/oauth-applications", + "/v3/checks/runs": "/rest/checks/runs", + "/v3/checks/suites": "/rest/checks/suites", + "/v3/enterprise-admin/admin_stats": "/enterprise-server@latest/rest/enterprise-admin/admin-stats", + "/v3/enterprise-admin/global_webhooks": "/enterprise-server@latest/rest/enterprise-admin/global-webhooks", + "/v3/enterprise-admin/ldap": "/enterprise-server@latest/rest/enterprise-admin/ldap", + "/v3/enterprise-admin/license": "/enterprise-server@latest/rest/enterprise-admin/license", + "/v3/enterprise-admin/management_console": "/enterprise-server@latest/rest/enterprise-admin/management-console", + "/v3/enterprise-admin/orgs": "/enterprise-server@latest/rest/enterprise-admin/orgs", + "/v3/enterprise-admin/pre_receive_environments": "/enterprise-server@latest/rest/enterprise-admin/pre-receive-environments", + "/v3/enterprise-admin/pre_receive_hooks": "/enterprise-server@latest/rest/enterprise-admin/pre-receive-hooks", + "/v3/enterprise-admin/search_indexing": "/enterprise-server@latest/rest/enterprise-admin", + "/v3/enterprise-admin/users": "/enterprise-server@latest/rest/enterprise-admin/users", + "/v3/enterprise/admin_stats": "/enterprise-server@latest/rest/enterprise-admin/admin-stats", + "/v3/enterprise/global_webhooks": "/enterprise-server@latest/rest/enterprise-admin/global-webhooks", + "/v3/enterprise/ldap": "/enterprise-server@latest/rest/enterprise-admin/ldap", + "/v3/enterprise/license": "/enterprise-server@latest/rest/enterprise-admin/license", + "/v3/enterprise/management_console": "/enterprise-server@latest/rest/enterprise-admin/management-console", + "/v3/enterprise/org_pre_receive_hooks": "/enterprise-server@latest/rest/enterprise-admin/organization-pre-receive-hooks", + "/v3/enterprise/orgs": "/enterprise-server@latest/rest/enterprise-admin/orgs", + "/v3/enterprise/pre_receive_environments": "/enterprise-server@latest/rest/enterprise-admin/pre-receive-environments", + "/v3/enterprise/pre_receive_hooks": "/enterprise-server@latest/rest/enterprise-admin/pre-receive-hooks", + "/v3/enterprise/repo_pre_receive_hooks": "/enterprise-server@latest/rest/enterprise-admin/repository-pre-receive-hooks", + "/v3/enterprise/search_indexing": "/enterprise-server@latest/rest/enterprise-admin", + "/v3/enterprise/users": "/enterprise-server@latest/rest/enterprise-admin/users", + "/v3/gists/comments": "/rest/gists/comments", + "/v3/git/blobs": "/rest/git/blobs", + "/v3/git/commits": "/rest/git/commits", + "/v3/git/refs": "/rest/git/refs", + "/v3/git/tags": "/rest/git/tags", + "/v3/git/trees": "/rest/git/trees", + "/v3/integrations/installations": "/developers/apps/installations", + "/v3/interactions/orgs": "/rest/interactions/orgs", + "/v3/interactions/repos": "/rest/interactions/repos", + "/v3/issues/assignees": "/rest/issues/assignees", + "/v3/issues/comments": "/rest/issues/comments", + "/v3/issues/events": "/rest/issues/events", + "/v3/issues/labels": "/rest/issues/labels", + "/v3/issues/milestones": "/rest/issues/milestones", + "/v3/issues/timeline": "/rest/issues/timeline", + "/v3/migration/source_imports": "/rest/migrations/source-imports", + "/v3/migrations/orgs": "/rest/migrations/orgs", + "/v3/migrations/source_imports": "/rest/migrations/source-imports", + "/v3/migrations/users": "/rest/migrations/users", + "/v3/oauth_authorizations": "/enterprise-server@latest/rest/oauth-authorizations", + "/v3/orgs/blocking": "/rest/orgs/blocking", + "/v3/orgs/hooks": "/rest/orgs/webhooks", + "/v3/orgs/members": "/rest/orgs/members", + "/v3/orgs/migrations": "/rest/migrations/orgs", + "/v3/orgs/outside_collaborators": "/rest/orgs/outside-collaborators", + "/v3/orgs/pre_receive_hooks": "/enterprise-server@latest/rest/enterprise-admin/org-pre-receive-hooks", + "/v3/orgs/teams": "/rest/teams/teams", + "/v3/projects/cards": "/rest/projects/cards", + "/v3/projects/collaborators": "/rest/projects/collaborators", + "/v3/projects/columns": "/rest/projects/columns", + "/v3/pulls/comments": "/rest/pulls/comments", + "/v3/pulls/review_requests": "/rest/pulls/review-requests", + "/v3/pulls/reviews": "/rest/pulls/reviews", + "/v3/repos/branches": "/rest/branches/branches", + "/v3/repos/collaborators": "/rest/collaborators/collaborators", + "/v3/repos/comments": "/rest/commits/comments", + "/v3/repos/commits": "/rest/commits/commits", + "/v3/repos/community": "/rest/metrics/community", + "/v3/repos/contents": "/rest/repos/contents", + "/v3/repos/deployments": "/rest/deployments/deployments", + "/v3/repos/downloads": "/rest/metrics/traffic", + "/v3/repos/forks": "/rest/repos/forks", + "/v3/repos/hooks": "/rest/webhooks/repo-config", + "/v3/repos/invitations": "/rest/collaborators/invitations", + "/v3/repos/keys": "/rest/deploy-keys", + "/v3/repos/merging": "/rest/branches/branches", + "/v3/repos/pages": "/rest/pages", + "/v3/repos/pre_receive_hooks": "/enterprise-server@latest/rest/enterprise-admin/repo-pre-receive-hooks", + "/v3/repos/releases": "/rest/releases/releases", + "/v3/repos/statistics": "/rest/metrics/statistics", + "/v3/repos/statuses": "/rest/commits/statuses", + "/v3/repos/traffic": "/rest/metrics/traffic", + "/v3/teams/discussion_comments": "/rest/teams/discussion-comments", + "/v3/teams/discussions": "/rest/teams/discussions", + "/v3/teams/members": "/rest/teams/members", + "/v3/teams/team_sync": "/rest/teams/team-sync", + "/v3/users/blocking": "/rest/users/blocking", + "/v3/users/emails": "/rest/users/emails", + "/v3/users/followers": "/rest/users/followers", + "/v3/users/gpg_keys": "/rest/users/gpg-keys", + "/v3/users/keys": "/rest/users/keys", "/v4/enum/__directivelocation": "/graphql/reference/enums#__directivelocation", "/v4/enum/__typekind": "/graphql/reference/enums#__typekind", "/v4/enum/actionexecutioncapabilitysetting": "/graphql/reference/enums#actionexecutioncapabilitysetting", diff --git a/lib/redirects/static/redirect-exceptions.txt b/lib/redirects/static/redirect-exceptions.txt index d68b32f47e..35a5cab60d 100644 --- a/lib/redirects/static/redirect-exceptions.txt +++ b/lib/redirects/static/redirect-exceptions.txt @@ -231,7 +231,7 @@ - /github/setting-up-and-managing-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise-account - /admin/user-management/managing-organizations-in-your-enterprise/viewing-the-audit-logs-for-organizations-in-your-enterprise -/enterprise-cloud@latest/admin/user-management/managing-organizations-in-your-enterprise/streaming-the-audit-logs-for-organizations-in-your-enterprise-account +/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise - /github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/streaming-the-audit-logs-for-organizations-in-your-enterprise-account - /admin/user-management/managing-organizations-in-your-enterprise/streaming-the-audit-logs-for-organizations-in-your-enterprise-account @@ -514,3 +514,8 @@ /enterprise-cloud@latest/rest/reference/secret-scanning - /rest/reference/secret-scanning + +# FPT versioning was removed as part of github/docs-content#5166 + +/rest/overview/resources-in-the-rest-api +- /rest/overview/api-previews diff --git a/lib/rest/index.js b/lib/rest/index.js index c18fcbb768..434c1fcced 100644 --- a/lib/rest/index.js +++ b/lib/rest/index.js @@ -33,7 +33,7 @@ Object.keys(languages).forEach((language) => { }) const restOperations = new Map() -export default async function getRest(version, category) { +export default async function getRest(version, category, subCategory) { const openApiVersion = getOpenApiVersion(version) if (!restOperations.has(openApiVersion)) { const filename = `${openApiVersion}.json` @@ -46,9 +46,15 @@ export default async function getRest(version, category) { ) } - return category - ? restOperations.get(openApiVersion)[category] - : restOperations.get(openApiVersion) + if (subCategory) { + return restOperations.get(openApiVersion)[category][subCategory] + } else if (category) { + // Some pages are just a category on its own level, and some categories are a subcategory + // E.g. /rest/licenses versus /rest/branches/branches + return restOperations.get(openApiVersion)[category][category] + } else { + return restOperations.get(openApiVersion) + } } // Right now there is not a 1:1 mapping of openapi to docs versions, @@ -68,50 +74,33 @@ function getOpenApiVersion(version) { return allVersions[version].openApiVersionName } -// Generates the rendered Markdown from the data files in the -// data/reusables/rest-reference directory for a given category -// and generates the miniToc for a rest reference page. -export async function getRestOperationData(category, language, version, context) { +// Generates the miniToc for a rest reference page. +export async function getRestMiniTocItems( + category, + subCategory, + restOperations, + language, + version, + context +) { if (!restOperationData.get(language).get(version).has(category)) { + restOperationData.get(language).get(version).set(category, new Map()) + } + + if (!restOperationData.get(language).get(version).get(category).get(subCategory)) { const languageTree = restOperationData.get(language) - const descriptions = {} let toc = '' - const reusablePath = context.site.data.reusables - const categoryOperations = await getRest(version, category) - const subcategories = Object.keys(categoryOperations) - let introContent = null - for (const subcategory of subcategories) { - const markdown = reusablePath['rest-reference']?.[category]?.[subcategory] - const renderedMarkdown = await renderContent(markdown, context) - descriptions[subcategory] = renderedMarkdown - // only a string with the raw HTML of each heading level 2 and 3 - // is needed to generate the toc - const titles = categoryOperations[subcategory] - .map((operation) => `### ${operation.title}\n`) - .join('') - toc += renderedMarkdown + (await renderContent(titles, context)) - } - // Usually a Markdown file in - // data/resuables/rest-reference// - // will always map to a set of operations. But sometimes we have - // introductory text that doesn't map to any operations. - // When that is the case, the category and subcategory are the same. - // Example data/resuables/rest-reference/actions/actions - // The content in this file is called introContent and is displayed - // at the top of the rest reference page. - if (reusablePath['rest-reference']?.[category]?.[category] && !categoryOperations[category]) { - const markdown = reusablePath['rest-reference']?.[category]?.[category] - introContent = await renderContent(markdown, context) - } - const miniTocItems = getMiniTocItems(toc, 3) - languageTree.get(version).set(category, { - descriptions, - miniTocItems, - introContent, + // only a string with the raw HTML of each heading level 3 + // is needed to generate the toc + const titles = restOperations.map((operation) => `### ${operation.title}\n`).join('') + toc += await renderContent(titles, context) + const restOperationsMiniTocItems = getMiniTocItems(toc, 3, '', true) + languageTree.get(version).get(category).set(subCategory, { + restOperationsMiniTocItems, }) restOperationData.set(restOperationData, languageTree) } - return restOperationData.get(language).get(version).get(category) + return restOperationData.get(language).get(version).get(category).get(subCategory) } export async function getEnabledForApps() { diff --git a/lib/rest/static/apps/enabled-for-apps.json b/lib/rest/static/apps/enabled-for-apps.json index 4948027dd3..b1b173fd1b 100644 --- a/lib/rest/static/apps/enabled-for-apps.json +++ b/lib/rest/static/apps/enabled-for-apps.json @@ -933,7 +933,7 @@ } ], "dependency-graph": [], - "deploy_keys": [ + "deploy-keys": [ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys" @@ -3230,7 +3230,7 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "deploy_keys": [ + "deploy-keys": [ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys" @@ -5248,7 +5248,7 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "deploy_keys": [ + "deploy-keys": [ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys" @@ -7326,7 +7326,7 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "deploy_keys": [ + "deploy-keys": [ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys" @@ -9536,7 +9536,7 @@ "requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}" } ], - "deploy_keys": [ + "deploy-keys": [ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys" @@ -11575,7 +11575,7 @@ "requestPath": "/repos/{owner}/{repo}/statuses/{sha}" } ], - "deploy_keys": [ + "deploy-keys": [ { "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys" diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 2fbb3a5ec5..701a6de1c8 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -22182,6 +22182,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -22280,8 +22281,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "https://api.github.com", @@ -22289,6 +22289,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}", "title": "Get a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -22354,8 +22355,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "https://api.github.com", @@ -22363,6 +22363,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", "title": "Rename a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -22547,8 +22548,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "https://api.github.com", @@ -22556,6 +22556,7 @@ "requestPath": "/repos/{owner}/{repo}/merge-upstream", "title": "Sync a fork branch with the upstream repository", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -22630,8 +22631,7 @@ "httpStatusCode": "422", "description": "

    The branch could not be synced for some other reason

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "https://api.github.com", @@ -22639,6 +22639,7 @@ "requestPath": "/repos/{owner}/{repo}/merges", "title": "Merge a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -22835,8 +22836,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -33324,6 +33324,19 @@ ], "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", "childParamsGroups": [] + }, + { + "type": "string or null", + "description": "

    The dismissal note associated with the dismissal of the alert.

    ", + "maxLength": 280, + "name": "dismissed_note", + "in": "body", + "rawType": [ + "string", + "null" + ], + "rawDescription": "The dismissal note associated with the dismissal of the alert.", + "childParamsGroups": [] } ], "enabledForGitHubApps": true, @@ -33336,7 +33349,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." }, "parameters": { "owner": "OWNER", @@ -39124,6 +39138,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39238,8 +39253,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://api.github.com", @@ -39247,6 +39261,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Check if a user is a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39307,8 +39322,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://api.github.com", @@ -39316,6 +39330,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39532,8 +39547,7 @@ "description": "

    Validation failed

    " } ], - "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    ", - "subcategory": "collaborators" + "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    " }, { "serverUrl": "https://api.github.com", @@ -39541,6 +39555,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39597,8 +39612,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://api.github.com", @@ -39606,6 +39620,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -39691,8 +39706,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -40475,6 +40489,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -40683,8 +40698,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://api.github.com", @@ -40692,6 +40706,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "title": "List branches for HEAD commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -40764,8 +40779,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://api.github.com", @@ -40773,6 +40787,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "title": "List pull requests associated with a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -41369,8 +41384,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://api.github.com", @@ -41378,6 +41392,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -41561,8 +41576,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://api.github.com", @@ -41570,6 +41584,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -41914,8 +41929,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -44350,15 +44364,14 @@ } ] }, - "deploy_keys": { - "deploy_keys": [ + "deploy-keys": { + "deploy-keys": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", "title": "List deploy keys", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -44435,15 +44448,15 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", "title": "Create a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -44538,15 +44551,15 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Get a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -44617,15 +44630,15 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "https://api.github.com", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Delete a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -44682,7 +44695,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -44694,6 +44708,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -44842,8 +44857,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://api.github.com", @@ -44851,6 +44865,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -45056,8 +45071,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://api.github.com", @@ -45065,6 +45079,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -45164,8 +45179,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://api.github.com", @@ -45173,6 +45187,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -45237,8 +45252,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -66838,14 +66852,14 @@ ] } ], - "custom_roles": [ + "custom-roles": [ { "serverUrl": "https://api.github.com", "verb": "get", "requestPath": "/organizations/{organization_id}/custom_roles", "title": "List custom repository roles in an organization", "category": "orgs", - "subcategory": "custom_roles", + "subcategory": "custom-roles", "parameters": [ { "name": "organization_id", @@ -85964,6 +85978,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86109,8 +86124,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86118,6 +86132,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86334,8 +86349,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86343,6 +86357,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", "title": "Generate release notes content for a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86442,8 +86457,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86451,6 +86465,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86573,8 +86588,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86582,6 +86596,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86719,8 +86734,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86728,6 +86742,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -86864,8 +86879,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -86873,6 +86887,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -87082,8 +87097,7 @@ "httpStatusCode": "404", "description": "

    Not Found if the discussion category name is invalid

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://api.github.com", @@ -87091,6 +87105,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -87147,8 +87162,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index b1efe1aaea..5a085ec4e9 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -16989,6 +16989,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -17087,8 +17088,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -17096,6 +17096,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}", "title": "Get a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -17161,8 +17162,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -17170,6 +17170,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", "title": "Rename a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -17354,8 +17355,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -17363,6 +17363,7 @@ "requestPath": "/repos/{owner}/{repo}/merges", "title": "Merge a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -17559,8 +17560,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -26956,7 +26956,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." }, "parameters": { "owner": "OWNER", @@ -27936,6 +27937,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -28047,8 +28049,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28056,6 +28057,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Check if a user is a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -28116,8 +28118,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28125,6 +28126,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -28341,8 +28343,7 @@ "description": "

    Validation failed

    " } ], - "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    ", - "subcategory": "collaborators" + "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    " }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28350,6 +28351,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -28406,8 +28408,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28415,6 +28416,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -28499,8 +28501,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -29283,6 +29284,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -29491,8 +29493,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29500,6 +29501,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "title": "List branches for HEAD commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -29574,8 +29576,7 @@ ], "previews": [ "

    Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the blog post for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.groot-preview+json
    " - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29583,6 +29584,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "title": "List pull requests associated with a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30179,8 +30181,7 @@ ], "previews": [ "

    Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the blog post for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.groot-preview+json
    " - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30188,6 +30189,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30371,8 +30373,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30380,6 +30381,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30706,8 +30708,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -31860,15 +31861,14 @@ } ] }, - "deploy_keys": { - "deploy_keys": [ + "deploy-keys": { + "deploy-keys": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", "title": "List deploy keys", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -31945,15 +31945,15 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", "title": "Create a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -32048,15 +32048,15 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Get a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -32127,15 +32127,15 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Delete a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -32192,7 +32192,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -32204,6 +32205,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -32354,8 +32356,7 @@ ], "previews": [ "

    The inactive state and the log_url, environment_url, and auto_inactive parameters are currently available for developers to preview. Please see the blog post for full details.

    \n

    To access the API during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.ant-man-preview+json
    " - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32363,6 +32364,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -32570,8 +32572,7 @@ ], "previews": [ "

    The inactive state and the log_url, environment_url, and auto_inactive parameters are currently available for developers to preview. Please see the blog post for full details.

    \n

    To access the API during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.ant-man-preview+json
    " - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32579,6 +32580,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -32681,8 +32683,7 @@ "previews": [ "

    New features in the Deployments API on GitHub are currently available during a public beta. Please see the blog post for full details.

    \n

    To access the new environment parameter, the two new values for the state parameter (in_progress and queued), and use auto_inactive on production deployments during the public beta period, you must provide the following custom media type in the Accept header:

    \n
    application/vnd.github.flash-preview+json
    ", "

    The inactive state and the log_url, environment_url, and auto_inactive parameters are currently available for developers to preview. Please see the blog post for full details.

    \n

    To access the API during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.ant-man-preview+json
    " - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32690,6 +32691,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -32754,8 +32756,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "statuses": [ @@ -66845,6 +66846,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -66990,8 +66992,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -66999,6 +67000,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67191,8 +67193,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67200,6 +67201,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67322,8 +67324,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67331,6 +67332,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67468,8 +67470,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67477,6 +67478,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67613,8 +67615,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67622,6 +67623,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67818,8 +67820,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67827,6 +67828,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -67883,8 +67885,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 806ebc2769..5d52e7a5cf 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -18045,6 +18045,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18143,8 +18144,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18152,6 +18152,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}", "title": "Get a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18217,8 +18218,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18226,6 +18226,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", "title": "Rename a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18410,8 +18411,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18419,6 +18419,7 @@ "requestPath": "/repos/{owner}/{repo}/merges", "title": "Merge a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18615,8 +18616,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -28024,7 +28024,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." }, "parameters": { "owner": "OWNER", @@ -29004,6 +29005,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29115,8 +29117,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29124,6 +29125,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Check if a user is a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29184,8 +29186,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29193,6 +29194,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29409,8 +29411,7 @@ "description": "

    Validation failed

    " } ], - "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    ", - "subcategory": "collaborators" + "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    " }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29418,6 +29419,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29474,8 +29476,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29483,6 +29484,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29567,8 +29569,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -30351,6 +30352,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30559,8 +30561,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30568,6 +30569,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "title": "List branches for HEAD commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30642,8 +30644,7 @@ ], "previews": [ "

    Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the blog post for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.groot-preview+json
    " - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30651,6 +30652,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "title": "List pull requests associated with a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31249,8 +31251,7 @@ ], "previews": [ "

    Listing branches or pull requests for a commit in the Commits API is currently available for developers to preview. See the blog post for more details. To access the new endpoints during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.groot-preview+json
    " - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31258,6 +31259,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31441,8 +31443,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31450,6 +31451,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31794,8 +31796,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -32948,15 +32949,14 @@ } ] }, - "deploy_keys": { - "deploy_keys": [ + "deploy-keys": { + "deploy-keys": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", "title": "List deploy keys", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -33033,15 +33033,15 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", "title": "Create a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -33136,15 +33136,15 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Get a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -33215,15 +33215,15 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Delete a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -33280,7 +33280,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -33292,6 +33293,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33442,8 +33444,7 @@ ], "previews": [ "

    The inactive state and the log_url, environment_url, and auto_inactive parameters are currently available for developers to preview. Please see the blog post for full details.

    \n

    To access the API during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.ant-man-preview+json
    " - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33451,6 +33452,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33658,8 +33660,7 @@ ], "previews": [ "

    The inactive state and the log_url, environment_url, and auto_inactive parameters are currently available for developers to preview. Please see the blog post for full details.

    \n

    To access the API during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.ant-man-preview+json
    " - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33667,6 +33668,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33769,8 +33771,7 @@ "previews": [ "

    New features in the Deployments API on GitHub are currently available during a public beta. Please see the blog post for full details.

    \n

    To access the new environment parameter, the two new values for the state parameter (in_progress and queued), and use auto_inactive on production deployments during the public beta period, you must provide the following custom media type in the Accept header:

    \n
    application/vnd.github.flash-preview+json
    ", "

    The inactive state and the log_url, environment_url, and auto_inactive parameters are currently available for developers to preview. Please see the blog post for full details.

    \n

    To access the API during the preview period, you must provide a custom media type in the Accept header:

    \n
    application/vnd.github.ant-man-preview+json
    " - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33778,6 +33779,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33842,8 +33844,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -69303,6 +69304,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69448,8 +69450,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69457,6 +69458,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69649,8 +69651,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69658,6 +69659,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69780,8 +69782,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69789,6 +69790,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69926,8 +69928,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69935,6 +69936,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70071,8 +70073,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70080,6 +70081,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70276,8 +70278,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70285,6 +70286,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70341,8 +70343,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index ee1c4deb85..b2ccc747bb 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -18050,6 +18050,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18148,8 +18149,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18157,6 +18157,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}", "title": "Get a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18222,8 +18223,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18231,6 +18231,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", "title": "Rename a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18415,8 +18416,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18424,6 +18424,7 @@ "requestPath": "/repos/{owner}/{repo}/merge-upstream", "title": "Sync a fork branch with the upstream repository", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18498,8 +18499,7 @@ "httpStatusCode": "422", "description": "

    The branch could not be synced for some other reason

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18507,6 +18507,7 @@ "requestPath": "/repos/{owner}/{repo}/merges", "title": "Merge a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -18703,8 +18704,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -28178,7 +28178,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." }, "parameters": { "owner": "OWNER", @@ -29159,6 +29160,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29270,8 +29272,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29279,6 +29280,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Check if a user is a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29339,8 +29341,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29348,6 +29349,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29564,8 +29566,7 @@ "description": "

    Validation failed

    " } ], - "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    ", - "subcategory": "collaborators" + "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    " }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29573,6 +29574,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29629,8 +29631,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29638,6 +29639,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -29722,8 +29724,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -30506,6 +30507,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30714,8 +30716,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30723,6 +30724,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "title": "List branches for HEAD commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -30795,8 +30797,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30804,6 +30805,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "title": "List pull requests associated with a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31400,8 +31402,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31409,6 +31410,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31592,8 +31594,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31601,6 +31602,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -31945,8 +31947,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -33093,15 +33094,14 @@ } ] }, - "deploy_keys": { - "deploy_keys": [ + "deploy-keys": { + "deploy-keys": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", "title": "List deploy keys", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -33178,15 +33178,15 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", "title": "Create a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -33281,15 +33281,15 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Get a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -33360,15 +33360,15 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Delete a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -33425,7 +33425,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -33437,6 +33438,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33585,8 +33587,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33594,6 +33595,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33799,8 +33801,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33808,6 +33809,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33907,8 +33909,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33916,6 +33917,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -33980,8 +33982,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -69660,6 +69661,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -69805,8 +69807,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -69814,6 +69815,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70017,8 +70019,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70026,6 +70027,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", "title": "Generate release notes content for a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70125,8 +70127,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70134,6 +70135,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70256,8 +70258,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70265,6 +70266,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70402,8 +70404,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70411,6 +70412,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70547,8 +70549,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70556,6 +70557,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70752,8 +70754,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -70761,6 +70762,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -70817,8 +70819,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 7d261da00b..10338586dc 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -19156,6 +19156,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -19254,8 +19255,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19263,6 +19263,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}", "title": "Get a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -19328,8 +19329,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19337,6 +19337,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", "title": "Rename a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -19521,8 +19522,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19530,6 +19530,7 @@ "requestPath": "/repos/{owner}/{repo}/merge-upstream", "title": "Sync a fork branch with the upstream repository", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -19604,8 +19605,7 @@ "httpStatusCode": "422", "description": "

    The branch could not be synced for some other reason

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19613,6 +19613,7 @@ "requestPath": "/repos/{owner}/{repo}/merges", "title": "Merge a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -19809,8 +19810,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -29611,7 +29611,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." }, "parameters": { "owner": "OWNER", @@ -30595,6 +30596,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -30706,8 +30708,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30715,6 +30716,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Check if a user is a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -30775,8 +30777,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -30784,6 +30785,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -31000,8 +31002,7 @@ "description": "

    Validation failed

    " } ], - "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    ", - "subcategory": "collaborators" + "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    " }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31009,6 +31010,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -31065,8 +31067,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -31074,6 +31075,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -31158,8 +31160,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -31942,6 +31943,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -32150,8 +32152,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32159,6 +32160,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "title": "List branches for HEAD commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -32231,8 +32233,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32240,6 +32241,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "title": "List pull requests associated with a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -32836,8 +32838,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32845,6 +32846,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -33028,8 +33030,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -33037,6 +33038,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -33381,8 +33383,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -35689,15 +35690,14 @@ } ] }, - "deploy_keys": { - "deploy_keys": [ + "deploy-keys": { + "deploy-keys": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", "title": "List deploy keys", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -35774,15 +35774,15 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", "title": "Create a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -35877,15 +35877,15 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Get a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -35956,15 +35956,15 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Delete a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -36021,7 +36021,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -36033,6 +36034,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -36181,8 +36183,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -36190,6 +36191,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -36395,8 +36397,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -36404,6 +36405,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -36503,8 +36505,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -36512,6 +36513,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -36576,8 +36578,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -58066,14 +58067,14 @@ "subcategory": "orgs" } ], - "custom_roles": [ + "custom-roles": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", "requestPath": "/organizations/{organization_id}/custom_roles", "title": "List custom repository roles in an organization", "category": "orgs", - "subcategory": "custom_roles", + "subcategory": "custom-roles", "parameters": [ { "name": "organization_id", @@ -73977,6 +73978,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74122,8 +74124,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74131,6 +74132,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74334,8 +74336,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74343,6 +74344,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/generate-notes", "title": "Generate release notes content for a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74442,8 +74444,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74451,6 +74452,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74573,8 +74575,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74582,6 +74583,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74719,8 +74721,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74728,6 +74729,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -74864,8 +74866,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -74873,6 +74874,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -75069,8 +75071,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -75078,6 +75079,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -75134,8 +75136,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 84b8ecd187..b043a0ef5f 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -15261,6 +15261,7 @@ "requestPath": "/repos/{owner}/{repo}/branches", "title": "List branches", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -15359,8 +15360,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -15368,6 +15368,7 @@ "requestPath": "/repos/{owner}/{repo}/branches/{branch}", "title": "Get a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -15433,8 +15434,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -15442,6 +15442,7 @@ "requestPath": "/repos/{owner}/{repo}/merge-upstream", "title": "Sync a fork branch with the upstream repository", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -15516,8 +15517,7 @@ "httpStatusCode": "422", "description": "

    The branch could not be synced for some other reason

    " } - ], - "subcategory": "branches" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -15525,6 +15525,7 @@ "requestPath": "/repos/{owner}/{repo}/merges", "title": "Merge a branch", "category": "branches", + "subcategory": "branches", "parameters": [ { "name": "owner", @@ -15721,8 +15722,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "branches" + ] } ], "branch-protection": [ @@ -25475,7 +25475,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." }, "parameters": { "owner": "OWNER", @@ -26456,6 +26457,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators", "title": "List repository collaborators", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -26570,8 +26572,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -26579,6 +26580,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Check if a user is a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -26639,8 +26641,7 @@ "httpStatusCode": "404", "description": "

    Not Found if user is not a collaborator

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -26648,6 +26649,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Add a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -26864,8 +26866,7 @@ "description": "

    Validation failed

    " } ], - "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    ", - "subcategory": "collaborators" + "descriptionHTML": "

    This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

    \n

    Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

    \n

    For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

    \n
    Cannot assign {member} permission of {role name}\n
    \n

    Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

    \n

    The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.

    \n

    Rate limits

    \n

    You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

    " }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -26873,6 +26874,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "title": "Remove a repository collaborator", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -26929,8 +26931,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "collaborators" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -26938,6 +26939,7 @@ "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "title": "Get repository permissions for a user", "category": "collaborators", + "subcategory": "collaborators", "parameters": [ { "name": "owner", @@ -27023,8 +27025,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "collaborators" + ] } ], "invitations": [ @@ -27807,6 +27808,7 @@ "requestPath": "/repos/{owner}/{repo}/commits", "title": "List commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -28015,8 +28017,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -28024,6 +28025,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "title": "List branches for HEAD commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -28096,8 +28098,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -28105,6 +28106,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "title": "List pull requests associated with a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -28701,8 +28703,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -28710,6 +28711,7 @@ "requestPath": "/repos/{owner}/{repo}/commits/{ref}", "title": "Get a commit", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -28893,8 +28895,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -28902,6 +28903,7 @@ "requestPath": "/repos/{owner}/{repo}/compare/{basehead}", "title": "Compare two commits", "category": "commits", + "subcategory": "commits", "parameters": [ { "name": "owner", @@ -29246,8 +29248,7 @@ "httpStatusCode": "500", "description": "

    Internal Error

    " } - ], - "subcategory": "commits" + ] } ], "comments": [ @@ -30394,15 +30395,14 @@ } ] }, - "deploy_keys": { - "deploy_keys": [ + "deploy-keys": { + "deploy-keys": [ { "serverUrl": "https://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys", "title": "List deploy keys", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -30479,15 +30479,15 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "https://HOSTNAME/api/v3", "verb": "post", "requestPath": "/repos/{owner}/{repo}/keys", "title": "Create a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -30582,15 +30582,15 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "https://HOSTNAME/api/v3", "verb": "get", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Get a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -30661,15 +30661,15 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ] + ], + "subcategory": "deploy-keys" }, { "serverUrl": "https://HOSTNAME/api/v3", "verb": "delete", "requestPath": "/repos/{owner}/{repo}/keys/{key_id}", "title": "Delete a deploy key", - "category": "deploy_keys", - "subcategory": "deploy_keys", + "category": "deploy-keys", "parameters": [ { "name": "owner", @@ -30726,7 +30726,8 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ] + ], + "subcategory": "deploy-keys" } ] }, @@ -30738,6 +30739,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "List deployments", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -30886,8 +30888,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -30895,6 +30896,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments", "title": "Create a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -31100,8 +31102,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -31109,6 +31110,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Get a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -31208,8 +31210,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "deployments" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -31217,6 +31218,7 @@ "requestPath": "/repos/{owner}/{repo}/deployments/{deployment_id}", "title": "Delete a deployment", "category": "deployments", + "subcategory": "deployments", "parameters": [ { "name": "owner", @@ -31281,8 +31283,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "deployments" + ] } ], "environments": [ @@ -64579,6 +64580,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "List releases", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -64724,8 +64726,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -64733,6 +64734,7 @@ "requestPath": "/repos/{owner}/{repo}/releases", "title": "Create a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -64925,8 +64927,7 @@ "httpStatusCode": "422", "description": "

    Validation failed

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -64934,6 +64935,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/latest", "title": "Get the latest release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65056,8 +65058,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -65065,6 +65066,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/tags/{tag}", "title": "Get a release by tag name", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65202,8 +65204,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -65211,6 +65212,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Get a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65347,8 +65349,7 @@ "httpStatusCode": "404", "description": "

    Resource not found

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -65356,6 +65357,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Update a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65552,8 +65554,7 @@ "httpStatusCode": "200", "description": "

    OK

    " } - ], - "subcategory": "releases" + ] }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -65561,6 +65562,7 @@ "requestPath": "/repos/{owner}/{repo}/releases/{release_id}", "title": "Delete a release", "category": "releases", + "subcategory": "releases", "parameters": [ { "name": "owner", @@ -65617,8 +65619,7 @@ "httpStatusCode": "204", "description": "

    No Content

    " } - ], - "subcategory": "releases" + ] } ], "assets": [ diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index d8a15d59f3..653d901bd4 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -230590,6 +230590,14 @@ "won't fix", "used in tests" ] + }, + "dismissed_note": { + "type": [ + "string", + "null" + ], + "description": "The dismissal note associated with the dismissal of the alert.", + "maxLength": 280 } }, "required": [ @@ -230600,7 +230608,8 @@ "default": { "value": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." } } } diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index c9e66dfc15..1160c15dca 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -186897,7 +186897,8 @@ "default": { "value": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." } } } diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index d47bce555e..cba9879d70 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -191294,7 +191294,8 @@ "default": { "value": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." } } } diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 8803590e53..1824703a44 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -194856,7 +194856,8 @@ "default": { "value": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." } } } diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 04d842f4c7..8dc95facfc 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -210644,7 +210644,8 @@ "default": { "value": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." } } } diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 5068a8bfc5..2d90019686 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -175278,7 +175278,8 @@ "default": { "value": { "state": "dismissed", - "dismissed_reason": "false positive" + "dismissed_reason": "false positive", + "dismissed_note": "This alert is not actually correct, because there's a sanitizer included in the library." } } } diff --git a/lib/search/indexes/github-docs-3.1-cn-records.json.br b/lib/search/indexes/github-docs-3.1-cn-records.json.br index 28c2f4e3c5..26f7196eac 100644 --- a/lib/search/indexes/github-docs-3.1-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.1-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6310130a05e63f0269dcb42957cc45b945c63addfefbf9f437113bfea7ee38f6 -size 665189 +oid sha256:393163d5c3dd8e735c533b6738992fefe9332ca23383a9fc8b362cbdf4c22fd0 +size 665578 diff --git a/lib/search/indexes/github-docs-3.1-cn.json.br b/lib/search/indexes/github-docs-3.1-cn.json.br index e2bcf53dc5..624322707b 100644 --- a/lib/search/indexes/github-docs-3.1-cn.json.br +++ b/lib/search/indexes/github-docs-3.1-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f95ed18bc12de82b1e266296e2d0c3bb8424df20c5f15a76e3d28ca3abc3bf6b -size 1327576 +oid sha256:1b85e62de5e7ed22b3da68fe4e14ad5f3d3ff78534819ba698200bcee60f72ea +size 1325711 diff --git a/lib/search/indexes/github-docs-3.1-en-records.json.br b/lib/search/indexes/github-docs-3.1-en-records.json.br index 28425e7562..7698c8b5e4 100644 --- a/lib/search/indexes/github-docs-3.1-en-records.json.br +++ b/lib/search/indexes/github-docs-3.1-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:43c15d6bc7f8a67cb50cc5690218d4db42f4995d9be2bb51d791c7571e8cc604 -size 894289 +oid sha256:08bf4181b78e90395b21c1f843ef7050d0705b7512682709a611b62f558dd96e +size 895997 diff --git a/lib/search/indexes/github-docs-3.1-en.json.br b/lib/search/indexes/github-docs-3.1-en.json.br index 42f2675a02..2b06c267b4 100644 --- a/lib/search/indexes/github-docs-3.1-en.json.br +++ b/lib/search/indexes/github-docs-3.1-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c3d1ae5b7391473d8e9c3a97b7c1d4a9e9ae1b8a06ba811da4f430fd9fc148bc -size 3434807 +oid sha256:5966da0b46793d872232312714c9e126fd94f76ac08f1ddce4137ec668e4939c +size 3444146 diff --git a/lib/search/indexes/github-docs-3.1-es-records.json.br b/lib/search/indexes/github-docs-3.1-es-records.json.br index 53745f1b3e..fb447a447a 100644 --- a/lib/search/indexes/github-docs-3.1-es-records.json.br +++ b/lib/search/indexes/github-docs-3.1-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5bb189600ed8c2c445d63eb78c8ac188ef3accacb7f1d0c0b358cbe5fb06f1dd -size 611827 +oid sha256:b0e9860624e1b6108c4dcf30bedd47152a31270b2ac094c1bd4a8da86e224d0e +size 612605 diff --git a/lib/search/indexes/github-docs-3.1-es.json.br b/lib/search/indexes/github-docs-3.1-es.json.br index 4821564100..a0be875cf0 100644 --- a/lib/search/indexes/github-docs-3.1-es.json.br +++ b/lib/search/indexes/github-docs-3.1-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:953850104b813a36c6a00cd3ca0d3112118da810592e7871f01e372ac7a719b6 -size 2586156 +oid sha256:54ae90570224329c8d9c903eaa34c7b479c6954521cc91773e51577395379206 +size 2585690 diff --git a/lib/search/indexes/github-docs-3.1-ja-records.json.br b/lib/search/indexes/github-docs-3.1-ja-records.json.br index 8768ede286..5d70d6909d 100644 --- a/lib/search/indexes/github-docs-3.1-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.1-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4cd86fe72520e1128aea659fd100dd5fd82fbbdb0f048b976fc943c3c585ce15 -size 675907 +oid sha256:399edc0f52624b177810cd071cce69506471d56d6904754fde65c77c26ab8695 +size 676804 diff --git a/lib/search/indexes/github-docs-3.1-ja.json.br b/lib/search/indexes/github-docs-3.1-ja.json.br index dc44cfeb28..23d0c3ed3f 100644 --- a/lib/search/indexes/github-docs-3.1-ja.json.br +++ b/lib/search/indexes/github-docs-3.1-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3fad726cb4d6105908841d9fb3b65f4fe694c50b4004f9202536452841ce1952 -size 3606625 +oid sha256:e04a7a31048ecb97c96aa35a7ae752727588284976ff4150478e2118dd91b215 +size 3607019 diff --git a/lib/search/indexes/github-docs-3.1-pt-records.json.br b/lib/search/indexes/github-docs-3.1-pt-records.json.br index b2965d620b..ba19145722 100644 --- a/lib/search/indexes/github-docs-3.1-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.1-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ea530586aefec5d0678f7528ca441d3e855ec24aa403bc847dae93df44c80bc0 -size 604172 +oid sha256:54d1eba597f772cb2ef9a41a09b0858016c28a0ba892e9224641ef07edfbbd5a +size 604079 diff --git a/lib/search/indexes/github-docs-3.1-pt.json.br b/lib/search/indexes/github-docs-3.1-pt.json.br index 6914aff5b4..4f88a4cde6 100644 --- a/lib/search/indexes/github-docs-3.1-pt.json.br +++ b/lib/search/indexes/github-docs-3.1-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3c7651c93ca43d06b4d2d97ee74f1650f8208e1214fa9e3284f8b76243ee0057 -size 2484007 +oid sha256:d39eaa3920ec0490b64482984159ef27bcb627ac60fce382d9a92044829fa43e +size 2477645 diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br index fe537f9847..f8fbbad903 100644 --- a/lib/search/indexes/github-docs-3.2-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:618f4b878ee7812e6644e4a8541be3c666ede90c4cdb88437b3424f5d6092fc5 -size 683166 +oid sha256:a7b8472bf6bc02fcd593a0015f202969dd0d79856720b0df63b6584e3fc59fb1 +size 683209 diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br index 7282f431e9..3f98dcbd22 100644 --- a/lib/search/indexes/github-docs-3.2-cn.json.br +++ b/lib/search/indexes/github-docs-3.2-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:46c651beebd2c93bb2e29552d2df1cb1129eeaa2e23d9245ef156ce19346e781 -size 1357018 +oid sha256:0fe7a550fd784fe8851ff4c2728180e3e8ed8f3273d4bdcc3930a9204f9bdf41 +size 1355738 diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br index 365937d926..6311cbbbf0 100644 --- a/lib/search/indexes/github-docs-3.2-en-records.json.br +++ b/lib/search/indexes/github-docs-3.2-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e997061f60c4b9b1281ea6cff95c078fd6427293fa1eec7bf112f615ccd8e61d -size 922906 +oid sha256:94289d9e2ff63793d5213ac13c701797c0e5c3c4f654304d4aed4a73397f33b8 +size 925495 diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br index 804de0966b..59a998a659 100644 --- a/lib/search/indexes/github-docs-3.2-en.json.br +++ b/lib/search/indexes/github-docs-3.2-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f6c822cbacba62aad4b08aaa53acd1320d592d36d377f7dbfe9d4de7049cfebc -size 3554014 +oid sha256:55994effb5addc65d78e6cfb2a05a31855697c4ce5ba24701be5c8b0d60c7379 +size 3561373 diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br index da0e7f8a5f..271e899224 100644 --- a/lib/search/indexes/github-docs-3.2-es-records.json.br +++ b/lib/search/indexes/github-docs-3.2-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:09c67946589fe273c215bc4528a1ddee4feb9e88661b383e0f078061f9b84726 -size 628730 +oid sha256:24005a86c8f57e8f261fa76a7f96585d4e61575171ac6c6cb1ba59e4f4e99ee3 +size 629185 diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br index 01a4af2d6d..6bf4436a4d 100644 --- a/lib/search/indexes/github-docs-3.2-es.json.br +++ b/lib/search/indexes/github-docs-3.2-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1bf30cfc0fd1b0ed29d1c5d5d0ee9b9333259ab493a5c66d8bf9f87728a9c960 -size 2658162 +oid sha256:d8b6057f6a3c6bab27b87844a5b8d92203bc8c66a228c4ddb88bd0ad8c4fa990 +size 2657202 diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br index 8cc95ddf56..ddcf749d12 100644 --- a/lib/search/indexes/github-docs-3.2-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:27c545878b628f89822f2b03ba1c6a4f25c1ea85ac30d56764d66cc48bd68cff -size 694109 +oid sha256:d86fe5c02ec474c0e592dc64befab0be0351d237deec9b856a819b68c4b745aa +size 694375 diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br index f2147521ac..bba5c16946 100644 --- a/lib/search/indexes/github-docs-3.2-ja.json.br +++ b/lib/search/indexes/github-docs-3.2-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bbb5d9e7a3c8abc1d3d760bd5886047ee0dc33ed659085a6dae24f61debac4fb -size 3703203 +oid sha256:0863c7b531d90815bbfb55915e608b26d51bb05941ffa03f6a102dfb1b95f98f +size 3702535 diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br index 881d232446..45b34f36ba 100644 --- a/lib/search/indexes/github-docs-3.2-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:086b196cd2b8fc775db514269c2f3f86355343f91c9a3a01c53e6c06a67d900f -size 620102 +oid sha256:4095e5b597a26fc5ad96c5ca150bc5cb8c4ef47e0260c622863aa5e689f2d254 +size 620933 diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br index 591936ba1b..9592b0f9dd 100644 --- a/lib/search/indexes/github-docs-3.2-pt.json.br +++ b/lib/search/indexes/github-docs-3.2-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1951b0fed1f7c926deec9175f996681707737e12949ac48fda24db0494db05ca -size 2549280 +oid sha256:8889a9c7eeaaded10a8ad930d6d87ed26a44ddf23caf6accb38dec9091b87dd5 +size 2541995 diff --git a/lib/search/indexes/github-docs-3.3-cn-records.json.br b/lib/search/indexes/github-docs-3.3-cn-records.json.br index c1fe03f4c3..9109dc9d5d 100644 --- a/lib/search/indexes/github-docs-3.3-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.3-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:70f85ad3107974495e91016301d84776e71b63dd93d3d0468286ffc3a9b39ee4 -size 706587 +oid sha256:a679213cfbdb2c8a0c6b1dc9c5708bf35b3214f281074f4f97d449aff478f451 +size 705912 diff --git a/lib/search/indexes/github-docs-3.3-cn.json.br b/lib/search/indexes/github-docs-3.3-cn.json.br index 99e7f6be2d..9529922661 100644 --- a/lib/search/indexes/github-docs-3.3-cn.json.br +++ b/lib/search/indexes/github-docs-3.3-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b2e574069fe485166aabab1b9532a938ca74493b3eafe5c45a34dd56f29c0501 -size 1407280 +oid sha256:2e788ea0acc195473d2e3f2166d50ef3759be3fd7af91d8c7308f3e9254ad29a +size 1405106 diff --git a/lib/search/indexes/github-docs-3.3-en-records.json.br b/lib/search/indexes/github-docs-3.3-en-records.json.br index a997c26169..2738a3a605 100644 --- a/lib/search/indexes/github-docs-3.3-en-records.json.br +++ b/lib/search/indexes/github-docs-3.3-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bb33c87ce5d7a41cdcc2a59cfdc7dc06261f540a734f8077bb65e90d381abf23 -size 957891 +oid sha256:5b921e92db3568f4c12314a95ec5df16e8782b463ab87e11210e233e65058104 +size 959823 diff --git a/lib/search/indexes/github-docs-3.3-en.json.br b/lib/search/indexes/github-docs-3.3-en.json.br index f7404cabb1..678a37a060 100644 --- a/lib/search/indexes/github-docs-3.3-en.json.br +++ b/lib/search/indexes/github-docs-3.3-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:10b20724dc11ecfb2d31cab0e891ab314c38875b9d39858444632f9681c73853 -size 3672090 +oid sha256:3678ea7cdbb116b37087d284489c83eaf773bac59180b945bd88b290da572a43 +size 3680932 diff --git a/lib/search/indexes/github-docs-3.3-es-records.json.br b/lib/search/indexes/github-docs-3.3-es-records.json.br index 27c291b3ce..6c2ba3f3c1 100644 --- a/lib/search/indexes/github-docs-3.3-es-records.json.br +++ b/lib/search/indexes/github-docs-3.3-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e96899b4e6178f779417f5afacce299eba5b5c4b41ad1861ca2dc0509df4f930 -size 648596 +oid sha256:7835b25ad13f95d0940b377caca0f1633f22728635df68a72b858c6393a54720 +size 648653 diff --git a/lib/search/indexes/github-docs-3.3-es.json.br b/lib/search/indexes/github-docs-3.3-es.json.br index 435ccfc336..39a6ad10dc 100644 --- a/lib/search/indexes/github-docs-3.3-es.json.br +++ b/lib/search/indexes/github-docs-3.3-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:31b8b59ad923a4e9a6567b141923fa6e9aa42a65639b6f82f5219880b194b7c3 -size 2745554 +oid sha256:4ec8a2e4fd346e642e238fbbb5d1819741895f38db15d7c9394a3f16a6f91354 +size 2745259 diff --git a/lib/search/indexes/github-docs-3.3-ja-records.json.br b/lib/search/indexes/github-docs-3.3-ja-records.json.br index 7a3e6ba25d..630a744d1a 100644 --- a/lib/search/indexes/github-docs-3.3-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.3-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1fb800f192b1a748612c61b2ab3b4c4a09ff61e7259b25e6353c6e8672f09b55 -size 717747 +oid sha256:2aef5ced63078257ce0c88879f34682f573a97718ba10cdad7f9c03eddad630e +size 717885 diff --git a/lib/search/indexes/github-docs-3.3-ja.json.br b/lib/search/indexes/github-docs-3.3-ja.json.br index 0fe06814aa..1b0dc8f726 100644 --- a/lib/search/indexes/github-docs-3.3-ja.json.br +++ b/lib/search/indexes/github-docs-3.3-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1e0952fa719bbee7de1d25878e6b1777aa109e6ff8eae69d8682a1ca44dfa02c -size 3829621 +oid sha256:6b91ea84a1b92360939e5c17eb07c861748279e0a3b9ba9c4994ae97c653c83d +size 3828770 diff --git a/lib/search/indexes/github-docs-3.3-pt-records.json.br b/lib/search/indexes/github-docs-3.3-pt-records.json.br index 8cf711db87..8c5ec45915 100644 --- a/lib/search/indexes/github-docs-3.3-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.3-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:971340d439cd84da0bf9cd16f9a7914053e7270996ee9585c03272965f0a3968 -size 640004 +oid sha256:fa78a5dc365b2b41145d35e6bfd69398d4de1f22fb6f45bf3ac4e349cb07f20b +size 640286 diff --git a/lib/search/indexes/github-docs-3.3-pt.json.br b/lib/search/indexes/github-docs-3.3-pt.json.br index e11cbff2ce..bd88228cd3 100644 --- a/lib/search/indexes/github-docs-3.3-pt.json.br +++ b/lib/search/indexes/github-docs-3.3-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3651362ec23677d03b5616ec58e01ea7dfd26a83c0d08fadc39363b8c84b52bd -size 2628735 +oid sha256:889f4eeab0f2d79a3a82da12105ae62cad8f0ac3b35caa2836ae63b3064919f8 +size 2622932 diff --git a/lib/search/indexes/github-docs-3.4-cn-records.json.br b/lib/search/indexes/github-docs-3.4-cn-records.json.br index 4b6efe2fb7..3b2baed7ad 100644 --- a/lib/search/indexes/github-docs-3.4-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.4-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:78c0d8dc9cee97c3a59f7d0d88a5fc1680739aa3e56ee3aade38f0a88b41a683 -size 710339 +oid sha256:91dc2d1876529803a0a6f70bdb74991ba492ba869b818b536ed78d047f7e7774 +size 705437 diff --git a/lib/search/indexes/github-docs-3.4-cn.json.br b/lib/search/indexes/github-docs-3.4-cn.json.br index 59660473d8..d322b81cd5 100644 --- a/lib/search/indexes/github-docs-3.4-cn.json.br +++ b/lib/search/indexes/github-docs-3.4-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e6e79f0f4e5f06b4d6b3c15ef630d973f698035a95b8ee81fd3b82f02462a6cd -size 1414696 +oid sha256:e6fea2dd7f34a02442ebd66632bdf59cc035075faa2ef54ce2186af8399ae1a8 +size 1406101 diff --git a/lib/search/indexes/github-docs-3.4-en-records.json.br b/lib/search/indexes/github-docs-3.4-en-records.json.br index a8d60c9e98..5004c7c16e 100644 --- a/lib/search/indexes/github-docs-3.4-en-records.json.br +++ b/lib/search/indexes/github-docs-3.4-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:056048d2f9a3654e94a76a711d7e42e6b30e1277546395b4b2fdea449b2010f9 -size 967633 +oid sha256:7b87286b9163375c507dba07073ad6cc390da0d93a9aefd6ecf72f38dc14ee8f +size 965188 diff --git a/lib/search/indexes/github-docs-3.4-en.json.br b/lib/search/indexes/github-docs-3.4-en.json.br index 07fd3f7c75..43e4279a83 100644 --- a/lib/search/indexes/github-docs-3.4-en.json.br +++ b/lib/search/indexes/github-docs-3.4-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4a48440f710d712429102b9acdeeea26dcfcfd1367be4a619a824994eeff2c49 -size 3711388 +oid sha256:1d2bf14a5587090a8f4699eab20e3cab049974cbbb08d4e764f28a1c95841f10 +size 3694523 diff --git a/lib/search/indexes/github-docs-3.4-es-records.json.br b/lib/search/indexes/github-docs-3.4-es-records.json.br index 6d3256ad1d..792defe1d4 100644 --- a/lib/search/indexes/github-docs-3.4-es-records.json.br +++ b/lib/search/indexes/github-docs-3.4-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f94e78e6eca948135dfff3bf8cb9a1ce5da0541c3422f580235622522ef231e1 -size 653156 +oid sha256:84a0d08240766417aac8eb384450ed2b68f7a3f21712b6fbbf120db765ea11d9 +size 650755 diff --git a/lib/search/indexes/github-docs-3.4-es.json.br b/lib/search/indexes/github-docs-3.4-es.json.br index 3d54ccd5af..c1a60aa636 100644 --- a/lib/search/indexes/github-docs-3.4-es.json.br +++ b/lib/search/indexes/github-docs-3.4-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8d049083c2f3449d80c371e70941c6ad69458415cfdd4987505b686762e4d9dd -size 2762587 +oid sha256:a2d27f304e501b9be3f64f4a5c48b3d16b0d3cd051ceff361959d27b831d8354 +size 2749539 diff --git a/lib/search/indexes/github-docs-3.4-ja-records.json.br b/lib/search/indexes/github-docs-3.4-ja-records.json.br index 877f026802..92710f1fb6 100644 --- a/lib/search/indexes/github-docs-3.4-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.4-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5822c9542f7f4dbfed99c4cda5ca30d3b857ca856ffcd67d59c943f9f406aa26 -size 720694 +oid sha256:6cc5f59919b1d64dc36211cc1c308a90ddedb831fa16abf216a0990be2346d9f +size 718514 diff --git a/lib/search/indexes/github-docs-3.4-ja.json.br b/lib/search/indexes/github-docs-3.4-ja.json.br index a7e285f084..123a5e93d3 100644 --- a/lib/search/indexes/github-docs-3.4-ja.json.br +++ b/lib/search/indexes/github-docs-3.4-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0cb46e742026c6a3ff426dcb5c2e99cf3f9a417ece0a07c13ab1df02ea0df6c0 -size 3849805 +oid sha256:94e281347c058946ff98083852404d2d9d1ae93ac5f18ef4b5078b3ea9d93997 +size 3836483 diff --git a/lib/search/indexes/github-docs-3.4-pt-records.json.br b/lib/search/indexes/github-docs-3.4-pt-records.json.br index b0290c4013..4498478875 100644 --- a/lib/search/indexes/github-docs-3.4-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.4-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f1e43bb24872c9c1361f0ef54333e8e8588d7986e3bdaf0edb9ef1313b7ff33d -size 642468 +oid sha256:eebda09535a588e32f0c06b05e85ae270d1ffc1a2ec8ae56a954d212a339dbe0 +size 641449 diff --git a/lib/search/indexes/github-docs-3.4-pt.json.br b/lib/search/indexes/github-docs-3.4-pt.json.br index 5c465dde72..ca42c33495 100644 --- a/lib/search/indexes/github-docs-3.4-pt.json.br +++ b/lib/search/indexes/github-docs-3.4-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c60bca8d94b0f160147722360da80a81a372b1651a959069268b551898a5c225 -size 2645961 +oid sha256:3b104dc792270dfad6f52f0c58c859c51c53ab9bddf91297d38a6f4906f32e72 +size 2628196 diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br index 32fda2617f..870cc6b533 100644 --- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c2b56a19dcaed303f4a9624ae68aae1334c8130af561562042b226d502a5795e -size 913558 +oid sha256:b777a3bbb08a13549f180eeb3477128278e6aeff1cbceb084339b64133670bff +size 908431 diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br index ed900ea071..6e548f00e3 100644 --- a/lib/search/indexes/github-docs-dotcom-cn.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:28f6bc6a62fcbd3d8652c5504586ac358ac8418dc28b78e62e4cee74d03c2d4e -size 1489724 +oid sha256:30b529cc333ae7ff1f16f240dd480bb8b88ab766c710dae440d97f5eb08becaa +size 1480005 diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br index 5a1121bf00..75d9a216ef 100644 --- a/lib/search/indexes/github-docs-dotcom-en-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6f6baa0ae36babfca975125f576b26e5269c73cb450709447ffe3a831b7ad85e -size 1232399 +oid sha256:9f00a6d469d5481359aed8ee508fdf4040f93ef7442133d2f305ec26fdc293c4 +size 1228066 diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br index bc54965eb0..80e219ad1c 100644 --- a/lib/search/indexes/github-docs-dotcom-en.json.br +++ b/lib/search/indexes/github-docs-dotcom-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:afe1361526a351abc65592f49401b4f31ae778dd36564dd254741b8fe866476d -size 4437475 +oid sha256:db5708af3b79ba1fa33bf4b36ef5b2208ca4f3eb49d7c2e90046fcbb6607b6b3 +size 4423217 diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br index 96d2a64bd5..b9fe829461 100644 --- a/lib/search/indexes/github-docs-dotcom-es-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d6e4fe61bf82e3321ee221a9732632130c7d7c591e8983752741c800345a284c -size 822402 +oid sha256:2ffa1df0f5c92637000738ff51b5294254e04a99d41ebdcbc7d4005dbb4cb514 +size 818791 diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br index f6a5c726b5..d3932effe1 100644 --- a/lib/search/indexes/github-docs-dotcom-es.json.br +++ b/lib/search/indexes/github-docs-dotcom-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:79643d4d6b0dfb1e8563efafeb77a34249e5b50513dcacb4c81e488be112542f -size 3318574 +oid sha256:af29a76d7b63175f752474f0600967ae188c1acfd1260cb6aa13059c2606546b +size 3304404 diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br index dc84a4760d..1bfc36c905 100644 --- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:75b99dc136cdc007d2f791ceab50d66643fd063f6c16d285099092b6813afe84 -size 921084 +oid sha256:fb4e77d6f863dd9bf58e36e39ce77faa8e4894bc32ede5a9a2375a67deec05d4 +size 915869 diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br index 4da67f721a..c30c0ab8b1 100644 --- a/lib/search/indexes/github-docs-dotcom-ja.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d8085eb05df8958349c359ff4faf607c4890e3abc8c43de8c82f32b143ca54da -size 4696253 +oid sha256:505a3665b6aa4628ddce2b699f5146c31b446d503fc1a3e9a97f0fb6741c2a22 +size 4668700 diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br index c94de74ccd..8e95a8a6f4 100644 --- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:57f8b7c234a8e347ee8b5dcb55a86d490fae75a71b52ce5bbdbad9eaf564069e -size 811487 +oid sha256:0713a66b5f4517da3d9b397d954adf93ba29a2e3b5d99c7bdc420cb1fe39cfce +size 806498 diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br index aa2c402df3..5a0f9ce7fe 100644 --- a/lib/search/indexes/github-docs-dotcom-pt.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e088e74ae69dca731348e983affa89c94ef2c6a86e7d3cf11b3b184a4ae7d0ff -size 3185163 +oid sha256:c9d832984e3bea99b09ade30c3cf4f3a251f775f91f9dbf83c2fe332aea0d4f0 +size 3154798 diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br index 778898abbb..04158435e4 100644 --- a/lib/search/indexes/github-docs-ghae-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ad1039e8805db19b80e8510087e34b093cce2fe6bc69e1a8cf8f059da63653cd -size 539831 +oid sha256:16736b615130e6ba2b97dc8d33a39e5646996f98538b82bec6a8060c7fddec26 +size 536474 diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br index ce7818c3bf..6e84e00993 100644 --- a/lib/search/indexes/github-docs-ghae-cn.json.br +++ b/lib/search/indexes/github-docs-ghae-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e3c39d529686143dee0694c5a0f22f9a0065887f7c4dbf9365c21007d14ba0b1 -size 1004003 +oid sha256:5d9fa8878794b8a211c108831353d6e7ce126a6459c81a25dd9ed7a528c11ce3 +size 1000201 diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br index e82dab49d2..a372a7a891 100644 --- a/lib/search/indexes/github-docs-ghae-en-records.json.br +++ b/lib/search/indexes/github-docs-ghae-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e8c07ad8aafc55de76fb195badc038c24349173852426bffd76af6e307a70370 -size 748439 +oid sha256:02df8b6dc99c047aa12d57d657e96fb5e15ece2e440a8947a10551a5f7cd4c85 +size 745058 diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br index ab8fbdbd7c..a4bce65e39 100644 --- a/lib/search/indexes/github-docs-ghae-en.json.br +++ b/lib/search/indexes/github-docs-ghae-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e32a2a9812ee916d11126468e1d8a47b82297285d181b0961fd541b098f36f32 -size 2828693 +oid sha256:e199d4b555fe393160e94909ac57ed97fdbc3e5e3047b8657d5b0efb380858d8 +size 2814830 diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br index a74950ff76..5ceeb5e692 100644 --- a/lib/search/indexes/github-docs-ghae-es-records.json.br +++ b/lib/search/indexes/github-docs-ghae-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:99b0628033b75a1480a7679b5c632da146023fbb7a3d21c6e7368bb59257c708 -size 499417 +oid sha256:8673d72d0b63a577447c378a64ee375c3c959565f3edc6d408314c38e1dbd9d4 +size 496576 diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br index 626a0a30c3..8e902daada 100644 --- a/lib/search/indexes/github-docs-ghae-es.json.br +++ b/lib/search/indexes/github-docs-ghae-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a0887aa1a8400e64b5f002291a8d045f59ba2560ebe29910b6215bdca18cb494 -size 2021918 +oid sha256:399c3d7168ab38a360616b30b923d10b88846094c0b56f6479359c05ce510e6b +size 2010567 diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br index 520ec8700d..d880a605e6 100644 --- a/lib/search/indexes/github-docs-ghae-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c187c50196522f87332c80faf400d1ca41cbd74c7b665d04117009df4d1861b0 -size 550267 +oid sha256:08711dfc2f20de89201161a68a6bb8f517aeb7d54b8b0d0f2afaee74774275c7 +size 548378 diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br index 967494c175..631d4d768a 100644 --- a/lib/search/indexes/github-docs-ghae-ja.json.br +++ b/lib/search/indexes/github-docs-ghae-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2397e53c8f2abdc0573c1d17585cb4408399e41caad4e64dfe4162f3e1f0bfcf -size 2805163 +oid sha256:1f88d5e0adf47db2c3dfe5a66b4c3cd8fcb970736515a3c330685083b3cb1877 +size 2793979 diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br index 2368a1c34e..9c6c540d7c 100644 --- a/lib/search/indexes/github-docs-ghae-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0135f4f4eade59d0472783f07f1038c3d29e27ef087f3bc99db27406a693ed47 -size 492268 +oid sha256:7c1ae98051d6ddf1487a3799ccd2acc62c79d8bd6e9ef61fd3891ea785ecc79b +size 489784 diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br index d510d16389..ea8b20988b 100644 --- a/lib/search/indexes/github-docs-ghae-pt.json.br +++ b/lib/search/indexes/github-docs-ghae-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4384a8522da6a7d238c34ed871fabd200a41c0820f16fe6e6edc57678c570c71 -size 1923027 +oid sha256:0712093327dd56851f51935139570e413ed30c247b40478369acb7f050c5741c +size 1910075 diff --git a/lib/search/indexes/github-docs-ghec-cn-records.json.br b/lib/search/indexes/github-docs-ghec-cn-records.json.br index 9370295ba7..770ad047a5 100644 --- a/lib/search/indexes/github-docs-ghec-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghec-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4ec629aa723b40c9b1c1a4cb0eb246abce4801ea07588d6644287d073ff3d0e0 -size 856732 +oid sha256:b3dfe1d92347869c7e78b25b11ee0b6bd6b1e73d050bea90fb09053e6c126745 +size 852766 diff --git a/lib/search/indexes/github-docs-ghec-cn.json.br b/lib/search/indexes/github-docs-ghec-cn.json.br index 1da75a818a..c4828cad2f 100644 --- a/lib/search/indexes/github-docs-ghec-cn.json.br +++ b/lib/search/indexes/github-docs-ghec-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9baa65c19ff765633ca5eeafe047ba4c3df7e284f37810b270f3f949774a8c44 -size 1590069 +oid sha256:5393a3613671849fab25fc78359690b84eb3736cca84d224873bab2079d55883 +size 1583270 diff --git a/lib/search/indexes/github-docs-ghec-en-records.json.br b/lib/search/indexes/github-docs-ghec-en-records.json.br index 5aec25e384..4af87b9f75 100644 --- a/lib/search/indexes/github-docs-ghec-en-records.json.br +++ b/lib/search/indexes/github-docs-ghec-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:15fbcc53a435d7e5d1d6cccfd5d4870e8b890ebac8fcea646e4aafddf229a75b -size 1138730 +oid sha256:19c4edadc053b6a530f74277120a2e47c9f90c19b8face838441a792ab54e54c +size 1134417 diff --git a/lib/search/indexes/github-docs-ghec-en.json.br b/lib/search/indexes/github-docs-ghec-en.json.br index 296d0a772d..4cc1bcc0ee 100644 --- a/lib/search/indexes/github-docs-ghec-en.json.br +++ b/lib/search/indexes/github-docs-ghec-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7319e66b7fe0c74d67784d208cc02d6ab4cc6e14f993db6d6527499cc6187f49 -size 4334041 +oid sha256:78d4190b0980c0bfff8aa0202417cea36c5d2bb5de3b6b311f52a35aceaf3f37 +size 4322192 diff --git a/lib/search/indexes/github-docs-ghec-es-records.json.br b/lib/search/indexes/github-docs-ghec-es-records.json.br index cbc275ae02..027914bb35 100644 --- a/lib/search/indexes/github-docs-ghec-es-records.json.br +++ b/lib/search/indexes/github-docs-ghec-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e9b24d14567f839f598782590300c64f3b9be664f4d85ef6b8c6df692ec196d6 -size 791791 +oid sha256:0c0cc1e643effcc1c3260d8dbd157eeaf3c6fae7f4ee50cb873975a5ca12fe35 +size 788672 diff --git a/lib/search/indexes/github-docs-ghec-es.json.br b/lib/search/indexes/github-docs-ghec-es.json.br index 12e065b0ca..3002b7fa70 100644 --- a/lib/search/indexes/github-docs-ghec-es.json.br +++ b/lib/search/indexes/github-docs-ghec-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cc5339998f1a583c8e11eb793a4e8c5f28d296f0b80ace67d143e8f725b88e51 -size 3358456 +oid sha256:87d76d97a8d4da3393413a3e804b183a4efe066e4451f696f9c61eead4b62518 +size 3345152 diff --git a/lib/search/indexes/github-docs-ghec-ja-records.json.br b/lib/search/indexes/github-docs-ghec-ja-records.json.br index 860345cc56..41ff2ed03e 100644 --- a/lib/search/indexes/github-docs-ghec-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghec-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:12073913d7a87c911065ff4361eeabd1ef24286266e3769fd8684561475c2230 -size 867565 +oid sha256:9326a3f946cecf6cc794dd1a01ec65f22b55d28ca757518b7f4fd00c4ac8233f +size 865636 diff --git a/lib/search/indexes/github-docs-ghec-ja.json.br b/lib/search/indexes/github-docs-ghec-ja.json.br index 10bdd4c592..24c50ccf3a 100644 --- a/lib/search/indexes/github-docs-ghec-ja.json.br +++ b/lib/search/indexes/github-docs-ghec-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6a3ea727701376a03121b4daa90e2085e5afa9e0be98b0c5f5c52eed75e16955 -size 4651569 +oid sha256:2286480517599cda16c3f0bc2949d5cff2c0811ab7607d6dd7349af2864b234a +size 4635024 diff --git a/lib/search/indexes/github-docs-ghec-pt-records.json.br b/lib/search/indexes/github-docs-ghec-pt-records.json.br index f654603363..0fbefbe75b 100644 --- a/lib/search/indexes/github-docs-ghec-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghec-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c192c0dd2acabc7d9067542e4e4465ff50b5acc839604479940208216c893057 -size 781243 +oid sha256:807708f2986b20932a49739c22cbefc41c8c603311f0c756eb6b4a36e59a38bb +size 777826 diff --git a/lib/search/indexes/github-docs-ghec-pt.json.br b/lib/search/indexes/github-docs-ghec-pt.json.br index 5b8e49fde7..e7033590c7 100644 --- a/lib/search/indexes/github-docs-ghec-pt.json.br +++ b/lib/search/indexes/github-docs-ghec-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:697b57bb681d420732f95fda3a59e2c4569182429b2617f948eae9eadb86322a -size 3218749 +oid sha256:21004258f254d9747c86ef4cdc06c4ffc32edb63045d8b7983cbace9c2484606 +size 3194181 diff --git a/lib/webhooks/static/dotcom/pull_request_review_thread.resolved.payload.json b/lib/webhooks/static/dotcom/pull_request_review_thread.resolved.payload.json new file mode 100644 index 0000000000..09760b59ee --- /dev/null +++ b/lib/webhooks/static/dotcom/pull_request_review_thread.resolved.payload.json @@ -0,0 +1,542 @@ +{ + "action": "resolved", + "pull_request": { + "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118", + "id": 873298238, + "node_id": "PR_kwDOEL39TM40DXk-", + "html_url": "https://github.com/octo-org/octo-repo/pull/118", + "diff_url": "https://github.com/octo-org/octo-repo/pull/118.diff", + "patch_url": "https://github.com/octo-org/octo-repo/pull/118.patch", + "issue_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118", + "number": 118, + "state": "open", + "locked": false, + "title": "Create issue-comment", + "user": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "body": "Issue comment test", + "created_at": "2022-03-07T16:14:34Z", + "updated_at": "2022-03-21T09:21:38Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "c72e2aa60425a50d9785a50793dd6c22b9c5cce1", + "assignee": null, + "assignees": [], + "requested_reviewers": [], + "requested_teams": [], + "labels": [], + "milestone": null, + "draft": false, + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits", + "review_comments_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments", + "review_comment_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf", + "head": { + "label": "octo-org:issue-comment", + "ref": "issue-comment", + "sha": "14ae1f988d344e6b4f97f6153fb0287dcda335bf", + "user": { + "login": "octo-org", + "id": 67584941, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", + "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "repo": { + "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octo-org", + "id": 67584941, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", + "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": "Change description", + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", + "updated_at": "2022-03-11T11:56:22Z", + "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", + "ssh_url": "git@github.com:octo-org/octo-repo.git", + "clone_url": "https://github.com/octo-org/octo-repo.git", + "svn_url": "https://github.com/octo-org/octo-repo", + "homepage": "", + "size": 646, + "stargazers_count": 1, + "watchers_count": 1, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 60, + "license": null, + "allow_forking": false, + "is_template": false, + "topics": [ + "hey", + "topic" + ], + "visibility": "private", + "forks": 0, + "open_issues": 60, + "watchers": 1, + "default_branch": "master" + } + }, + "base": { + "label": "octo-org:master", + "ref": "master", + "sha": "fcaaddec44575a657bf81b049208b2ce139da3ca", + "user": { + "login": "octo-org", + "id": 67584941, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", + "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "repo": { + "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octo-org", + "id": 67584941, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", + "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": "Change description", + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", + "updated_at": "2022-03-11T11:56:22Z", + "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", + "ssh_url": "git@github.com:octo-org/octo-repo.git", + "clone_url": "https://github.com/octo-org/octo-repo.git", + "svn_url": "https://github.com/octo-org/octo-repo", + "homepage": "", + "size": 646, + "stargazers_count": 1, + "watchers_count": 1, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 60, + "license": null, + "allow_forking": false, + "is_template": false, + "topics": [ + "hey", + "topic" + ], + "visibility": "private", + "forks": 0, + "open_issues": 60, + "watchers": 1, + "default_branch": "master" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118" + }, + "html": { + "href": "https://github.com/octo-org/octo-repo/pull/118" + }, + "issue": { + "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118" + }, + "comments": { + "href": "https://api.github.com/repos/octo-org/octo-repo/issues/118/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octo-org/octo-repo/statuses/14ae1f988d344e6b4f97f6153fb0287dcda335bf" + } + }, + "author_association": "CONTRIBUTOR", + "auto_merge": null, + "active_lock_reason": null + }, + "thread": { + "node_id": "PRRT_kwDOEL39TM4w7XDQ", + "comments": [ + { + "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280", + "pull_request_review_id": 901921390, + "id": 820867280, + "node_id": "PRRC_kwDOEL39TM4w7XDQ", + "diff_hunk": "@@ -0,0 +1 @@\n+issue comment", + "path": "issue-comment", + "position": 1, + "original_position": 1, + "commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf", + "original_commit_id": "14ae1f988d344e6b4f97f6153fb0287dcda335bf", + "user": { + "login": "jide2020", + "id": 64502150, + "node_id": "MDQ6VXNlcjY0NTAyMTUw", + "avatar_url": "https://avatars.githubusercontent.com/u/64502150?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/jide2020", + "html_url": "https://github.com/jide2020", + "followers_url": "https://api.github.com/users/jide2020/followers", + "following_url": "https://api.github.com/users/jide2020/following{/other_user}", + "gists_url": "https://api.github.com/users/jide2020/gists{/gist_id}", + "starred_url": "https://api.github.com/users/jide2020/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/jide2020/subscriptions", + "organizations_url": "https://api.github.com/users/jide2020/orgs", + "repos_url": "https://api.github.com/users/jide2020/repos", + "events_url": "https://api.github.com/users/jide2020/events{/privacy}", + "received_events_url": "https://api.github.com/users/jide2020/received_events", + "type": "User", + "site_admin": false + }, + "body": "sup", + "created_at": "2022-03-07T16:16:48Z", + "updated_at": "2022-03-07T16:16:58Z", + "html_url": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280", + "pull_request_url": "https://api.github.com/repos/octo-org/octo-repo/pulls/118", + "author_association": "COLLABORATOR", + "_links": { + "self": { + "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280" + }, + "html": { + "href": "https://github.com/octo-org/octo-repo/pull/118#discussion_r820867280" + }, + "pull_request": { + "href": "https://api.github.com/repos/octo-org/octo-repo/pulls/118" + } + }, + "reactions": { + "url": "https://api.github.com/repos/octo-org/octo-repo/pulls/comments/820867280/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "start_line": null, + "original_start_line": null, + "start_side": null, + "line": 1, + "original_line": 1, + "side": "RIGHT" + } + ] + }, + "repository": { + "id": 280886604, + "node_id": "MDEwOlJlcG9zaXRvcnkyODA4ODY2MDQ=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octo-org", + "id": 67584941, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", + "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": "Change description", + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "created_at": "2020-07-19T14:48:35Z", + "updated_at": "2022-03-11T11:56:22Z", + "pushed_at": "2022-04-01T09:37:36Z", + "git_url": "git://github.com/octo-org/octo-repo.git", + "ssh_url": "git@github.com:octo-org/octo-repo.git", + "clone_url": "https://github.com/octo-org/octo-repo.git", + "svn_url": "https://github.com/octo-org/octo-repo", + "homepage": "", + "size": 646, + "stargazers_count": 1, + "watchers_count": 1, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 60, + "license": null, + "allow_forking": false, + "is_template": false, + "topics": [ + "hey", + "topic" + ], + "visibility": "private", + "forks": 0, + "open_issues": 60, + "watchers": 1, + "default_branch": "master" + }, + "organization": { + "login": "octo-org", + "id": 67584941, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY3NTg0OTQx", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://avatars.githubusercontent.com/u/67584941?v=4", + "description": "" + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + } +} \ No newline at end of file diff --git a/middleware/render-page.js b/middleware/render-page.js index 2223f9e3b1..36919a5ed8 100644 --- a/middleware/render-page.js +++ b/middleware/render-page.js @@ -37,13 +37,17 @@ async function buildRenderedPage(req) { async function buildMiniTocItems(req) { const { context } = req const { page } = context + const isRestReferencePage = + page.relativePath.startsWith('rest') && + !page.relativePath.includes('rest/guides') && + !page.relativePath.includes('rest/overview') // get mini TOC items on articles if (!page.showMiniToc) { return } - return getMiniTocItems(context.renderedPage, page.miniTocMaxHeadingLevel) + return getMiniTocItems(context.renderedPage, page.miniTocMaxHeadingLevel, '', isRestReferencePage) } export default async function renderPage(req, res, next) { diff --git a/pages/[versionId]/rest/[category]/[subcategory].tsx b/pages/[versionId]/rest/[category]/[subcategory].tsx new file mode 100644 index 0000000000..76a2cb7786 --- /dev/null +++ b/pages/[versionId]/rest/[category]/[subcategory].tsx @@ -0,0 +1,75 @@ +import { GetServerSideProps } from 'next' +import getRest, { getRestMiniTocItems } from 'lib/rest/index.js' +import { Operation } from 'components/rest/types' +import { RestReferencePage } from 'components/rest/RestReferencePage' +import { getMainContext, MainContext, MainContextT } from 'components/context/MainContext' +import { + RestContext, + RestContextT, + getRestContextFromRequest, + MiniTocItem, +} from 'components/context/RestContext' + +type MinitocItemsT = { + restOperationsMiniTocItems: MiniTocItem[] +} + +type Props = { + mainContext: MainContextT + restContext: RestContextT + restOperations: Operation[] +} + +export default function SubCategory({ mainContext, restContext, restOperations }: Props) { + return ( + + + + + + ) +} + +export const getServerSideProps: GetServerSideProps = async (context) => { + const req = context.req as any + const res = context.res as any + // e.g. the `activity` from `/en/rest/activity/events` + const category = context.params!.category as string + const subCategory = context.params!.subcategory as string + const currentVersion = context.params!.versionId as string + const currentLanguage = req.context.currentLanguage as string + + const restOperations = (await getRest(currentVersion, category, subCategory)) || [] + + // Gets the miniTocItems in the article context. At this point it will only + // include miniTocItems generated from the Markdown pages in + // content/rest/* + const { miniTocItems } = getRestContextFromRequest(req) + + // When operations exist, update the miniTocItems in the article context + // with the list of operations in the OpenAPI. + + // The context passed will have the Markdown content for the language + // of the page being requested and the Markdown will be rendered + // using the `currentVersion` + if (restOperations) { + const { restOperationsMiniTocItems } = (await getRestMiniTocItems( + category, + subCategory, + restOperations, + currentLanguage, + currentVersion, + req.context + )) as MinitocItemsT + + restOperationsMiniTocItems && miniTocItems.push(...restOperationsMiniTocItems) + } + + return { + props: { + restOperations, + mainContext: getMainContext(req, res), + restContext: getRestContextFromRequest(req), + }, + } +} diff --git a/pages/[versionId]/rest/[category]/index.tsx b/pages/[versionId]/rest/[category]/index.tsx new file mode 100644 index 0000000000..9cb2c05eba --- /dev/null +++ b/pages/[versionId]/rest/[category]/index.tsx @@ -0,0 +1,100 @@ +import { GetServerSideProps } from 'next' +import getRest, { getRestMiniTocItems } from 'lib/rest/index.js' +import { Operation } from 'components/rest/types' +import { RestReferencePage } from 'components/rest/RestReferencePage' +import { getMainContext, MainContext, MainContextT } from 'components/context/MainContext' +import { + RestContext, + RestContextT, + getRestContextFromRequest, + MiniTocItem, +} from 'components/context/RestContext' +import { + getTocLandingContextFromRequest, + TocLandingContext, + TocLandingContextT, +} from 'components/context/TocLandingContext' +import { TocLanding } from 'components/landing/TocLanding' + +type MinitocItemsT = { + restOperationsMiniTocItems: MiniTocItem[] +} + +type Props = { + mainContext: MainContextT + tocLandingContext: TocLandingContextT + restContext: RestContextT + restOperations: Operation[] +} + +export default function Category({ + mainContext, + restContext, + tocLandingContext, + restOperations, +}: Props) { + const { relativePath } = mainContext + + return ( + + + {/* When the page is the rest product landing page, we don't want to + render the rest-specific sidebar because toggling open the categories + won't have the minitoc items at that level. These are pages that have + category - subcategory - and operations */} + {relativePath?.endsWith('index.md') ? ( + + + + ) : ( + + )} + + + ) +} + +export const getServerSideProps: GetServerSideProps = async (context) => { + const req = context.req as any + const res = context.res as any + // e.g. the `activity` from `/en/rest/activity/events` + const category = context.params!.category as string + const subcategory = context.params!.subcategory as string + const currentVersion = context.params!.versionId as string + const currentLanguage = req.context.currentLanguage as string + + const restOperations = (await getRest(currentVersion, category, subcategory)) || [] + + // Gets the miniTocItems in the article context. At this point it will only + // include miniTocItems generated from the Markdown pages in + // content/rest/* + const { miniTocItems } = getRestContextFromRequest(req) + + // When operations exist, update the miniTocItems in the article context + // with the list of operations in the OpenAPI. + + // The context passed will have the Markdown content for the language + // of the page being requested and the Markdown will be rendered + // using the `currentVersion` + if (restOperations) { + const { restOperationsMiniTocItems } = (await getRestMiniTocItems( + category, + subcategory, + restOperations, + currentLanguage, + currentVersion, + req.context + )) as MinitocItemsT + + restOperationsMiniTocItems && miniTocItems.push(...restOperationsMiniTocItems) + } + + return { + props: { + restOperations, + mainContext: getMainContext(req, res), + restContext: getRestContextFromRequest(req), + tocLandingContext: getTocLandingContextFromRequest(req), + }, + } +} diff --git a/pages/[versionId]/rest/guides/[...restPage].tsx b/pages/[versionId]/rest/guides/[...restPage].tsx new file mode 100644 index 0000000000..a3ade7703a --- /dev/null +++ b/pages/[versionId]/rest/guides/[...restPage].tsx @@ -0,0 +1,5 @@ +import GlobalPage from '../../[productId]/index' + +export { getServerSideProps } from '../../[productId]/index' + +export default GlobalPage diff --git a/pages/[versionId]/rest/guides/index.tsx b/pages/[versionId]/rest/guides/index.tsx new file mode 100644 index 0000000000..a3ade7703a --- /dev/null +++ b/pages/[versionId]/rest/guides/index.tsx @@ -0,0 +1,5 @@ +import GlobalPage from '../../[productId]/index' + +export { getServerSideProps } from '../../[productId]/index' + +export default GlobalPage diff --git a/pages/[versionId]/rest/overview/[...restPage].tsx b/pages/[versionId]/rest/overview/[...restPage].tsx new file mode 100644 index 0000000000..a3ade7703a --- /dev/null +++ b/pages/[versionId]/rest/overview/[...restPage].tsx @@ -0,0 +1,5 @@ +import GlobalPage from '../../[productId]/index' + +export { getServerSideProps } from '../../[productId]/index' + +export default GlobalPage diff --git a/pages/[versionId]/rest/overview/index.tsx b/pages/[versionId]/rest/overview/index.tsx new file mode 100644 index 0000000000..a3ade7703a --- /dev/null +++ b/pages/[versionId]/rest/overview/index.tsx @@ -0,0 +1,5 @@ +import GlobalPage from '../../[productId]/index' + +export { getServerSideProps } from '../../[productId]/index' + +export default GlobalPage diff --git a/pages/[versionId]/rest/reference/[category].tsx b/pages/[versionId]/rest/reference/[category].tsx deleted file mode 100644 index 369e705c9b..0000000000 --- a/pages/[versionId]/rest/reference/[category].tsx +++ /dev/null @@ -1,72 +0,0 @@ -import { GetServerSideProps } from 'next' -import { MainContextT, MainContext, getMainContext } from 'components/context/MainContext' -import getRest, { getRestOperationData } from 'lib/rest/index.js' -import { RestCategoryOperationsT } from 'components/rest/types' -import { MiniTocItem } from 'components/context/ArticleContext' -import { RestReferencePage } from 'components/rest/RestReferencePage' - -type CategoryDataT = { - descriptions: { - [subcategory: string]: string - } - miniTocItems: MiniTocItem[] - introContent: string -} - -type Props = { - mainContext: MainContextT - restOperations: RestCategoryOperationsT - descriptions: { [subcategory: string]: string } - miniTocItems: MiniTocItem[] - introContent: string -} - -export default function Category({ - mainContext, - restOperations, - descriptions, - miniTocItems, - introContent, -}: Props) { - return ( - - - - ) -} - -export const getServerSideProps: GetServerSideProps = async (context) => { - const req = context.req as any - const res = context.res as any - // e.g. the `activity` from `/en/rest/reference/activity#events` - const category = context.params!.category as string - const currentVersion = context.params!.versionId as string - const currentLanguage = req.context.currentLanguage as string - - const restOperations = await getRest(currentVersion, category) - - // The context passed will have the Markdown content for the language - // of the page being requested and the Markdown will be rendered - // using the `currentVersion` - const { descriptions, miniTocItems, introContent } = (await getRestOperationData( - category, - currentLanguage, - currentVersion, - req.context - )) as CategoryDataT - - return { - props: { - restOperations, - mainContext: getMainContext(req, res), - descriptions, - miniTocItems, - introContent, - }, - } -} diff --git a/script/check-github-github-links.js b/script/check-github-github-links.js index 7340690567..2fbefdc12e 100755 --- a/script/check-github-github-links.js +++ b/script/check-github-github-links.js @@ -6,22 +6,60 @@ // // [end-readme] +import fs from 'fs/promises' + +import got, { RequestError } from 'got' + import { getContents, getPathsWithMatchingStrings } from './helpers/git-utils.js' -import got from 'got' if (!process.env.GITHUB_TOKEN) { - console.error('Error! You must have a GITHUB_TOKEN set in an .env file to run this script.') - process.exit(1) + throw new Error('Error! You must have a GITHUB_TOKEN set in an .env file to run this script.') } -const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)) +const FORCE_DOWNLOAD = Boolean(JSON.parse(process.env.FORCE_DOWNLOAD || 'false')) +const BATCH_SIZE = JSON.parse(process.env.BATCH_SIZE || '10') +const BASE_URL = process.env.BASE_URL || 'http://localhost:4000' main() +// The way `got` does retries: +// +// sleep = 1000 * Math.pow(2, retry - 1) + Math.random() * 100 +// +// So, it means: +// +// 1. ~1000ms +// 2. ~2000ms +// 3. ~4000ms +// +// ...if the limit we set is 3. +// Our own timeout, in ./middleware/timeout.js defaults to 10 seconds. +// So there's no point in trying more attempts than 3 because it would +// just timeout on the 10s. (i.e. 1000 + 2000 + 4000 + 8000 > 10,000) +const retryConfiguration = { + limit: 3, +} +// According to our Datadog metrics, the *average* time for the +// the 'archive_enterprise_proxy' metric is ~70ms (excluding spikes) +// which much less than 500ms. +const timeoutConfiguration = 1000 + async function main() { const searchStrings = ['https://docs.github.com', 'GitHub help_url', 'GitHub developer_help_url'] - const foundFiles = await getPathsWithMatchingStrings(searchStrings, 'github', 'github') - const searchFiles = [...foundFiles] + + const foundFiles = [] + try { + foundFiles.push(...JSON.parse(await fs.readFile('/tmp/foundFiles.json', 'utf-8'))) + } catch (error) { + if (!(error.code && error.code === 'ENOENT')) { + throw error + } + } + if (!foundFiles.length || FORCE_DOWNLOAD) { + foundFiles.push(...(await getPathsWithMatchingStrings(searchStrings, 'github', 'github'))) + await fs.writeFile('/tmp/foundFiles.json', JSON.stringify(foundFiles, undefined, 2), 'utf-8') + } + const searchFiles = [...new Set(foundFiles)] // filters out dupes .filter((file) => endsWithAny(['.rb', '.yml', '.yaml', '.txt', '.pdf', '.erb', '.js'], file)) .filter( (file) => @@ -35,79 +73,106 @@ async function main() { const urlRegEx = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_+.~#?&//=]*)/g - for (const file of searchFiles) { - const contents = await getContents('github', 'github', 'master', file) - - if ( - contents.includes('https://docs.github.com') || - contents.includes('GitHub.help_url') || - contents.includes('GitHub.developer_help_url') - ) { - const docsIndices = getIndicesOf('https://docs.github.com', contents) - const helpIndices = getIndicesOf('GitHub.help_url', contents) - helpIndices.push(...getIndicesOf('GitHub.developer_help_url', contents)) - if (docsIndices.length > 0) { - docsIndices.forEach((numIndex) => { - // Assuming we don't have links close to 500 characters long - const docsLink = contents.substring(numIndex, numIndex + 500).match(urlRegEx) - docsLinksFiles.push([docsLink[0].toString().replace(/[^a-zA-Z0-9]*$|\\n$/g, ''), file]) - }) - } - - if (helpIndices.length > 0) { - helpIndices.forEach((numIndex) => { - // There are certain links like #{GitHub.help_url}#{learn_more_path} and #{GitHub.developer_help_url}#{learn_more_path} that we should skip - if ( - (contents.substring(numIndex, numIndex + 11) === 'GitHub.help' && - contents.charAt(numIndex + 16) === '#') || - (contents.substring(numIndex, numIndex + 16) === 'GitHub.developer' && - contents.charAt(numIndex + 26) === '#') - ) { - return - } - - const startSearchIndex = contents.indexOf('/', numIndex) - // Looking for the closest '/' after GitHub.developer_help_url or GitHub.help_url - // There are certain links that don't start with `/` so we want to skip those. - // If there's no `/` within 30 characters of GitHub.help_url/GitHub.developer_help_url, skip - if (startSearchIndex - numIndex < 30) { - const linkPath = contents - .substring( - startSearchIndex, - regexIndexOf( - contents, - /\n|"\)|{@email_tracking_params}|\^http|Ahttps|example|This|TODO"|[{}|"%><.,')* ]/, - startSearchIndex + 1 - ) - ) - .trim() - - // Certain specific links can be ignored as well - if (['/deprecation-1'].includes(linkPath)) { - return - } - - docsLinksFiles.push([`https://docs.github.com${linkPath}`, file]) - } - }) - } + try { + docsLinksFiles.push(...JSON.parse(await fs.readFile('/tmp/docsLinksFiles.json', 'utf-8'))) + } catch (error) { + if (!(error.code && error.code === 'ENOENT')) { + throw error } } - const brokenLinks = [] - // Done serially with delay to avoid hitting the rate limiter - for (const file of docsLinksFiles) { - try { - await got(file[0], { - headers: { - 'X-WAF-TOKEN': process.env.WAF_TOKEN, - }, - }) - } catch (e) { - brokenLinks.push(file) - } finally { - await sleep(300) + if (!docsLinksFiles.length || FORCE_DOWNLOAD) { + for (const file of searchFiles) { + const contents = await getContents('github', 'github', 'master', file) + + if ( + contents.includes('https://docs.github.com') || + contents.includes('GitHub.help_url') || + contents.includes('GitHub.developer_help_url') + ) { + const docsIndices = getIndicesOf('https://docs.github.com', contents) + const helpIndices = getIndicesOf('GitHub.help_url', contents) + helpIndices.push(...getIndicesOf('GitHub.developer_help_url', contents)) + if (docsIndices.length > 0) { + docsIndices.forEach((numIndex) => { + // Assuming we don't have links close to 500 characters long + const docsLink = contents.substring(numIndex, numIndex + 500).match(urlRegEx) + const linkURL = new URL(docsLink[0].toString().replace(/[^a-zA-Z0-9]*$|\\n$/g, '')) + const linkPath = linkURL.pathname + linkURL.hash + docsLinksFiles.push({ linkPath, file }) + }) + } + + if (helpIndices.length > 0) { + helpIndices.forEach((numIndex) => { + // There are certain links like #{GitHub.help_url}#{learn_more_path} and #{GitHub.developer_help_url}#{learn_more_path} that we should skip + if ( + (contents.substring(numIndex, numIndex + 11) === 'GitHub.help' && + contents.charAt(numIndex + 16) === '#') || + (contents.substring(numIndex, numIndex + 16) === 'GitHub.developer' && + contents.charAt(numIndex + 26) === '#') + ) { + return + } + + const startSearchIndex = contents.indexOf('/', numIndex) + // Looking for the closest '/' after GitHub.developer_help_url or GitHub.help_url + // There are certain links that don't start with `/` so we want to skip those. + // If there's no `/` within 30 characters of GitHub.help_url/GitHub.developer_help_url, skip + if (startSearchIndex - numIndex < 30) { + const linkPath = contents + .substring( + startSearchIndex, + regexIndexOf( + contents, + /\n|"\)|{@email_tracking_params}|\^http|Ahttps|example|This|TODO"|[{}|"%><.,')* ]/, + startSearchIndex + 1 + ) + ) + .trim() + + // Certain specific links can be ignored as well + if (['/deprecation-1'].includes(linkPath)) { + return + } + + docsLinksFiles.push({ linkPath, file }) + } + }) + } + } } + await fs.writeFile( + '/tmp/docsLinksFiles.json', + JSON.stringify(docsLinksFiles, undefined, 2), + 'utf-8' + ) + } + const brokenLinks = [] + + // Break up the long list of URLs to test into batches + for (const batch of [...Array(Math.floor(docsLinksFiles.length / BATCH_SIZE)).keys()]) { + const slice = docsLinksFiles.slice(batch * BATCH_SIZE, batch * BATCH_SIZE + BATCH_SIZE) + await Promise.all( + slice.map(async ({ linkPath, file }) => { + // This isn't necessary but if it can't be constructed, it'll + // fail in quite a nice way and not "blame got". + const url = new URL(BASE_URL + linkPath) + try { + await got(url.href, { + retry: retryConfiguration, + timeout: timeoutConfiguration, + }) + } catch (error) { + if (error instanceof RequestError) { + brokenLinks.push({ linkPath, file }) + } else { + console.warn(`URL when it threw: ${url}`) + throw error + } + } + }) + ) } if (!brokenLinks.length) { diff --git a/script/rest/test-open-api-schema.js b/script/rest/test-open-api-schema.js new file mode 100755 index 0000000000..0b795e212b --- /dev/null +++ b/script/rest/test-open-api-schema.js @@ -0,0 +1,248 @@ +#!/usr/bin/env node + +// [start-readme] +// +// Run this script to check if OpenAPI operations match versions in content/rest operations +// +// [end-readme] + +import fs from 'fs' +import path from 'path' +import { readFile, readdir } from 'fs/promises' +import readFileAsync from '../../lib/readfile-async.js' +import getOperations from './utils/get-operations.js' +import frontmatter from '../../lib/read-frontmatter.js' +import _ from 'lodash' + +let LOWEST_SUPPORTED_GHES_VERSION = Number.MAX_VALUE +let HIGHEST_SUPPORTED_GHES_VERSION = Number.MIN_VALUE + +const dereferencedPath = path.join(process.cwd(), 'lib/rest/static/dereferenced') +const contentPath = path.join(process.cwd(), 'content/rest') +const schemas = await readdir(dereferencedPath) +const contentFiles = [] +const contentCheck = {} +const openAPISchemaCheck = {} +const dereferencedSchemas = {} + +export async function getDiffOpenAPIContentRest() { + // Recursively go through the content/rest directory and add all categories/subcategories to contentFiles + throughDirectory(contentPath) + + // Add version keys to contentCheck and dereferencedSchema objects + await addVersionKeys() + + // Creating the categories/subcategories based on the current content directory + await createCheckContentDirectory() + + // Create categories/subcategories from OpenAPI Schemas + await createOpenAPISchemasCheck() + + // Get Differences between categories/subcategories from dereferenced schemas and the content/rest directory frontmatter versions + const differences = getDifferences(openAPISchemaCheck, contentCheck) + const errorMessages = {} + + if (Object.keys(differences).length > 0) { + for (const schemaName in differences) { + errorMessages[schemaName] = {} + for (const category in differences[schemaName]) { + if (!errorMessages[schemaName]) errorMessages[schemaName] = category + errorMessages[schemaName][category] = { + contentDir: contentCheck[schemaName][category], + openAPI: openAPISchemaCheck[schemaName][category], + } + } + } + } + return errorMessages +} + +async function addVersionKeys() { + for (const filename of schemas) { + const schema = JSON.parse(await readFile(path.join(dereferencedPath, filename))) + const key = filename.replace('.deref.json', '') + contentCheck[key] = {} + if (key.startsWith('ghes')) { + const version = parseFloat(key.split('-')[1]).toFixed(1) + LOWEST_SUPPORTED_GHES_VERSION = Math.min(LOWEST_SUPPORTED_GHES_VERSION, version) + HIGHEST_SUPPORTED_GHES_VERSION = Math.max(HIGHEST_SUPPORTED_GHES_VERSION, version) + } + dereferencedSchemas[key] = schema + } + // GitHub Enterprise Cloud is just github.com bc it is not in the OpenAPI schema yet. Once it is, this should be updated + contentCheck['ghec.github.com'] = {} + dereferencedSchemas['ghec.github.com'] = dereferencedSchemas['api.github.com'] +} + +async function createOpenAPISchemasCheck() { + for (const [schemaName, schema] of Object.entries(dereferencedSchemas)) { + try { + const operationsByCategory = {} + // munge OpenAPI definitions object in an array of operations objects + const operations = await getOperations(schema) + // process each operation, asynchronously rendering markdown and stuff + await Promise.all(operations.map((operation) => operation.process())) + + // Remove any keys not needed in the decorated files + const decoratedOperations = operations.map( + ({ + tags, + description, + serverUrl, + operationId, + categoryLabel, + subcategoryLabel, + contentType, + externalDocs, + ...props + }) => props + ) + + const categories = [ + ...new Set(decoratedOperations.map((operation) => operation.category)), + ].sort() + + categories.forEach((category) => { + operationsByCategory[category] = {} + const categoryOperations = decoratedOperations.filter( + (operation) => operation.category === category + ) + categoryOperations + .filter((operation) => !operation.subcategory) + .map((operation) => (operation.subcategory = operation.category)) + + const subcategories = [ + ...new Set(categoryOperations.map((operation) => operation.subcategory)), + ].sort() + // the first item should be the item that has no subcategory + // e.g., when the subcategory = category + const firstItemIndex = subcategories.indexOf(category) + if (firstItemIndex > -1) { + const firstItem = subcategories.splice(firstItemIndex, 1)[0] + subcategories.unshift(firstItem) + } + operationsByCategory[category] = subcategories.sort() + }) + openAPISchemaCheck[schemaName] = operationsByCategory + // One off edge case where secret-scanning should be removed from FPT. Docs Content #6637 + delete openAPISchemaCheck['api.github.com']['secret-scanning'] + } catch (error) { + console.error(error) + console.log('🐛 Whoops! Could not get operations by category!') + process.exit(1) + } + } +} + +async function createCheckContentDirectory() { + for (const filename of contentFiles) { + const { data } = frontmatter(await readFileAsync(filename, 'utf8')) + const splitPath = filename.split('/') + const subCategory = splitPath[splitPath.length - 1].replace('.md', '') + const category = + splitPath[splitPath.length - 2] === 'rest' ? subCategory : splitPath[splitPath.length - 2] + const versions = data.versions + + for (const version in versions) { + const schemaNames = getSchemaName(version, versions[version]) + + for (const name of schemaNames) { + if (!contentCheck[name][category]) { + contentCheck[name][category] = [subCategory] + } else { + contentCheck[name][category].push(subCategory) + } + contentCheck[name][category].sort() + } + } + } +} + +function getDifferences(openAPISchemaCheck, contentCheck) { + const differences = {} + for (const version in openAPISchemaCheck) { + const diffOpenApiContent = difference(openAPISchemaCheck[version], contentCheck[version]) + if (Object.keys(diffOpenApiContent).length > 0) differences[version] = diffOpenApiContent + } + + return differences +} + +function getSchemaName(version, versionValues) { + const versions = [] + if (version === 'fpt') { + if (versionValues === '*') versions.push('api.github.com') + } else if (version === 'ghec') { + if (versionValues === '*') versions.push('ghec.github.com') + } else if (version === 'ghae') { + if (versionValues === '*') versions.push('github.ae') + } else if (version === 'ghes') { + if (versionValues === '*') { + versions.push('ghes-3.1', 'ghes-3.2', 'ghes-3.3', 'ghes-3.4') + } else { + let ver = '' + let includeVersion = false + let goUp + for (const char of versionValues) { + if ((char >= '0' && char <= '9') || char === '.') { + ver += char + } else if (char === '=') { + includeVersion = true + } else if (char === '>') { + goUp = true + } else if (char === '<') { + goUp = false + } + } + let numVersion = parseFloat(ver).toFixed(1) + + if (!includeVersion) { + numVersion = goUp + ? (parseFloat(numVersion) + 0.1).toFixed(1) + : (parseFloat(numVersion) - 0.1).toFixed(1) + } + + while ( + numVersion <= HIGHEST_SUPPORTED_GHES_VERSION && + numVersion >= LOWEST_SUPPORTED_GHES_VERSION + ) { + numVersion = parseFloat(numVersion).toFixed(1) + versions.push('ghes-' + numVersion) + numVersion = goUp + ? (parseFloat(numVersion) + 0.1).toFixed(1) + : (parseFloat(numVersion) - 0.1).toFixed(1) + } + } + } + return versions +} + +function throughDirectory(directory) { + fs.readdirSync(directory).forEach((file) => { + const absolute = path.join(directory, file) + if (fs.statSync(absolute).isDirectory()) { + return throughDirectory(absolute) + } else if ( + !directory.includes('rest/guides') && + !directory.includes('rest/overview') && + !file.includes('index.md') && + !file.includes('README.md') + ) { + return contentFiles.push(absolute) + } + }) +} + +function difference(obj1, obj2) { + const diff = Object.keys(obj1).reduce((result, key) => { + if (!Object.prototype.hasOwnProperty.call(obj2, key)) { + result.push(key) + } else if (_.isEqual(obj1[key], obj2[key])) { + const resultKeyIndex = result.indexOf(key) + result.splice(resultKeyIndex, 1) + } + return result + }, Object.keys(obj2)) + + return diff +} diff --git a/script/rest/update-files.js b/script/rest/update-files.js index 5c383ad972..f4c373c7c0 100755 --- a/script/rest/update-files.js +++ b/script/rest/update-files.js @@ -79,8 +79,6 @@ async function main() { await decorate() } - await updateRedirectOverrides() - console.log( '\n🏁 The static REST API files are now up-to-date with your local `github/github` checkout. To revert uncommitted changes, run `git checkout lib/rest/static/*.\n\n' ) @@ -135,26 +133,27 @@ async function getDereferencedFiles() { } } -async function updateRedirectOverrides() { - const overrides = JSON.parse(await readFile('script/rest/utils/rest-api-overrides.json', 'utf8')) - - const redirects = {} - console.log('\n➡️ Updating REST API redirect exception list.\n') - for (const [key, value] of Object.entries(overrides)) { - const oldUrl = value.originalUrl - const anchor = oldUrl.replace('/rest/reference', '').split('#')[1] - if (key.includes('#')) { - // We are updating a subcategory into a category - redirects[oldUrl] = `/rest/reference/${value.category}` - } else { - redirects[oldUrl] = `/rest/reference/${value.category}#${anchor}` - } - } - await writeFile( - 'lib/redirects/static/client-side-rest-api-redirects.json', - JSON.stringify(redirects, null, 2), - 'utf8' +async function getCategoryOverrideRedirects() { + const { operationUrls, sectionUrls } = JSON.parse( + await readFile('script/rest/utils/rest-api-overrides.json', 'utf8') ) + + const operationRedirects = {} + console.log('\n➡️ Updating REST API redirect exception list.\n') + Object.values(operationUrls).forEach((value) => { + const oldUrl = value.originalUrl.replace('/rest/reference', '/rest') + const anchor = oldUrl.split('#')[1] + const subcategory = value.subcategory + const redirectTo = subcategory + ? `/rest/${value.category}/${subcategory}#${anchor}` + : `/rest/${value.category}#${anchor}` + operationRedirects[oldUrl] = redirectTo + }) + const redirects = { + ...operationRedirects, + ...sectionUrls, + } + return redirects } async function decorate() { @@ -167,12 +166,78 @@ async function decorate() { } const operationsEnabledForGitHubApps = {} + const clientSideRedirects = await getCategoryOverrideRedirects() + + const skipCategory = [ + 'billing', + 'code-scanning', + 'codes-of-conduct', + 'deploy-keys', + 'emojis', + 'gitignore', + 'licenses', + 'markdown', + 'meta', + 'oauth-authorizations', + 'packages', + 'pages', + 'rate-limit', + 'reactions', + 'scim', + 'search', + 'secret-scanning', + ] for (const [schemaName, schema] of Object.entries(dereferencedSchemas)) { try { - // munge OpenAPI definitions object in an array of operations objects + // get all of the operations for a particular version of the openapi const operations = await getOperations(schema) // process each operation, asynchronously rendering markdown and stuff await Promise.all(operations.map((operation) => operation.process())) + + // For each rest operation that doesn't have an override defined + // in script/rest/utils/rest-api-overrides.json, + // add a client-side redirect + operations.forEach((operation) => { + // A handful of operations don't have external docs properties + const externalDocs = operation.getExternalDocs() + if (!externalDocs) { + return + } + const oldUrl = `/rest${ + externalDocs.url.replace('/rest/reference', '/rest').split('/rest')[1] + }` + + if (!(oldUrl in clientSideRedirects)) { + // There are some operations that aren't nested in the sidebar + // For these, don't need to add a client-side redirect, the + // frontmatter redirect will handle it for us. + if (skipCategory.includes(operation.category)) { + return + } + const anchor = oldUrl.split('#')[1] + const subcategory = operation.subcategory + + // If there is no subcategory, a new page with the same name as the + // category was created. That page name may change going forward. + const redirectTo = subcategory + ? `/rest/${operation.category}/${subcategory}#${anchor}` + : `/rest/${operation.category}/${operation.category}#${anchor}` + clientSideRedirects[oldUrl] = redirectTo + } + + // There are a lot of section headings that we'll want to redirect too, + // now that subcategories are on their own page. For example, + // /rest/reference/actions#artifacts should redirect to + // /rest/actions/artifacts + if (operation.subcategory) { + const sectionRedirectFrom = `/rest/${operation.category}#${operation.subcategory}` + const sectionRedirectTo = `/rest/${operation.category}/${operation.subcategory}` + if (!(sectionRedirectFrom in clientSideRedirects)) { + clientSideRedirects[sectionRedirectFrom] = sectionRedirectTo + } + } + }) + const categories = [...new Set(operations.map((operation) => operation.category))].sort() // Orders the operations by their category and subcategories. @@ -258,6 +323,15 @@ async function decorate() { JSON.stringify(operationsEnabledForGitHubApps, null, 2) ) console.log('Wrote', path.relative(process.cwd(), `${appsStaticPath}/enabled-for-apps.json`)) + await writeFile( + 'lib/redirects/static/client-side-rest-api-redirects.json', + JSON.stringify(clientSideRedirects, null, 2), + 'utf8' + ) + console.log( + 'Wrote', + path.relative(process.cwd(), `lib/redirects/static/client-side-rest-api-redirects.json`) + ) } async function validateInputParameters(schemas) { diff --git a/script/rest/utils/operation.js b/script/rest/utils/operation.js index de5609f5ef..341c9444d6 100644 --- a/script/rest/utils/operation.js +++ b/script/rest/utils/operation.js @@ -1,15 +1,16 @@ #!/usr/bin/env node -import { readFile } from 'fs/promises' -import { get, flatten, isPlainObject } from 'lodash-es' +import Ajv from 'ajv' import GitHubSlugger from 'github-slugger' import httpStatusCodes from 'http-status-code' -import renderContent from '../../../lib/render-content/index.js' -import getCodeSamples from './create-rest-examples.js' -import Ajv from 'ajv' -import operationSchema from './operation-schema.js' +import { readFile } from 'fs/promises' +import { get, flatten, isPlainObject } from 'lodash-es' import { parseTemplate } from 'url-template' -const overrideOperations = JSON.parse( +import renderContent from '../../../lib/render-content/index.js' +import getCodeSamples from './create-rest-examples.js' +import operationSchema from './operation-schema.js' + +const { operationUrls } = JSON.parse( await readFile('script/rest/utils/rest-api-overrides.json', 'utf8') ) const slugger = new GitHubSlugger() @@ -62,8 +63,8 @@ export default class Operation { // the openapi schema. Without it, we'd have to update several // @documentation_urls in the api code every time we move // an endpoint to a new page. - this.category = overrideOperations[operationId] - ? overrideOperations[operationId].category + this.category = operationUrls[operationId] + ? operationUrls[operationId].category : xGithub.category // Set subcategory @@ -71,9 +72,9 @@ export default class Operation { // defined in the openapi schema. Without it, we'd have to update several // @documentation_urls in the api code every time we move // an endpoint to a new page. - if (overrideOperations[operationId]) { - if (overrideOperations[operationId].subcategory) { - this.subcategory = overrideOperations[operationId].subcategory + if (operationUrls[operationId]) { + if (operationUrls[operationId].subcategory) { + this.subcategory = operationUrls[operationId].subcategory } } else if (xGithub.subcategory) { this.subcategory = xGithub.subcategory @@ -108,6 +109,10 @@ export default class Operation { } } + getExternalDocs() { + return this.#operation.externalDocs + } + async renderDescription() { this.descriptionHTML = await renderContent(this.#operation.description) return this diff --git a/script/rest/utils/rest-api-overrides.json b/script/rest/utils/rest-api-overrides.json index 13e312dceb..81b1748900 100644 --- a/script/rest/utils/rest-api-overrides.json +++ b/script/rest/utils/rest-api-overrides.json @@ -1,802 +1,783 @@ { - "repos/list-collaborators": { - "category": "collaborators", - "subcategory": null, - "originalUrl": "/rest/reference/repos#list-repository-collaborators" - }, - "repos/check-collaborator": { - "category": "collaborators", - "subcategory": null, - "originalUrl": "/rest/reference/repos#check-if-a-user-is-a-repository-collaborator" - }, - "repos/add-collaborator": { - "category": "collaborators", - "subcategory": null, - "originalUrl": "/rest/reference/repos#add-a-repository-collaborator" - }, - "repos/remove-collaborator": { - "category": "collaborators", - "subcategory": null, - "originalUrl": "/rest/reference/repos#remove-a-repository-collaborator" - }, - "repos/get-collaborator-permission-level": { - "category": "collaborators", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-repository-permissions-for-a-user" - }, - "repos/list-commit-comments-for-repo": { - "category": "commits", - "subcategory": "comments", - "originalUrl": "/rest/reference/repos#list-commit-comments-for-a-repository" - }, - "repos/get-commit-comment": { - "category": "commits", - "subcategory": "comments", - "originalUrl": "/rest/reference/repos#get-a-commit-comment" - }, - "repos/update-commit-comment": { - "category": "commits", - "subcategory": "comments", - "originalUrl": "/rest/reference/repos#update-a-commit-comment" - }, - "repos/delete-commit-comment": { - "category": "commits", - "subcategory": "comments", - "originalUrl": "/rest/reference/repos#delete-a-commit-comment" - }, - "repos/list-commits": { - "category": "commits", - "subcategory": null, - "originalUrl": "/rest/reference/repos#list-commits" - }, - "repos/list-branches-for-head-commit": { - "category": "commits", - "subcategory": null, - "originalUrl": "/rest/reference/repos#list-branches-for-head-commit" - }, - "repos/list-comments-for-commit": { - "category": "commits", - "subcategory": "comments", - "originalUrl": "/rest/reference/repos#list-commit-comments" - }, - "repos/create-commit-comment": { - "category": "commits", - "subcategory": "comments", - "originalUrl": "/rest/reference/repos#create-a-commit-comment" - }, - "repos/list-pull-requests-associated-with-commit": { - "category": "commits", - "subcategory": null, - "originalUrl": "/rest/reference/repos#list-pull-requests-associated-with-a-commit" - }, - "repos/get-commit": { - "category": "commits", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-a-commit" - }, - "repos/get-combined-status-for-ref": { - "category": "commits", - "subcategory": "statuses", - "originalUrl": "/rest/reference/repos#get-the-combined-status-for-a-specific-reference" - }, - "repos/list-commit-statuses-for-ref": { - "category": "commits", - "subcategory": "statuses", - "originalUrl": "/rest/reference/repos#list-commit-statuses-for-a-reference" - }, - "repos/get-community-profile-metrics": { - "category": "metrics", - "subcategory": "community", - "originalUrl": "/rest/reference/repos#get-community-profile-metrics" - }, - "repos/compare-commits": { - "category": "commits", - "subcategory": null, - "originalUrl": "/rest/reference/repos#compare-two-commits" - }, - "repos/get-all-environments": { - "category": "deployments", - "subcategory": "environments", - "originalUrl": "/rest/reference/repos#get-all-environments" - }, - "repos/get-environment": { - "category": "deployments", - "subcategory": "environments", - "originalUrl": "/rest/reference/repos#get-an-environment" - }, - "repos/create-or-update-environment": { - "category": "deployments", - "subcategory": "environments", - "originalUrl": "/rest/reference/repos#create-or-update-an-environment" - }, - "repos/delete-an-environment": { - "category": "deployments", - "subcategory": "environments", - "originalUrl": "/rest/reference/repos#delete-an-environment" - }, - "repos/list-invitations": { - "category": "collaborators", - "subcategory": "invitations", - "originalUrl": "/rest/reference/repos#list-repository-invitations" - }, - "repos/update-invitation": { - "category": "collaborators", - "subcategory": "invitations", - "originalUrl": "/rest/reference/repos#update-a-repository-invitation" - }, - "repos/delete-invitation": { - "category": "collaborators", - "subcategory": "invitations", - "originalUrl": "/rest/reference/repos#delete-a-repository-invitation" - }, - "repos/list-deploy-keys": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/repos#list-deploy-keys" - }, - "repos/create-deploy-key": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/repos#create-a-deploy-key" - }, - "repos/get-deploy-key": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/repos#get-a-deploy-key" - }, - "repos/delete-deploy-key": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/repos#delete-a-deploy-key" - }, - "repos#deploy-keys": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/repos#deploy-keys" - }, - "deployments/list-deploy-keys": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/deployments#list-deploy-keys" - }, - "deployments/create-deploy-key": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/deployments#create-a-deploy-key" - }, - "deployments/get-deploy-key": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/deployments#get-a-deploy-key" - }, - "deployments/delete-deploy-key": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/deployments#delete-a-deploy-key" - }, - "deployments#deploy-keys": { - "category": "deploy_keys", - "subcategory": "deploy_keys", - "originalUrl": "/rest/reference/deployments#deploy-keys" - }, - "repos/get-pages": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-a-github-pages-site" - }, - "repos/create-pages-site": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#create-a-github-pages-site" - }, - "repos/update-information-about-pages-site": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#update-information-about-a-github-pages-site" - }, - "repos/delete-pages-site": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#delete-a-github-pages-site" - }, - "repos/list-pages-builds": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#list-github-pages-builds" - }, - "repos/request-pages-build": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#request-a-github-pages-build" - }, - "repos/get-latest-pages-build": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-latest-pages-build" - }, - "repos/get-pages-build": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-github-pages-build" - }, - "repos/get-pages-health-check": { - "category": "pages", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-a-dns-health-check-for-github-pages" - }, - "repos/get-code-frequency-stats": { - "category": "metrics", - "subcategory": "statistics", - "originalUrl": "/rest/reference/repos#get-the-weekly-commit-activity" - }, - "repos/get-commit-activity-stats": { - "category": "metrics", - "subcategory": "statistics", - "originalUrl": "/rest/reference/repos#get-the-last-year-of-commit-activity" - }, - "repos/get-contributors-stats": { - "category": "metrics", - "subcategory": "statistics", - "originalUrl": "/rest/reference/repos#get-all-contributor-commit-activity" - }, - "repos/get-participation-stats": { - "category": "metrics", - "subcategory": "statistics", - "originalUrl": "/rest/reference/repos#get-the-weekly-commit-count" - }, - "repos/get-punch-card-stats": { - "category": "metrics", - "subcategory": "statistics", - "originalUrl": "/rest/reference/repos#get-the-hourly-commit-count-for-each-day" - }, - "repos/create-commit-status": { - "category": "commits", - "subcategory": "statuses", - "originalUrl": "/rest/reference/repos#create-a-commit-status" - }, - "repos/get-clones": { - "category": "metrics", - "subcategory": "traffic", - "originalUrl": "/rest/reference/repos#get-repository-clones" - }, - "repos/get-top-paths": { - "category": "metrics", - "subcategory": "traffic", - "originalUrl": "/rest/reference/repos#get-top-referral-paths" - }, - "repos/get-top-referrers": { - "category": "metrics", - "subcategory": "traffic", - "originalUrl": "/rest/reference/repos#get-top-referral-sources" - }, - "repos/get-views": { - "category": "metrics", - "subcategory": "traffic", - "originalUrl": "/rest/reference/repos#get-page-views" - }, - "repos/list-invitations-for-authenticated-user": { - "category": "collaborators", - "subcategory": "invitations", - "originalUrl": "/rest/reference/repos#list-repository-invitations-for-the-authenticated-user" - }, - "repos/accept-invitation-for-authenticated-user": { - "category": "collaborators", - "subcategory": "invitations", - "originalUrl": "/rest/reference/repos#accept-a-repository-invitation" - }, - "repos/decline-invitation-for-authenticated-user": { - "category": "collaborators", - "subcategory": "invitations", - "originalUrl": "/rest/reference/repos#decline-a-repository-invitation" - }, - "repos/list-branches": { - "category": "branches", - "subcategory": null, - "originalUrl": "/rest/reference/repos#list-branches" - }, - "repos/get-branch": { - "category": "branches", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-a-branch" - }, - "repos/rename-branch": { - "category": "branches", - "subcategory": null, - "originalUrl": "/rest/reference/repos#rename-a-branch" - }, - "repos/merge-upstream": { - "category": "branches", - "subcategory": null, - "originalUrl": "/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" - }, - "repos/merge": { - "category": "branches", - "subcategory": null, - "originalUrl": "/rest/reference/repos#merge-a-branch" - }, - "repos/add-app-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#add-app-access-restrictions" - }, - "repos/add-status-check-contexts": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#add-status-check-contexts" - }, - "repos/add-team-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#add-team-access-restrictions" - }, - "repos/add-user-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#add-user-access-restrictions" - }, - "repos/create-commit-signature-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#create-commit-signature-protection" - }, - "repos/delete-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#delete-access-restrictions" - }, - "repos/delete-admin-branch-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#delete-admin-branch-protection" - }, - "repos/delete-branch-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#delete-branch-protection" - }, - "repos/delete-commit-signature-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#delete-commit-signature-protection" - }, - "repos/delete-pull-request-review-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#delete-pull-request-review-protection" - }, - "repos/get-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#get-access-restrictions" - }, - "repos/get-admin-branch-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#get-admin-branch-protection" - }, - "repos/get-all-status-check-contexts": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#get-all-status-check-contexts" - }, - "repos/get-apps-with-access-to-protected-branch": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#list-apps-with-access-to-the-protected-branch" - }, - "repos/update-pull-request-review-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#update-pull-request-review-protection" - }, - "repos/get-branch-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#get-branch-protection" - }, - "repos/get-commit-signature-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#get-commit-signature-protection" - }, - "repos/get-pull-request-review-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#get-pull-request-review-protection" - }, - "repos/get-status-checks-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#get-status-checks-protection" - }, - "repos/get-teams-with-access-to-protected-branch": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#list-teams-with-access-to-the-protected-branch" - }, - "repos/get-users-with-access-to-protected-branch": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#list-users-with-access-to-the-protected-branch" - }, - "repos/remove-app-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#remove-app-access-restrictions" - }, - "repos/remove-status-check-contexts": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#remove-status-check-contexts" - }, - "repos/remove-status-check-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#remove-status-check-protection" - }, - "repos/remove-team-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#remove-team-access-restrictions" - }, - "repos/remove-user-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#remove-user-access-restrictions" - }, - "repos/set-admin-branch-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#set-admin-branch-protection" - }, - "repos/set-app-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#set-app-access-restrictions" - }, - "repos/set-status-check-contexts": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#set-status-check-contexts" - }, - "repos/set-team-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#set-team-access-restrictions" - }, - "repos/set-user-access-restrictions": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#set-user-access-restrictions" - }, - "repos/update-branch-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#update-branch-protection" - }, - "repos/update-status-check-protection": { - "category": "branches", - "subcategory": "branch-protection", - "originalUrl": "/rest/reference/repos#update-status-check-protection" - }, - "repos/create-deployment-status": { - "category": "deployments", - "subcategory": "statuses", - "originalUrl": "/rest/reference/repos#create-a-deployment-status" - }, - "repos/list-deployment-statuses": { - "category": "deployments", - "subcategory": "statuses", - "originalUrl": "/rest/reference/repos#list-deployment-statuses" - }, - "repos/get-deployment-status": { - "category": "deployments", - "subcategory": "statuses", - "originalUrl": "/rest/reference/repos#get-a-deployment-status" - }, - "repos/list-deployments": { - "category": "deployments", - "subcategory": null, - "originalUrl": "/rest/reference/repos#list-deployments" - }, - "repos/create-deployment": { - "category": "deployments", - "subcategory": null, - "originalUrl": "/rest/reference/repos#create-a-deployment" - }, - "repos/get-deployment": { - "category": "deployments", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-a-deployment" - }, - "repos/delete-deployment": { - "category": "deployments", - "subcategory": null, - "originalUrl": "/rest/reference/repos#delete-a-deployment" - }, - "repos/list-releases": { - "category": "releases", - "subcategory": null, - "originalUrl": "/rest/reference/repos#list-releases" - }, - "repos/create-release": { - "category": "releases", - "subcategory": null, - "originalUrl": "/rest/reference/repos#create-a-release" - }, - "repos/generate-release-notes": { - "category": "releases", - "subcategory": null, - "originalUrl": "/rest/reference/repos#generate-release-notes" - }, - "repos/get-latest-release": { - "category": "releases", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-the-latest-release" - }, - "repos/get-release-by-tag": { - "category": "releases", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-a-release-by-tag-name" - }, - "repos/get-release": { - "category": "releases", - "subcategory": null, - "originalUrl": "/rest/reference/repos#get-a-release" - }, - "repos/update-release": { - "category": "releases", - "subcategory": null, - "originalUrl": "/rest/reference/repos#update-a-release" - }, - "repos/delete-release": { - "category": "releases", - "subcategory": null, - "originalUrl": "/rest/reference/repos#delete-a-release" - }, - "repos/delete-release-asset": { - "category": "releases", - "subcategory": "assets", - "originalUrl": "/rest/reference/repos#delete-a-release-asset" - }, - "repos/get-release-asset": { - "category": "releases", - "subcategory": "assets", - "originalUrl": "/rest/reference/repos#get-a-release-asset" - }, - "repos/list-release-assets": { - "category": "releases", - "subcategory": "assets", - "originalUrl": "/rest/reference/repos#list-release-assets" - }, - "repos/update-release-asset": { - "category": "releases", - "subcategory": "assets", - "originalUrl": "/rest/reference/repos#update-a-release-asset" - }, - "repos/upload-release-asset": { - "category": "releases", - "subcategory": "assets", - "originalUrl": "/rest/reference/repos#upload-a-release-asset" - }, - "repos/list-webhooks": { - "category": "webhooks", - "subcategory": "repos", - "originalUrl": "/rest/reference/repos#list-repository-webhooks" - }, - "repos/create-webhook": { - "category": "webhooks", - "subcategory": "repos", - "originalUrl": "/rest/reference/repos#create-a-repository-webhook" - }, - "repos/get-webhook": { - "category": "webhooks", - "subcategory": "repos", - "originalUrl": "/rest/reference/repos#get-a-repository-webhook" - }, - "repos/update-webhook": { - "category": "webhooks", - "subcategory": "repos", - "originalUrl": "/rest/reference/repos#update-a-repository-webhook" - }, - "repos/delete-webhook": { - "category": "webhooks", - "subcategory": "repos", - "originalUrl": "/rest/reference/repos#delete-a-repository-webhook" - }, - "repos/ping-webhook": { - "category": "webhooks", - "subcategory": "repos", - "originalUrl": "/rest/reference/repos#ping-a-repository-webhook" - }, - "repos/test-push-webhook": { - "category": "webhooks", - "subcategory": "repos", - "originalUrl": "/rest/reference/repos#test-the-push-repository-webhook" - }, - "repos/get-webhook-config-for-repo": { - "category": "webhooks", - "subcategory": "repo-config", - "originalUrl": "/rest/reference/repos#get-a-webhook-configuration-for-a-repository" - }, - "repos/update-webhook-config-for-repo": { - "category": "webhooks", - "subcategory": "repo-config", - "originalUrl": "/rest/reference/repos#update-a-webhook-configuration-for-a-repository" - }, - "repos/get-webhook-delivery": { - "category": "webhooks", - "subcategory": "repo-deliveries", - "originalUrl": "/rest/reference/repos#get-a-delivery-for-a-repository-webhook" - }, - "repos/list-webhook-deliveries": { - "category": "webhooks", - "subcategory": "repo-deliveries", - "originalUrl": "/rest/reference/repos#list-deliveries-for-a-repository-webhook" - }, - "repos/redeliver-webhook-delivery": { - "category": "webhooks", - "subcategory": "repo-deliveries", - "originalUrl": "/rest/reference/repos#redeliver-a-delivery-for-a-repository-webhook" - }, - "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" - }, - "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" - }, - "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" - }, - "enterprise-admin/create-registration-token-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise" - }, - "enterprise-admin/create-remove-token-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise" - }, - "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise" - }, - "enterprise-admin/delete-self-hosted-runner-from-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise" - }, - "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise" - }, - "enterprise-admin/disable-selected-organization-github-actions-enterprise": { - "category": "actions", - "subcategory": "permissions", - "originalUrl": "/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" - }, - "enterprise-admin/enable-selected-organization-github-actions-enterprise": { - "category": "actions", - "subcategory": "permissions", - "originalUrl": "/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" - }, - "enterprise-admin/get-allowed-actions-enterprise": { - "category": "actions", - "subcategory": "permissions", - "originalUrl": "/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" - }, - "enterprise-admin/get-github-actions-permissions-enterprise": { - "category": "actions", - "subcategory": "permissions", - "originalUrl": "/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" - }, - "enterprise-admin/get-self-hosted-runner-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise" - }, - "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise" - }, - "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#list-labels-for-a-self-hosted-runner-for-an-enterprise" - }, - "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise" - }, - "enterprise-admin/list-runner-applications-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise" - }, - "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { - "category": "actions", - "subcategory": "permissions", - "originalUrl": "/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" - }, - "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise" - }, - "enterprise-admin/list-self-hosted-runners-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise" - }, - "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise" - }, - "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" - }, - "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" - }, - "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" - }, - "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" - }, - "enterprise-admin/set-allowed-actions-enterprise": { - "category": "actions", - "subcategory": "permissions", - "originalUrl": "/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" - }, - "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runners", - "originalUrl": "/rest/reference/enterprise-admin#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" - }, - "enterprise-admin/set-github-actions-permissions-enterprise": { - "category": "actions", - "subcategory": "permissions", - "originalUrl": "/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" - }, - "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" - }, - "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { - "category": "actions", - "subcategory": "permissions", - "originalUrl": "/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" - }, - "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise" - }, - "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { - "category": "actions", - "subcategory": "self-hosted-runner-groups", - "originalUrl": "/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise" + "operationUrls": { + "repos/list-collaborators": { + "category": "collaborators", + "subcategory": "collaborators", + "originalUrl": "/rest/reference/repos#list-repository-collaborators" + }, + "repos/check-collaborator": { + "category": "collaborators", + "subcategory": "collaborators", + "originalUrl": "/rest/reference/repos#check-if-a-user-is-a-repository-collaborator" + }, + "repos/add-collaborator": { + "category": "collaborators", + "subcategory": "collaborators", + "originalUrl": "/rest/reference/repos#add-a-repository-collaborator" + }, + "repos/remove-collaborator": { + "category": "collaborators", + "subcategory": "collaborators", + "originalUrl": "/rest/reference/repos#remove-a-repository-collaborator" + }, + "repos/get-collaborator-permission-level": { + "category": "collaborators", + "subcategory": "collaborators", + "originalUrl": "/rest/reference/repos#get-repository-permissions-for-a-user" + }, + "repos/list-commit-comments-for-repo": { + "category": "commits", + "subcategory": "comments", + "originalUrl": "/rest/reference/repos#list-commit-comments-for-a-repository" + }, + "repos/get-commit-comment": { + "category": "commits", + "subcategory": "comments", + "originalUrl": "/rest/reference/repos#get-a-commit-comment" + }, + "repos/update-commit-comment": { + "category": "commits", + "subcategory": "comments", + "originalUrl": "/rest/reference/repos#update-a-commit-comment" + }, + "repos/delete-commit-comment": { + "category": "commits", + "subcategory": "comments", + "originalUrl": "/rest/reference/repos#delete-a-commit-comment" + }, + "repos/list-commits": { + "category": "commits", + "subcategory": "commits", + "originalUrl": "/rest/reference/repos#list-commits" + }, + "repos/list-branches-for-head-commit": { + "category": "commits", + "subcategory": "commits", + "originalUrl": "/rest/reference/repos#list-branches-for-head-commit" + }, + "repos/list-comments-for-commit": { + "category": "commits", + "subcategory": "comments", + "originalUrl": "/rest/reference/repos#list-commit-comments" + }, + "repos/create-commit-comment": { + "category": "commits", + "subcategory": "comments", + "originalUrl": "/rest/reference/repos#create-a-commit-comment" + }, + "repos/list-pull-requests-associated-with-commit": { + "category": "commits", + "subcategory": "commits", + "originalUrl": "/rest/reference/repos#list-pull-requests-associated-with-a-commit" + }, + "repos/get-commit": { + "category": "commits", + "subcategory": "commits", + "originalUrl": "/rest/reference/repos#get-a-commit" + }, + "repos/get-combined-status-for-ref": { + "category": "commits", + "subcategory": "statuses", + "originalUrl": "/rest/reference/repos#get-the-combined-status-for-a-specific-reference" + }, + "repos/list-commit-statuses-for-ref": { + "category": "commits", + "subcategory": "statuses", + "originalUrl": "/rest/reference/repos#list-commit-statuses-for-a-reference" + }, + "repos/get-community-profile-metrics": { + "category": "metrics", + "subcategory": "community", + "originalUrl": "/rest/reference/repos#get-community-profile-metrics" + }, + "repos/compare-commits": { + "category": "commits", + "subcategory": "commits", + "originalUrl": "/rest/reference/repos#compare-two-commits" + }, + "repos/get-all-environments": { + "category": "deployments", + "subcategory": "environments", + "originalUrl": "/rest/reference/repos#get-all-environments" + }, + "repos/get-environment": { + "category": "deployments", + "subcategory": "environments", + "originalUrl": "/rest/reference/repos#get-an-environment" + }, + "repos/create-or-update-environment": { + "category": "deployments", + "subcategory": "environments", + "originalUrl": "/rest/reference/repos#create-or-update-an-environment" + }, + "repos/delete-an-environment": { + "category": "deployments", + "subcategory": "environments", + "originalUrl": "/rest/reference/repos#delete-an-environment" + }, + "repos/list-invitations": { + "category": "collaborators", + "subcategory": "invitations", + "originalUrl": "/rest/reference/repos#list-repository-invitations" + }, + "repos/update-invitation": { + "category": "collaborators", + "subcategory": "invitations", + "originalUrl": "/rest/reference/repos#update-a-repository-invitation" + }, + "repos/delete-invitation": { + "category": "collaborators", + "subcategory": "invitations", + "originalUrl": "/rest/reference/repos#delete-a-repository-invitation" + }, + "repos/list-deploy-keys": { + "category": "deploy-keys", + "subcategory": null, + "originalUrl": "/rest/reference/repos#list-deploy-keys" + }, + "repos/create-deploy-key": { + "category": "deploy-keys", + "subcategory": null, + "originalUrl": "/rest/reference/repos#create-a-deploy-key" + }, + "repos/get-deploy-key": { + "category": "deploy-keys", + "subcategory": null, + "originalUrl": "/rest/reference/repos#get-a-deploy-key" + }, + "repos/delete-deploy-key": { + "category": "deploy-keys", + "subcategory": null, + "originalUrl": "/rest/reference/repos#delete-a-deploy-key" + }, + "repos/get-pages": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#get-a-github-pages-site" + }, + "repos/create-pages-site": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#create-a-github-pages-site" + }, + "repos/update-information-about-pages-site": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#update-information-about-a-github-pages-site" + }, + "repos/delete-pages-site": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#delete-a-github-pages-site" + }, + "repos/list-pages-builds": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#list-github-pages-builds" + }, + "repos/request-pages-build": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#request-a-github-pages-build" + }, + "repos/get-latest-pages-build": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#get-latest-pages-build" + }, + "repos/get-pages-build": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#get-github-pages-build" + }, + "repos/get-pages-health-check": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#get-a-dns-health-check-for-github-pages" + }, + "repos/get-code-frequency-stats": { + "category": "metrics", + "subcategory": "statistics", + "originalUrl": "/rest/reference/repos#get-the-weekly-commit-activity" + }, + "repos/get-commit-activity-stats": { + "category": "metrics", + "subcategory": "statistics", + "originalUrl": "/rest/reference/repos#get-the-last-year-of-commit-activity" + }, + "repos/get-contributors-stats": { + "category": "metrics", + "subcategory": "statistics", + "originalUrl": "/rest/reference/repos#get-all-contributor-commit-activity" + }, + "repos/get-participation-stats": { + "category": "metrics", + "subcategory": "statistics", + "originalUrl": "/rest/reference/repos#get-the-weekly-commit-count" + }, + "repos/get-punch-card-stats": { + "category": "metrics", + "subcategory": "statistics", + "originalUrl": "/rest/reference/repos#get-the-hourly-commit-count-for-each-day" + }, + "repos/create-commit-status": { + "category": "commits", + "subcategory": "statuses", + "originalUrl": "/rest/reference/repos#create-a-commit-status" + }, + "repos/get-clones": { + "category": "metrics", + "subcategory": "traffic", + "originalUrl": "/rest/reference/repos#get-repository-clones" + }, + "repos/get-top-paths": { + "category": "metrics", + "subcategory": "traffic", + "originalUrl": "/rest/reference/repos#get-top-referral-paths" + }, + "repos/get-top-referrers": { + "category": "metrics", + "subcategory": "traffic", + "originalUrl": "/rest/reference/repos#get-top-referral-sources" + }, + "repos/get-views": { + "category": "metrics", + "subcategory": "traffic", + "originalUrl": "/rest/reference/repos#get-page-views" + }, + "repos/list-invitations-for-authenticated-user": { + "category": "collaborators", + "subcategory": "invitations", + "originalUrl": "/rest/reference/repos#list-repository-invitations-for-the-authenticated-user" + }, + "repos/accept-invitation-for-authenticated-user": { + "category": "collaborators", + "subcategory": "invitations", + "originalUrl": "/rest/reference/repos#accept-a-repository-invitation" + }, + "repos/decline-invitation-for-authenticated-user": { + "category": "collaborators", + "subcategory": "invitations", + "originalUrl": "/rest/reference/repos#decline-a-repository-invitation" + }, + "repos/list-branches": { + "category": "branches", + "subcategory": "branches", + "originalUrl": "/rest/reference/repos#list-branches" + }, + "repos/get-branch": { + "category": "branches", + "subcategory": "branches", + "originalUrl": "/rest/reference/repos#get-a-branch" + }, + "repos/rename-branch": { + "category": "branches", + "subcategory": "branches", + "originalUrl": "/rest/reference/repos#rename-a-branch" + }, + "repos/merge-upstream": { + "category": "branches", + "subcategory": "branches", + "originalUrl": "/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository" + }, + "repos/merge": { + "category": "branches", + "subcategory": "branches", + "originalUrl": "/rest/reference/repos#merge-a-branch" + }, + "repos/add-app-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#add-app-access-restrictions" + }, + "repos/add-status-check-contexts": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#add-status-check-contexts" + }, + "repos/add-team-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#add-team-access-restrictions" + }, + "repos/add-user-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#add-user-access-restrictions" + }, + "repos/create-commit-signature-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#create-commit-signature-protection" + }, + "repos/delete-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#delete-access-restrictions" + }, + "repos/delete-admin-branch-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#delete-admin-branch-protection" + }, + "repos/delete-branch-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#delete-branch-protection" + }, + "repos/delete-commit-signature-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#delete-commit-signature-protection" + }, + "repos/delete-pull-request-review-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#delete-pull-request-review-protection" + }, + "repos/get-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#get-access-restrictions" + }, + "repos/get-admin-branch-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#get-admin-branch-protection" + }, + "repos/get-all-status-check-contexts": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#get-all-status-check-contexts" + }, + "repos/get-apps-with-access-to-protected-branch": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#list-apps-with-access-to-the-protected-branch" + }, + "repos/update-pull-request-review-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#update-pull-request-review-protection" + }, + "repos/get-branch-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#get-branch-protection" + }, + "repos/get-commit-signature-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#get-commit-signature-protection" + }, + "repos/get-pull-request-review-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#get-pull-request-review-protection" + }, + "repos/get-status-checks-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#get-status-checks-protection" + }, + "repos/get-teams-with-access-to-protected-branch": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#list-teams-with-access-to-the-protected-branch" + }, + "repos/get-users-with-access-to-protected-branch": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#list-users-with-access-to-the-protected-branch" + }, + "repos/remove-app-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#remove-app-access-restrictions" + }, + "repos/remove-status-check-contexts": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#remove-status-check-contexts" + }, + "repos/remove-status-check-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#remove-status-check-protection" + }, + "repos/remove-team-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#remove-team-access-restrictions" + }, + "repos/remove-user-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#remove-user-access-restrictions" + }, + "repos/set-admin-branch-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#set-admin-branch-protection" + }, + "repos/set-app-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#set-app-access-restrictions" + }, + "repos/set-status-check-contexts": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#set-status-check-contexts" + }, + "repos/set-team-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#set-team-access-restrictions" + }, + "repos/set-user-access-restrictions": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#set-user-access-restrictions" + }, + "repos/update-branch-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#update-branch-protection" + }, + "repos/update-status-check-protection": { + "category": "branches", + "subcategory": "branch-protection", + "originalUrl": "/rest/reference/repos#update-status-check-protection" + }, + "repos/create-deployment-status": { + "category": "deployments", + "subcategory": "statuses", + "originalUrl": "/rest/reference/repos#create-a-deployment-status" + }, + "repos/list-deployment-statuses": { + "category": "deployments", + "subcategory": "statuses", + "originalUrl": "/rest/reference/repos#list-deployment-statuses" + }, + "repos/get-deployment-status": { + "category": "deployments", + "subcategory": "statuses", + "originalUrl": "/rest/reference/repos#get-a-deployment-status" + }, + "repos/list-deployments": { + "category": "deployments", + "subcategory": "deployments", + "originalUrl": "/rest/reference/repos#list-deployments" + }, + "repos/create-deployment": { + "category": "deployments", + "subcategory": "deployments", + "originalUrl": "/rest/reference/repos#create-a-deployment" + }, + "repos/get-deployment": { + "category": "deployments", + "subcategory": "deployments", + "originalUrl": "/rest/reference/repos#get-a-deployment" + }, + "repos/delete-deployment": { + "category": "deployments", + "subcategory": "deployments", + "originalUrl": "/rest/reference/repos#delete-a-deployment" + }, + "repos/list-releases": { + "category": "releases", + "subcategory": "releases", + "originalUrl": "/rest/reference/repos#list-releases" + }, + "repos/create-release": { + "category": "releases", + "subcategory": "releases", + "originalUrl": "/rest/reference/repos#create-a-release" + }, + "repos/generate-release-notes": { + "category": "releases", + "subcategory": "releases", + "originalUrl": "/rest/reference/repos#generate-release-notes" + }, + "repos/get-latest-release": { + "category": "releases", + "subcategory": "releases", + "originalUrl": "/rest/reference/repos#get-the-latest-release" + }, + "repos/get-release-by-tag": { + "category": "releases", + "subcategory": "releases", + "originalUrl": "/rest/reference/repos#get-a-release-by-tag-name" + }, + "repos/get-release": { + "category": "releases", + "subcategory": "releases", + "originalUrl": "/rest/reference/repos#get-a-release" + }, + "repos/update-release": { + "category": "releases", + "subcategory": "releases", + "originalUrl": "/rest/reference/repos#update-a-release" + }, + "repos/delete-release": { + "category": "releases", + "subcategory": "releases", + "originalUrl": "/rest/reference/repos#delete-a-release" + }, + "repos/delete-release-asset": { + "category": "releases", + "subcategory": "assets", + "originalUrl": "/rest/reference/repos#delete-a-release-asset" + }, + "repos/get-release-asset": { + "category": "releases", + "subcategory": "assets", + "originalUrl": "/rest/reference/repos#get-a-release-asset" + }, + "repos/list-release-assets": { + "category": "releases", + "subcategory": "assets", + "originalUrl": "/rest/reference/repos#list-release-assets" + }, + "repos/update-release-asset": { + "category": "releases", + "subcategory": "assets", + "originalUrl": "/rest/reference/repos#update-a-release-asset" + }, + "repos/upload-release-asset": { + "category": "releases", + "subcategory": "assets", + "originalUrl": "/rest/reference/repos#upload-a-release-asset" + }, + "repos/list-webhooks": { + "category": "webhooks", + "subcategory": "repos", + "originalUrl": "/rest/reference/repos#list-repository-webhooks" + }, + "repos/create-webhook": { + "category": "webhooks", + "subcategory": "repos", + "originalUrl": "/rest/reference/repos#create-a-repository-webhook" + }, + "repos/get-webhook": { + "category": "webhooks", + "subcategory": "repos", + "originalUrl": "/rest/reference/repos#get-a-repository-webhook" + }, + "repos/update-webhook": { + "category": "webhooks", + "subcategory": "repos", + "originalUrl": "/rest/reference/repos#update-a-repository-webhook" + }, + "repos/delete-webhook": { + "category": "webhooks", + "subcategory": "repos", + "originalUrl": "/rest/reference/repos#delete-a-repository-webhook" + }, + "repos/ping-webhook": { + "category": "webhooks", + "subcategory": "repos", + "originalUrl": "/rest/reference/repos#ping-a-repository-webhook" + }, + "repos/test-push-webhook": { + "category": "webhooks", + "subcategory": "repos", + "originalUrl": "/rest/reference/repos#test-the-push-repository-webhook" + }, + "repos/get-webhook-config-for-repo": { + "category": "webhooks", + "subcategory": "repo-config", + "originalUrl": "/rest/reference/repos#get-a-webhook-configuration-for-a-repository" + }, + "repos/update-webhook-config-for-repo": { + "category": "webhooks", + "subcategory": "repo-config", + "originalUrl": "/rest/reference/repos#update-a-webhook-configuration-for-a-repository" + }, + "repos/get-webhook-delivery": { + "category": "webhooks", + "subcategory": "repo-deliveries", + "originalUrl": "/rest/reference/repos#get-a-delivery-for-a-repository-webhook" + }, + "repos/list-webhook-deliveries": { + "category": "webhooks", + "subcategory": "repo-deliveries", + "originalUrl": "/rest/reference/repos#list-deliveries-for-a-repository-webhook" + }, + "repos/redeliver-webhook-delivery": { + "category": "webhooks", + "subcategory": "repo-deliveries", + "originalUrl": "/rest/reference/repos#redeliver-a-delivery-for-a-repository-webhook" + }, + "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" + }, + "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" + }, + "enterprise-admin/create-registration-token-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise" + }, + "enterprise-admin/create-remove-token-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise" + }, + "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise" + }, + "enterprise-admin/delete-self-hosted-runner-from-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise" + }, + "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise" + }, + "enterprise-admin/disable-selected-organization-github-actions-enterprise": { + "category": "actions", + "subcategory": "permissions", + "originalUrl": "/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "enterprise-admin/enable-selected-organization-github-actions-enterprise": { + "category": "actions", + "subcategory": "permissions", + "originalUrl": "/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "enterprise-admin/get-allowed-actions-enterprise": { + "category": "actions", + "subcategory": "permissions", + "originalUrl": "/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" + }, + "enterprise-admin/get-github-actions-permissions-enterprise": { + "category": "actions", + "subcategory": "permissions", + "originalUrl": "/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" + }, + "enterprise-admin/get-self-hosted-runner-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise" + }, + "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise" + }, + "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#list-labels-for-a-self-hosted-runner-for-an-enterprise" + }, + "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise" + }, + "enterprise-admin/list-runner-applications-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise" + }, + "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { + "category": "actions", + "subcategory": "permissions", + "originalUrl": "/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise" + }, + "enterprise-admin/list-self-hosted-runners-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise" + }, + "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" + }, + "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" + }, + "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + }, + "enterprise-admin/set-allowed-actions-enterprise": { + "category": "actions", + "subcategory": "permissions", + "originalUrl": "/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" + }, + "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runners", + "originalUrl": "/rest/reference/enterprise-admin#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" + }, + "enterprise-admin/set-github-actions-permissions-enterprise": { + "category": "actions", + "subcategory": "permissions", + "originalUrl": "/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" + }, + "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + }, + "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { + "category": "actions", + "subcategory": "permissions", + "originalUrl": "/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "originalUrl": "/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise" + }, + "orgs/list-custom-roles": { + "category": "orgs", + "subcategory": "custom-roles", + "originalUrl": "/rest/reference/orgs#list-custom-repository-roles-in-an-organization" + } + }, + "sectionUrls": { + "/rest/repos#deploy-keys": "/rest/deploy-keys", + "/rest/deployments#deploy-keys": "/rest/deploy-keys" } } diff --git a/stylesheets/utilities.scss b/stylesheets/utilities.scss index 79c90ba72d..5dcdffb661 100644 --- a/stylesheets/utilities.scss +++ b/stylesheets/utilities.scss @@ -24,10 +24,6 @@ .no-print { display: none; } - - .print-overflow-visible { - overflow: visible !important; - } } /* Opacity utilities diff --git a/tests/fixtures/developer-redirects.json b/tests/fixtures/developer-redirects.json index 45efcb332c..9a71ef1421 100644 --- a/tests/fixtures/developer-redirects.json +++ b/tests/fixtures/developer-redirects.json @@ -11,13 +11,13 @@ "/marketplace/listing-on-github-marketplace": "/en/developers/github-marketplace/listing-an-app-on-github-marketplace", "/marketplace/selling-your-app": "/en/developers/github-marketplace/selling-your-app-on-github-marketplace", "/v3": "/en/rest", - "/v3/actions/workflow-jobs": "/en/rest/reference/actions#workflow-jobs", - "/v3/actions/workflow-runs": "/en/rest/reference/actions#workflow-runs", - "/v3/actions/workflow_jobs": "/en/rest/reference/actions#workflow-jobs", - "/v3/actions/workflow_runs": "/en/rest/reference/actions#workflow-runs", + "/v3/actions/workflow-jobs": "/en/rest/actions/workflow-jobs", + "/v3/actions/workflow-runs": "/en/rest/actions/workflow-runs", + "/v3/actions/workflow_jobs": "/en/rest/actions/workflow-jobs", + "/v3/actions/workflow_runs": "/en/rest/actions/workflow-runs", "/v3/guides": "/en/rest/guides", "/v3/guides/managing-deploy-keys": "/en/developers/overview/managing-deploy-keys", - "/v3/misc": "/en/rest/reference/emojis", + "/v3/misc": "/en/rest/emojis", "/v4/public_schema": "/en/graphql/overview/public-schema", "/v4/object/repository": "/en/graphql/reference/objects#repository", "/webhooks": "/en/developers/webhooks-and-events/webhooks/about-webhooks", diff --git a/tests/fixtures/rest-redirects.json b/tests/fixtures/rest-redirects.json index 63cd224943..d95bb785c5 100644 --- a/tests/fixtures/rest-redirects.json +++ b/tests/fixtures/rest-redirects.json @@ -385,122 +385,122 @@ "/en/enterprise/2.21/v3/users/gpg_keys": "/en/enterprise-server@2.21/rest/reference/users#gpg-keys", "/en/enterprise/2.21/v3/users": "/en/enterprise-server@2.21/rest/reference/users", "/en/enterprise/2.21/v3/users/keys": "/en/enterprise-server@2.21/rest/reference/users#keys", - "/v3/actions/artifacts": "/en/rest/reference/actions#artifacts", - "/v3/actions": "/en/rest/reference/actions", - "/v3/actions/secrets": "/en/rest/reference/actions#secrets", - "/v3/actions/self-hosted-runners": "/en/rest/reference/actions#self-hosted-runners", - "/v3/actions/self_hosted_runners": "/en/rest/reference/actions#self-hosted-runners", - "/v3/actions/workflow-jobs": "/en/rest/reference/actions#workflow-jobs", - "/v3/actions/workflow-runs": "/en/rest/reference/actions#workflow-runs", - "/v3/actions/workflows": "/en/rest/reference/actions#workflows", + "/v3/actions/artifacts": "/en/rest/actions/artifacts", + "/v3/actions": "/en/rest/actions", + "/v3/actions/secrets": "/en/rest/actions/secrets", + "/v3/actions/self-hosted-runners": "/en/rest/actions/self-hosted-runners", + "/v3/actions/self_hosted_runners": "/en/rest/actions/self-hosted-runners", + "/v3/actions/workflow-jobs": "/en/rest/actions/workflow-jobs", + "/v3/actions/workflow-runs": "/en/rest/actions/workflow-runs", + "/v3/actions/workflows": "/en/rest/actions/workflows", "/v3/activity/event_types": "/en/developers/webhooks-and-events/events/github-event-types", "/v3/activity/events/types": "/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads", - "/v3/activity/events": "/en/rest/reference/activity#events", - "/v3/activity/feeds": "/en/rest/reference/activity#feeds", - "/v3/activity": "/en/rest/reference/activity", - "/v3/activity/notifications": "/en/rest/reference/activity#notifications", - "/v3/activity/starring": "/en/rest/reference/activity#starring", - "/v3/activity/watching": "/en/rest/reference/activity#watching", + "/v3/activity/events": "/en/rest/activity/events", + "/v3/activity/feeds": "/en/rest/activity/feeds", + "/v3/activity": "/en/rest/activity", + "/v3/activity/notifications": "/en/rest/activity/notifications", + "/v3/activity/starring": "/en/rest/activity/starring", + "/v3/activity/watching": "/en/rest/activity/watching", "/v3/apps/available-endpoints": "/en/rest/overview/endpoints-available-for-github-apps", - "/v3/apps": "/en/rest/reference/apps", - "/v3/apps/installations": "/en/rest/reference/apps#installations", - "/v3/apps/marketplace": "/en/rest/reference/apps#marketplace", - "/v3/apps/oauth_applications": "/en/rest/reference/apps#oauth-applications", + "/v3/apps": "/en/rest/apps", + "/v3/apps/installations": "/en/rest/apps/installations", + "/v3/apps/marketplace": "/en/rest/apps/marketplace", + "/v3/apps/oauth_applications": "/en/rest/apps/oauth-applications", "/v3/apps/permissions": "/en/rest/overview/permissions-required-for-github-apps", - "/v3/checks": "/en/rest/reference/checks", - "/v3/checks/runs": "/en/rest/reference/checks#runs", - "/v3/checks/suites": "/en/rest/reference/checks#suites", - "/v3/code-scanning": "/en/rest/reference/code-scanning", - "/v3/codes_of_conduct": "/en/rest/reference/codes-of-conduct", - "/v3/emojis": "/en/rest/reference/emojis", - "/v3/enterprise-admin": "/en/rest/reference/enterprise-admin", - "/v3/enterprise-admin/admin_stats": "/en/enterprise-server/rest/reference/enterprise-admin#admin-stats", - "/v3/enterprise-admin/global_webhooks": "/en/enterprise-server/rest/reference/enterprise-admin#global-webhooks", - "/v3/enterprise-admin/ldap": "/en/enterprise-server/rest/reference/enterprise-admin#ldap", - "/v3/enterprise-admin/license": "/en/enterprise-server/rest/reference/enterprise-admin#license", - "/v3/enterprise-admin/management_console": "/en/enterprise-server/rest/reference/enterprise-admin#management-console", - "/v3/enterprise-admin/orgs": "/en/enterprise-server/rest/reference/enterprise-admin#orgs", - "/v3/enterprise-admin/pre_receive_environments": "/en/enterprise-server/rest/reference/enterprise-admin#pre-receive-environments", - "/v3/enterprise-admin/pre_receive_hooks": "/en/enterprise-server/rest/reference/enterprise-admin#pre-receive-hooks", - "/v3/enterprise-admin/search_indexing": "/en/enterprise-server/rest/reference/enterprise-admin#search-indexing", - "/v3/enterprise-admin/users": "/en/enterprise-server/rest/reference/enterprise-admin#users", - "/v3/gists/comments": "/en/rest/reference/gists#comments", - "/v3/gists": "/en/rest/reference/gists", - "/v3/git/blobs": "/en/rest/reference/git#blobs", - "/v3/git/commits": "/en/rest/reference/git#commits", - "/v3/git": "/en/rest/reference/git", - "/v3/git/refs": "/en/rest/reference/git#refs", - "/v3/git/tags": "/en/rest/reference/git#tags", - "/v3/git/trees": "/en/rest/reference/git#trees", - "/v3/gitignore": "/en/rest/reference/gitignore", - "/v3/interactions": "/en/rest/reference/interactions", - "/v3/interactions/orgs": "/en/rest/reference/interactions#orgs", - "/v3/interactions/repos": "/en/rest/reference/interactions#repos", - "/v3/issues/assignees": "/en/rest/reference/issues#assignees", - "/v3/issues/comments": "/en/rest/reference/issues#comments", - "/v3/issues/events": "/en/rest/reference/issues#events", - "/v3/issues": "/en/rest/reference/issues", + "/v3/checks": "/en/rest/checks", + "/v3/checks/runs": "/en/rest/checks/runs", + "/v3/checks/suites": "/en/rest/checks/suites", + "/v3/code-scanning": "/en/rest/code-scanning", + "/v3/codes_of_conduct": "/en/rest/codes-of-conduct", + "/v3/emojis": "/en/rest/emojis", + "/v3/enterprise-admin": "/en/rest/enterprise-admin", + "/v3/enterprise-admin/admin_stats": "/en/enterprise-server/rest/enterprise-admin/admin-stats", + "/v3/enterprise-admin/global_webhooks": "/en/enterprise-server/rest/enterprise-admin/global-webhooks", + "/v3/enterprise-admin/ldap": "/en/enterprise-server/rest/enterprise-admin/ldap", + "/v3/enterprise-admin/license": "/en/enterprise-server/rest/enterprise-admin/license", + "/v3/enterprise-admin/management_console": "/en/enterprise-server/rest/enterprise-admin/management-console", + "/v3/enterprise-admin/orgs": "/en/enterprise-server/rest/enterprise-admin/orgs", + "/v3/enterprise-admin/pre_receive_environments": "/en/enterprise-server/rest/enterprise-admin/pre-receive-environments", + "/v3/enterprise-admin/pre_receive_hooks": "/en/enterprise-server/rest/enterprise-admin/pre-receive-hooks", + "/v3/enterprise-admin/search_indexing": "/en/enterprise-server/rest/enterprise-admin", + "/v3/enterprise-admin/users": "/en/enterprise-server/rest/enterprise-admin/users", + "/v3/gists/comments": "/en/rest/gists/comments", + "/v3/gists": "/en/rest/gists", + "/v3/git/blobs": "/en/rest/git/blobs", + "/v3/git/commits": "/en/rest/git/commits", + "/v3/git": "/en/rest/git", + "/v3/git/refs": "/en/rest/git/refs", + "/v3/git/tags": "/en/rest/git/tags", + "/v3/git/trees": "/en/rest/git/trees", + "/v3/gitignore": "/en/rest/gitignore", + "/v3/interactions": "/en/rest/interactions", + "/v3/interactions/orgs": "/en/rest/interactions/orgs", + "/v3/interactions/repos": "/en/rest/interactions/repos", + "/v3/issues/assignees": "/en/rest/issues/assignees", + "/v3/issues/comments": "/en/rest/issues/comments", + "/v3/issues/events": "/en/rest/issues/events", + "/v3/issues": "/en/rest/issues", "/v3/issues/issue-event-types": "/en/developers/webhooks-and-events/events/issue-event-types", - "/v3/issues/labels": "/en/rest/reference/issues#labels", - "/v3/issues/milestones": "/en/rest/reference/issues#milestones", - "/v3/issues/timeline": "/en/rest/reference/issues#timeline", - "/v3/licenses": "/en/rest/reference/licenses", - "/v3/markdown": "/en/rest/reference/markdown", - "/v3/meta": "/en/rest/reference/meta", - "/v3/migrations": "/en/rest/reference/migrations", - "/v3/migrations/orgs": "/en/rest/reference/migrations#orgs", - "/v3/migrations/source_imports": "/en/rest/reference/migrations#source-imports", - "/v3/migrations/users": "/en/rest/reference/migrations#users", - "/v3/oauth_authorizations": "/en/enterprise-server/rest/reference/oauth-authorizations", - "/v3/orgs/blocking": "/en/rest/reference/orgs#blocking", - "/v3/orgs/hooks": "/en/rest/reference/orgs#webhooks", - "/v3/orgs": "/en/rest/reference/orgs", - "/v3/orgs/members": "/en/rest/reference/orgs#members", - "/v3/orgs/migrations": "/en/rest/reference/orgs#migrations", - "/v3/orgs/outside_collaborators": "/en/rest/reference/orgs#outside-collaborators", - "/v3/orgs/pre_receive_hooks": "/en/enterprise-server/rest/reference/enterprise-admin#organization-pre-receive-hooks", - "/v3/orgs/teams": "/en/rest/reference/orgs#teams", - "/v3/projects/cards": "/en/rest/reference/projects#cards", - "/v3/projects/collaborators": "/en/rest/reference/projects#collaborators", - "/v3/projects/columns": "/en/rest/reference/projects#columns", - "/v3/projects": "/en/rest/reference/projects", - "/v3/pulls/comments": "/en/rest/reference/pulls#comments", - "/v3/pulls": "/en/rest/reference/pulls", - "/v3/pulls/review_requests": "/en/rest/reference/pulls#review-requests", - "/v3/pulls/reviews": "/en/rest/reference/pulls#reviews", - "/v3/rate_limit": "/en/rest/reference/rate-limit", - "/v3/reactions": "/en/rest/reference/reactions", - "/v3/repos/branches": "/en/rest/reference/repos#branches", - "/v3/repos/collaborators": "/en/rest/reference/repos#collaborators", - "/v3/repos/comments": "/en/rest/reference/repos#comments", - "/v3/repos/commits": "/en/rest/reference/repos#commits", - "/v3/repos/community": "/en/rest/reference/repos#community", - "/v3/repos/contents": "/en/rest/reference/repos#contents", - "/v3/repos/deployments": "/en/rest/reference/repos#deployments", - "/v3/repos/downloads": "/en/rest/reference/repos#downloads", - "/v3/repos/forks": "/en/rest/reference/repos#forks", - "/v3/repos/hooks": "/en/rest/reference/repos#webhooks", - "/v3/repos": "/en/rest/reference/repos", - "/v3/repos/invitations": "/en/rest/reference/repos#invitations", - "/v3/repos/keys": "/en/rest/reference/repos#keys", - "/v3/repos/merging": "/en/rest/reference/repos#merging", - "/v3/repos/pages": "/en/rest/reference/repos#pages", - "/v3/repos/pre_receive_hooks": "/en/enterprise-server/rest/reference/enterprise-admin#repository-pre-receive-hooks", - "/v3/repos/releases": "/en/rest/reference/repos#releases", - "/v3/repos/statistics": "/en/rest/reference/repos#statistics", - "/v3/repos/statuses": "/en/rest/reference/repos#statuses", - "/v3/repos/traffic": "/en/rest/reference/repos#traffic", - "/v3/scim": "/en/rest/reference/scim", - "/v3/search": "/en/rest/reference/search", - "/v3/teams/discussion_comments": "/en/rest/reference/teams#discussion-comments", - "/v3/teams/discussions": "/en/rest/reference/teams#discussions", - "/v3/teams": "/en/rest/reference/teams", - "/v3/teams/members": "/en/rest/reference/teams#members", - "/v3/teams/team_sync": "/en/rest/reference/teams#team-sync", - "/v3/users/blocking": "/en/rest/reference/users#blocking", - "/v3/users/emails": "/en/rest/reference/users#emails", - "/v3/users/followers": "/en/rest/reference/users#followers", - "/v3/users/gpg_keys": "/en/rest/reference/users#gpg-keys", - "/v3/users": "/en/rest/reference/users", - "/v3/users/keys": "/en/rest/reference/users#keys" + "/v3/issues/labels": "/en/rest/issues/labels", + "/v3/issues/milestones": "/en/rest/issues/milestones", + "/v3/issues/timeline": "/en/rest/issues/timeline", + "/v3/licenses": "/en/rest/licenses", + "/v3/markdown": "/en/rest/markdown", + "/v3/meta": "/en/rest/meta", + "/v3/migrations": "/en/rest/migrations", + "/v3/migrations/orgs": "/en/rest/migrations/orgs", + "/v3/migrations/source_imports": "/en/rest/migrations/source-imports", + "/v3/migrations/users": "/en/rest/migrations/users", + "/v3/oauth_authorizations": "/en/enterprise-server/rest/oauth-authorizations", + "/v3/orgs/blocking": "/en/rest/orgs/blocking", + "/v3/orgs/hooks": "/en/rest/orgs/webhooks", + "/v3/orgs": "/en/rest/orgs", + "/v3/orgs/members": "/en/rest/orgs/members", + "/v3/orgs/migrations": "/en/rest/migrations/orgs", + "/v3/orgs/outside_collaborators": "/en/rest/orgs/outside-collaborators", + "/v3/orgs/pre_receive_hooks": "/en/enterprise-server/rest/enterprise-admin/org-pre-receive-hooks", + "/v3/orgs/teams": "/en/rest/teams/teams", + "/v3/projects/cards": "/en/rest/projects/cards", + "/v3/projects/collaborators": "/en/rest/projects/collaborators", + "/v3/projects/columns": "/en/rest/projects/columns", + "/v3/projects": "/en/rest/projects", + "/v3/pulls/comments": "/en/rest/pulls/comments", + "/v3/pulls": "/en/rest/pulls", + "/v3/pulls/review_requests": "/en/rest/pulls/review-requests", + "/v3/pulls/reviews": "/en/rest/pulls/reviews", + "/v3/rate_limit": "/en/rest/rate-limit", + "/v3/reactions": "/en/rest/reactions", + "/v3/repos/branches": "/en/rest/branches/branches", + "/v3/repos/collaborators": "/en/rest/collaborators/collaborators", + "/v3/repos/comments": "/en/rest/commits/comments", + "/v3/repos/commits": "/en/rest/commits/commits", + "/v3/repos/community": "/en/rest/metrics/community", + "/v3/repos/contents": "/en/rest/repos/contents", + "/v3/repos/deployments": "/en/rest/deployments/deployments", + "/v3/repos/downloads": "/en/rest/metrics/traffic", + "/v3/repos/forks": "/en/rest/repos/forks", + "/v3/repos/hooks": "/en/rest/webhooks/repo-config", + "/v3/repos": "/en/rest/repos", + "/v3/repos/invitations": "/en/rest/collaborators/invitations", + "/v3/repos/keys": "/en/rest/deploy-keys", + "/v3/repos/merging": "/en/rest/branches/branches", + "/v3/repos/pages": "/en/rest/pages", + "/v3/repos/pre_receive_hooks": "/en/enterprise-server/rest/enterprise-admin/repo-pre-receive-hooks", + "/v3/repos/releases": "/en/rest/releases/releases", + "/v3/repos/statistics": "/en/rest/metrics/statistics", + "/v3/repos/statuses": "/en/rest/commits/statuses", + "/v3/repos/traffic": "/en/rest/metrics/traffic", + "/v3/scim": "/en/rest/scim", + "/v3/search": "/en/rest/search", + "/v3/teams/discussion_comments": "/en/rest/teams/discussion-comments", + "/v3/teams/discussions": "/en/rest/teams/discussions", + "/v3/teams": "/en/rest/teams", + "/v3/teams/members": "/en/rest/teams/members", + "/v3/teams/team_sync": "/en/rest/teams/team-sync", + "/v3/users/blocking": "/en/rest/users/blocking", + "/v3/users/emails": "/en/rest/users/emails", + "/v3/users/followers": "/en/rest/users/followers", + "/v3/users/gpg_keys": "/en/rest/users/gpg-keys", + "/v3/users": "/en/rest/users", + "/v3/users/keys": "/en/rest/users/keys" } diff --git a/tests/rendering/rest.js b/tests/rendering/rest.js index 8c5b917c64..ea8d365ce1 100644 --- a/tests/rendering/rest.js +++ b/tests/rendering/rest.js @@ -1,8 +1,10 @@ import { jest } from '@jest/globals' +import slugger from 'github-slugger' import { getDOM } from '../helpers/e2etest.js' import getRest, { getEnabledForApps } from '../../lib/rest/index.js' import { allVersions } from '../../lib/all-versions.js' +import { getDiffOpenAPIContentRest } from '../../script/rest/test-open-api-schema.js' describe('REST references docs', () => { jest.setTimeout(3 * 60 * 1000) @@ -11,14 +13,12 @@ describe('REST references docs', () => { // page has every operation defined in the openapi schema. test('loads schema data for all versions', async () => { for (const version in allVersions) { - const checksRestOperations = getRest(version, 'checks') - const $ = await getDOM(`/en/${version}/rest/reference/checks`) + const checksRestOperations = await getRest(version, 'checks', 'runs') + const $ = await getDOM(`/en/${version}/rest/checks/runs`) const domH3Ids = $('h3') .map((i, h3) => $(h3).attr('id')) .get() - const schemaSlugs = Object.values(checksRestOperations) - .flat() - .map((operation) => operation.slug) + const schemaSlugs = checksRestOperations.map((operation) => slugger.slug(operation.title)) expect(schemaSlugs.every((slug) => domH3Ids.includes(slug))).toBe(true) } }) @@ -44,4 +44,25 @@ describe('REST references docs', () => { expect(schemaSlugs.every((slug) => domH3Ids.includes(slug))).toBe(true) } }) + + test('test OpenAPI schema categories/subcategories by versions matches content/rest directory', async () => { + const differences = await getDiffOpenAPIContentRest() + const errorMessage = formatErrors(differences) + expect(Object.keys(differences).length, errorMessage).toBe(0) + }) }) + +function formatErrors(differences) { + let errorMessage = 'There are differences in Categories/Subcategories in:\n' + for (const schema in differences) { + errorMessage += 'Version: ' + schema + '\n' + for (const category in differences[schema]) { + errorMessage += 'Category: ' + category + '\nSubcategories: \n' + errorMessage += + ' - content/rest directory: ' + differences[schema][category].contentDir + '\n' + errorMessage += ' - OpenAPI Schema: ' + differences[schema][category].openAPI + '\n' + errorMessage += '---\n' + } + } + return errorMessage +} diff --git a/tests/rendering/server.js b/tests/rendering/server.js index 61efb969fb..22a5dbc977 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -1104,19 +1104,19 @@ describe('index pages', () => { describe('REST reference pages', () => { test('view the rest/repos page in English', async () => { - const res = await get('/en/rest/reference/repos') + const res = await get('/en/rest/repos') expect(res.statusCode).toBe(200) }) test('view the rest/repos page in Japanese', async () => { - const res = await get('/ja/rest/reference/repos') + const res = await get('/ja/rest/repos') expect(res.statusCode).toBe(200) }) test('deeper pages in English', async () => { - const res = await get('/ja/enterprise-cloud@latest/rest/reference/code-scanning') + const res = await get('/ja/enterprise-cloud@latest/rest/code-scanning') expect(res.statusCode).toBe(200) }) test('deeper pages in Japanese', async () => { - const res = await get('/en/enterprise-cloud@latest/rest/reference/code-scanning') + const res = await get('/en/enterprise-cloud@latest/rest/code-scanning') expect(res.statusCode).toBe(200) }) }) diff --git a/tests/rendering/sidebar.js b/tests/rendering/sidebar.js index d1ea7d7619..9852de7a0b 100644 --- a/tests/rendering/sidebar.js +++ b/tests/rendering/sidebar.js @@ -1,17 +1,21 @@ -import { jest } from '@jest/globals' +import { expect, jest } from '@jest/globals' import '../../lib/feature-flags.js' import { getDOM } from '../helpers/e2etest.js' +import fs from 'fs' +import path from 'path' describe('sidebar', () => { jest.setTimeout(3 * 60 * 1000) - let $homePage, $githubPage, $enterprisePage + let $homePage, $githubPage, $enterprisePage, $restPage beforeAll(async () => { - ;[$homePage, $githubPage, $enterprisePage] = await Promise.all([ + ;[$homePage, $githubPage, $enterprisePage, $restPage] = await Promise.all([ getDOM('/en'), getDOM('/en/github'), getDOM('/en/enterprise/admin'), + // Using enterprise cloud bc we currently have a one off situation where secret-scanning is not a part of FPT + getDOM('/en/enterprise-cloud@latest/rest'), ]) }) @@ -54,4 +58,25 @@ describe('sidebar', () => { $homePage('[data-testid=sidebar] [data-testid=sidebar-product][title*="early"]').length ).toBe(0) }) + + test('REST API Reference title is viewable', async () => { + expect($restPage('[data-testid=rest-sidebar-reference]').length).toBe(1) + }) + + test('Check that the top level categories in the REST sidebar match content/rest directory for ghec', async () => { + const dir = path.posix.join(process.cwd(), 'content', 'rest') + const numCategories = [] + const sidebarRestCategories = $restPage( + '[data-testid=sidebar] [data-testid=rest-sidebar-items] details summary div div' + ).get() + const sidebarRestCategoryTitles = sidebarRestCategories.map((el) => $restPage(el).text().trim()) + + fs.readdirSync(dir).forEach((file) => { + if (file !== 'index.md' && file !== 'README.md' && file !== '.DS_Store') { + numCategories.push(file) + } + }) + + expect(numCategories.length).toBe(sidebarRestCategoryTitles.length) + }) }) diff --git a/tests/routing/developer-site-redirects.js b/tests/routing/developer-site-redirects.js index 1deca75652..6421b3ffe4 100644 --- a/tests/routing/developer-site-redirects.js +++ b/tests/routing/developer-site-redirects.js @@ -74,14 +74,14 @@ describe('developer redirects', () => { // any more, so redirect to an anchor on the resource page res = await get('/en/v3/activity') expect(res.statusCode).toBe(301) - expectedFinalPath = '/en/rest/reference/activity' + expectedFinalPath = '/en/rest/activity' expect(res.headers.location).toBe(expectedFinalPath) // REST subresources like activity notifications don't have their own page // any more, so redirect to an anchor on the resource page res = await get('/en/v3/activity/notifications') expect(res.statusCode).toBe(301) - expectedFinalPath = '/en/rest/reference/activity#notifications' + expectedFinalPath = '/en/rest/activity/notifications' expect(res.headers.location).toBe(expectedFinalPath) // trailing slashes are handled separately by the `slashes` module; diff --git a/tests/unit/openapi-schema.js b/tests/unit/openapi-schema.js index bb1fcc4e40..9dd72eb006 100644 --- a/tests/unit/openapi-schema.js +++ b/tests/unit/openapi-schema.js @@ -29,11 +29,7 @@ describe('markdown for each rest version', () => { test('markdown file exists for every operationId prefix in all versions of the OpenAPI schema', async () => { // list of REST markdown files that do not correspond to REST API resources // TODO could we get this list dynamically, say via page frontmatter? - const excludeFromResourceNameCheck = [ - 'endpoints-available-for-github-apps.md', - 'permissions-required-for-github-apps.md', - 'index.md', - ] + const excludeFromResourceNameCheck = ['README.md', 'index.md', 'guides', 'overview'] // Unique set of all categories across all versions of the OpenAPI schema const allCategories = new Set() @@ -43,7 +39,7 @@ describe('markdown for each rest version', () => { Object.keys(restOperations).forEach((category) => allCategories.add(category)) } - const referenceDir = path.join(__dirname, '../../content/rest/reference') + const referenceDir = path.join(__dirname, '../../content/rest') const filenames = (await fs.readdir(referenceDir)) .filter( (filename) => @@ -52,11 +48,11 @@ describe('markdown for each rest version', () => { .map((filename) => filename.replace('.md', '')) const missingResource = - 'Found a markdown file in content/rest/reference that is not represented by an OpenAPI REST operation category.' + 'Found a markdown file in content/rest that is not represented by an OpenAPI REST operation category.' expect(difference(filenames, [...allCategories]), missingResource).toEqual([]) const missingFile = - 'Found an OpenAPI REST operation category that is not represented by a markdown file in content/rest/reference.' + 'Found an OpenAPI REST operation category that is not represented by a markdown file in content/rest.' expect(difference([...allCategories], filenames), missingFile).toEqual([]) }) }) diff --git a/translations/es-ES/content/rest/actions/artifacts.md b/translations/es-ES/content/rest/actions/artifacts.md new file mode 100644 index 0000000000..50728ce183 --- /dev/null +++ b/translations/es-ES/content/rest/actions/artifacts.md @@ -0,0 +1,15 @@ +--- +title: Artifacts +intro: 'The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/actions/cache.md b/translations/es-ES/content/rest/actions/cache.md new file mode 100644 index 0000000000..227622ec99 --- /dev/null +++ b/translations/es-ES/content/rest/actions/cache.md @@ -0,0 +1,11 @@ +--- +title: Cache +intro: 'The Cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories.' +topics: + - API +versions: + fpt: '*' + ghec: '*' +--- + +The cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories. For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)." diff --git a/translations/es-ES/content/rest/actions/index.md b/translations/es-ES/content/rest/actions/index.md new file mode 100644 index 0000000000..1eef306da9 --- /dev/null +++ b/translations/es-ES/content/rest/actions/index.md @@ -0,0 +1,26 @@ +--- +title: Actions +intro: 'With the Actions API, you can manage and control {% data variables.product.prodname_actions %} for an organization or repository.' +redirect_from: + - /v3/actions + - /rest/reference/actions +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /artifacts + - /cache + - /permissions + - /secrets + - /self-hosted-runner-groups + - /self-hosted-runners + - /workflow-jobs + - /workflow-runs + - /workflows +--- +The {% data variables.product.prodname_actions %} API enables you to manage {% data variables.product.prodname_actions %} using the REST API. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/actions/permissions.md b/translations/es-ES/content/rest/actions/permissions.md new file mode 100644 index 0000000000..250824f7dd --- /dev/null +++ b/translations/es-ES/content/rest/actions/permissions.md @@ -0,0 +1,15 @@ +--- +title: Permissions +intro: 'The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Permissions + +The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/actions/secrets.md b/translations/es-ES/content/rest/actions/secrets.md new file mode 100644 index 0000000000..bb9cdca350 --- /dev/null +++ b/translations/es-ES/content/rest/actions/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. ' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/translations/es-ES/content/rest/actions/self-hosted-runner-groups.md b/translations/es-ES/content/rest/actions/self-hosted-runner-groups.md new file mode 100644 index 0000000000..77b15aa36f --- /dev/null +++ b/translations/es-ES/content/rest/actions/self-hosted-runner-groups.md @@ -0,0 +1,17 @@ +--- +title: Self-hosted runner groups +intro: 'The Self-hosted Runners Groups API allows you manage groups of self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Self-hosted runner groups + +The Self-hosted Runners Groups API allows you manage groups of self-hosted runners. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API. \ No newline at end of file diff --git a/translations/es-ES/content/rest/actions/self-hosted-runners.md b/translations/es-ES/content/rest/actions/self-hosted-runners.md new file mode 100644 index 0000000000..61c8aa3d5a --- /dev/null +++ b/translations/es-ES/content/rest/actions/self-hosted-runners.md @@ -0,0 +1,17 @@ +--- +title: Self-hosted runners +intro: 'The Self-hosted Runners API allows you to register, view, and delete self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Self-hosted runners + +The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API. \ No newline at end of file diff --git a/translations/es-ES/content/rest/actions/workflow-jobs.md b/translations/es-ES/content/rest/actions/workflow-jobs.md new file mode 100644 index 0000000000..469ea0382f --- /dev/null +++ b/translations/es-ES/content/rest/actions/workflow-jobs.md @@ -0,0 +1,15 @@ +--- +title: Workflow jobs +intro: 'The Workflow Jobs API allows you to view logs and workflow jobs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/actions/workflow-runs.md b/translations/es-ES/content/rest/actions/workflow-runs.md new file mode 100644 index 0000000000..3fca12a420 --- /dev/null +++ b/translations/es-ES/content/rest/actions/workflow-runs.md @@ -0,0 +1,15 @@ +--- +title: Workflow runs +intro: 'The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/actions/workflows.md b/translations/es-ES/content/rest/actions/workflows.md new file mode 100644 index 0000000000..55dad18cea --- /dev/null +++ b/translations/es-ES/content/rest/actions/workflows.md @@ -0,0 +1,15 @@ +--- +title: Workflows +intro: 'The Workflows API allows you to view workflows for a repository.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/activity/events.md b/translations/es-ES/content/rest/activity/events.md new file mode 100644 index 0000000000..9b3f58527b --- /dev/null +++ b/translations/es-ES/content/rest/activity/events.md @@ -0,0 +1,33 @@ +--- +title: Events +intro: 'The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These events power the various activity streams on the site. + +The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{% data variables.product.prodname_dotcom %} Event types](/developers/webhooks-and-events/github-event-types)." An events API for repository issues is also available. For more information, see the "[Issue Events API](/rest/reference/issues#events)." + +Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events +> HTTP/2 200 +> X-Poll-Interval: 60 +> ETag: "a18c3bded88eb5dbb5c849a489412bf3" + +# The quotes around the ETag value are important +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events \ +$ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). \ No newline at end of file diff --git a/translations/es-ES/content/rest/activity/feeds.md b/translations/es-ES/content/rest/activity/feeds.md new file mode 100644 index 0000000000..e11e4cf1f4 --- /dev/null +++ b/translations/es-ES/content/rest/activity/feeds.md @@ -0,0 +1,63 @@ +--- +title: Feeds +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Example of getting an Atom feed + +To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories: + + curl -H "Accept: application/atom+xml" https://github.com/security-advisories + +#### Response + +```shell +HTTP/2 200 +``` + +```xml + + + tag:github.com,2008:/security-advisories + + GitHub Security Advisory Feed + + GitHub + + 2019-01-14T19:34:52Z + + tag:github.com,2008:GHSA-abcd-12ab-23cd + 2018-07-26T15:14:52Z + 2019-01-14T19:34:52Z + [GHSA-abcd-12ab-23cd] Moderate severity vulnerability that affects Octoapp + + + <p>Octoapp node module before 4.17.5 suffers from a Modification of Assumed-Immutable Data (MAID) vulnerability via defaultsDeep, merge, and mergeWith functions, which allows a malicious user to modify the prototype of "Object" via <strong>proto</strong>, causing the addition or modification of an existing property that will exist on all objects.</p> + <p><strong>Affected Packages</strong></p> + + <dl> + <dt>Octoapp</dt> + <dd>Ecosystem: npm</dd> + <dd>Severity: moderate</dd> + <dd>Versions: &lt; 4.17.5</dd> + <dd>Fixed in: 4.17.5</dd> + </dl> + + <p><strong>References</strong></p> + + <ul> + <li>https://nvd.nist.gov/vuln/detail/CVE-2018-123</li> + </ul> + + + + +``` \ No newline at end of file diff --git a/content/rest/reference/activity.md b/translations/es-ES/content/rest/activity/index.md similarity index 69% rename from content/rest/reference/activity.md rename to translations/es-ES/content/rest/activity/index.md index 469e3fd72e..3f18631406 100644 --- a/content/rest/reference/activity.md +++ b/translations/es-ES/content/rest/activity/index.md @@ -3,6 +3,7 @@ title: Activity intro: 'The Activity API allows you to list events and feeds and manage notifications, starring, and watching for the authenticated user.' redirect_from: - /v3/activity + - /rest/reference/activity versions: fpt: '*' ghes: '*' @@ -11,8 +12,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /events + - /feeds + - /notifications + - /starring + - /watching --- - - \ No newline at end of file diff --git a/translations/es-ES/content/rest/activity/notifications.md b/translations/es-ES/content/rest/activity/notifications.md new file mode 100644 index 0000000000..49678f8f9c --- /dev/null +++ b/translations/es-ES/content/rest/activity/notifications.md @@ -0,0 +1,70 @@ +--- +title: Notifications +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Users receive notifications for conversations in repositories they watch including: + +* Issues and their comments +* Pull Requests and their comments +* Comments on any commits + +Notifications are also sent for conversations in unwatched repositories when the user is involved including: + +* **@mentions** +* Issue assignments +* Commits the user authors or commits +* Any discussion in which the user actively participates + +All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints. + +Notifications come back as "threads". A thread contains information about the current discussion of an issue, pull request, or commit. + +Notifications are optimized for polling with the `Last-Modified` header. If there are no new notifications, you will see a `304 Not Modified` response, leaving your current rate limit untouched. There is an `X-Poll-Interval` header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +# Add authentication to your requests +$ curl -I {% data variables.product.api_url_pre %}/notifications +HTTP/2 200 +Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT +X-Poll-Interval: 60 + +# Pass the Last-Modified header exactly +$ curl -I {% data variables.product.api_url_pre %}/notifications +$ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +### Notification reasons + +When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification. + +Here's a list of potential `reason`s for receiving a notification: + +Reason Name | Description +------------|------------ +`assign` | You were assigned to the issue. +`author` | You created the thread. +`comment` | You commented on the thread. +`ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. +`invitation` | You accepted an invitation to contribute to the repository. +`manual` | You subscribed to the thread (via an issue or pull request). +`mention` | You were specifically **@mentioned** in the content. +`review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} +`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in your repository.{% endif %} +`state_change` | You changed the thread state (for example, closing an issue or merging a pull request). +`subscribed` | You're watching the repository. +`team_mention` | You were on a team that was mentioned. + +Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different. + +For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then **@mentioned** on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again. \ No newline at end of file diff --git a/translations/es-ES/content/rest/activity/starring.md b/translations/es-ES/content/rest/activity/starring.md new file mode 100644 index 0000000000..9c45ddad6f --- /dev/null +++ b/translations/es-ES/content/rest/activity/starring.md @@ -0,0 +1,30 @@ +--- +title: Starring +intro: 'Repository starring is a feature that lets users bookmark repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. + +### Starring vs. Watching + +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Many API +client applications may be using the original "watcher" endpoints for accessing +this data. You can now start using the "star" endpoints instead (described +below). For more information, see the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) and the "[Repository Watching API](/rest/reference/activity#watching)." + +### Custom media types for starring + +There is one supported custom media type for the Starring REST API. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`. + + application/vnd.github.v3.star+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/activity/watching.md b/translations/es-ES/content/rest/activity/watching.md new file mode 100644 index 0000000000..10f078782e --- /dev/null +++ b/translations/es-ES/content/rest/activity/watching.md @@ -0,0 +1,14 @@ +--- +title: Watching +intro: "Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/apps/apps.md b/translations/es-ES/content/rest/apps/apps.md new file mode 100644 index 0000000000..7f7fa4b74f --- /dev/null +++ b/translations/es-ES/content/rest/apps/apps.md @@ -0,0 +1,22 @@ +--- +title: Apps +intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.apps.general-apps-restrictions %} + +This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more. + +When authenticated as a GitHub App, the GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of an app. + +You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user. + +A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints. diff --git a/content/rest/reference/apps.md b/translations/es-ES/content/rest/apps/index.md similarity index 69% rename from content/rest/reference/apps.md rename to translations/es-ES/content/rest/apps/index.md index 55023fa8db..5bbc724e11 100644 --- a/content/rest/reference/apps.md +++ b/translations/es-ES/content/rest/apps/index.md @@ -3,6 +3,7 @@ title: Apps intro: The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps. redirect_from: - /v3/apps + - /rest/reference/apps versions: fpt: '*' ghes: '*' @@ -11,8 +12,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /apps + - /installations + - /marketplace + - /oauth-applications + - /webhooks --- - - diff --git a/translations/es-ES/content/rest/apps/installations.md b/translations/es-ES/content/rest/apps/installations.md new file mode 100644 index 0000000000..8e858caed4 --- /dev/null +++ b/translations/es-ES/content/rest/apps/installations.md @@ -0,0 +1,16 @@ +--- +title: Installations +intro: 'The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." + +To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." diff --git a/translations/es-ES/content/rest/apps/marketplace.md b/translations/es-ES/content/rest/apps/marketplace.md new file mode 100644 index 0000000000..d49e3bed46 --- /dev/null +++ b/translations/es-ES/content/rest/apps/marketplace.md @@ -0,0 +1,22 @@ +--- +title: Marketplace +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' +--- + +For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)." + +The {% data variables.product.prodname_marketplace %} API allows you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription. + +### Testing with stubbed endpoints + +This API includes endpoints that allow you to [test your {% data variables.product.prodname_github_app %}](/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/) with **stubbed data**. Stubbed data is hard-coded, fake data that will not change based on actual subscriptions. + +To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether API logic succeeds before listing {% data variables.product.prodname_github_apps %} on {% data variables.product.prodname_marketplace %}. + +Be sure to replace stubbed endpoints with production endpoints before deploying your {% data variables.product.prodname_github_app %}. diff --git a/translations/es-ES/content/rest/apps/oauth-applications.md b/translations/es-ES/content/rest/apps/oauth-applications.md new file mode 100644 index 0000000000..037850e51c --- /dev/null +++ b/translations/es-ES/content/rest/apps/oauth-applications.md @@ -0,0 +1,14 @@ +--- +title: OAuth Applications +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. diff --git a/translations/es-ES/content/rest/apps/webhooks.md b/translations/es-ES/content/rest/apps/webhooks.md new file mode 100644 index 0000000000..c3cf61466f --- /dev/null +++ b/translations/es-ES/content/rest/apps/webhooks.md @@ -0,0 +1,14 @@ +--- +title: Webhooks +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %} diff --git a/translations/es-ES/content/rest/billing.md b/translations/es-ES/content/rest/billing.md new file mode 100644 index 0000000000..6f9ccd86a6 --- /dev/null +++ b/translations/es-ES/content/rest/billing.md @@ -0,0 +1,15 @@ +--- +title: Billing +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.4' +redirect_from: + - /rest/reference/billing +--- + +You can get billing information for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#billing)" REST API. \ No newline at end of file diff --git a/translations/es-ES/content/rest/branches/branch-protection.md b/translations/es-ES/content/rest/branches/branch-protection.md new file mode 100644 index 0000000000..e831cd0fea --- /dev/null +++ b/translations/es-ES/content/rest/branches/branch-protection.md @@ -0,0 +1,13 @@ +--- +title: Protected branches +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/branches/branches.md b/translations/es-ES/content/rest/branches/branches.md new file mode 100644 index 0000000000..99f1050d0a --- /dev/null +++ b/translations/es-ES/content/rest/branches/branches.md @@ -0,0 +1,12 @@ +--- +title: Branches +intro: 'The Branches API allows you to modify branches and their protection settings.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/es-ES/content/rest/branches/index.md b/translations/es-ES/content/rest/branches/index.md new file mode 100644 index 0000000000..6b13175895 --- /dev/null +++ b/translations/es-ES/content/rest/branches/index.md @@ -0,0 +1,18 @@ +--- +title: Branches +intro: The branches API allows you to modify branches and their protection settings. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /branches + - /branch-protection +redirect_from: + - /rest/reference/branches +--- diff --git a/translations/es-ES/content/rest/checks/index.md b/translations/es-ES/content/rest/checks/index.md new file mode 100644 index 0000000000..6b0e064cb8 --- /dev/null +++ b/translations/es-ES/content/rest/checks/index.md @@ -0,0 +1,20 @@ +--- +title: Checks +intro: 'With the Checks API, you can build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' +redirect_from: + - /v3/checks + - /rest/reference/checks +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /runs + - /suites +--- + +You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/checks/runs.md b/translations/es-ES/content/rest/checks/runs.md new file mode 100644 index 0000000000..c49d26fd02 --- /dev/null +++ b/translations/es-ES/content/rest/checks/runs.md @@ -0,0 +1,13 @@ +--- +title: Check Runs +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/checks/suites.md b/translations/es-ES/content/rest/checks/suites.md new file mode 100644 index 0000000000..9aec42aad3 --- /dev/null +++ b/translations/es-ES/content/rest/checks/suites.md @@ -0,0 +1,19 @@ +--- +title: Check Suites +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% note %} + + **Note:** A GitHub App only receives one [`check_suite`](/webhooks/event-payloads/#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks/event-payloads/#create) events. + +{% endnote %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/code-scanning.md b/translations/es-ES/content/rest/code-scanning.md new file mode 100644 index 0000000000..8c464645a9 --- /dev/null +++ b/translations/es-ES/content/rest/code-scanning.md @@ -0,0 +1,32 @@ +--- +title: Code Scanning +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API + - Code scanning + - REST +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/code-scanning +--- + +{% data reusables.code-scanning.beta %} + +The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[Finding security vulnerabilities and errors in your code](/github/finding-security-vulnerabilities-and-errors-in-your-code)." + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +### Custom media type for {% data variables.product.prodname_code_scanning %} + +There is one supported custom media type for the {% data variables.product.prodname_code_scanning %} REST API. + + application/sarif+json + +You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. For more information about this operation, see "[Get a {% data variables.product.prodname_code_scanning %} analysis for a repository](#get-a-code-scanning-analysis-for-a-repository)." When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than the summary of the analysis that's returned when you use the default media type. The response also includes additional data such as the `github/alertNumber` and `github/alertUrl` properties. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + +For more information, see "[Media types](/rest/overview/media-types)." +{% endif %} diff --git a/translations/es-ES/content/rest/codes-of-conduct.md b/translations/es-ES/content/rest/codes-of-conduct.md new file mode 100644 index 0000000000..dd96f59734 --- /dev/null +++ b/translations/es-ES/content/rest/codes-of-conduct.md @@ -0,0 +1,16 @@ +--- +title: Codes of Conduct +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/codes-of-conduct +--- + +You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a repository's code of conduct, use the "[Get a repository](/rest/reference/repos#get-a-repository)" endpoint. \ No newline at end of file diff --git a/translations/es-ES/content/rest/codespaces/codespaces.md b/translations/es-ES/content/rest/codespaces/codespaces.md new file mode 100644 index 0000000000..11d920b1c2 --- /dev/null +++ b/translations/es-ES/content/rest/codespaces/codespaces.md @@ -0,0 +1,14 @@ +--- +title: Codespaces +intro: 'The Codespaces API enables you to manage your codespaces using the REST API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% data reusables.codespaces.codespaces-api-beta-note %} + +The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)." diff --git a/translations/es-ES/content/rest/codespaces/index.md b/translations/es-ES/content/rest/codespaces/index.md new file mode 100644 index 0000000000..d97a0755c0 --- /dev/null +++ b/translations/es-ES/content/rest/codespaces/index.md @@ -0,0 +1,18 @@ +--- +title: Codespaces +intro: 'The {% data variables.product.prodname_codespaces %} API enables you to manage your codespaces using the REST API.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /codespaces + - /machines + - /repository-secrets + - /secrets +redirect_from: + - /rest/reference/codespaces +--- diff --git a/translations/es-ES/content/rest/codespaces/machines.md b/translations/es-ES/content/rest/codespaces/machines.md new file mode 100644 index 0000000000..b39416253f --- /dev/null +++ b/translations/es-ES/content/rest/codespaces/machines.md @@ -0,0 +1,14 @@ +--- +title: Machines +intro: 'The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)." + +You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/codespaces/repository-secrets.md b/translations/es-ES/content/rest/codespaces/repository-secrets.md new file mode 100644 index 0000000000..ccab41f36e --- /dev/null +++ b/translations/es-ES/content/rest/codespaces/repository-secrets.md @@ -0,0 +1,15 @@ +--- +title: Repository Secrets +intro: 'The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.5' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +## Repository Secrets + +The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/codespaces/secrets.md b/translations/es-ES/content/rest/codespaces/secrets.md new file mode 100644 index 0000000000..fb315dc8ce --- /dev/null +++ b/translations/es-ES/content/rest/codespaces/secrets.md @@ -0,0 +1,15 @@ +--- +title: User Secrets +intro: 'The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +## User Secrets + +The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/collaborators/collaborators.md b/translations/es-ES/content/rest/collaborators/collaborators.md new file mode 100644 index 0000000000..e2c617d39f --- /dev/null +++ b/translations/es-ES/content/rest/collaborators/collaborators.md @@ -0,0 +1,12 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/collaborators/index.md b/translations/es-ES/content/rest/collaborators/index.md new file mode 100644 index 0000000000..925f1ff4e9 --- /dev/null +++ b/translations/es-ES/content/rest/collaborators/index.md @@ -0,0 +1,18 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /collaborators + - /invitations +redirect_from: + - /rest/reference/collaborators +--- diff --git a/translations/es-ES/content/rest/collaborators/invitations.md b/translations/es-ES/content/rest/collaborators/invitations.md new file mode 100644 index 0000000000..502e22608a --- /dev/null +++ b/translations/es-ES/content/rest/collaborators/invitations.md @@ -0,0 +1,22 @@ +--- +title: Invitations +intro: 'The Repository Invitations API allows users or external services to invite other users to collaborate on a repo.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. + +Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted +access to invitations **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as invitations. + +### Invite a user to a repository + +Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/collaborators/collaborators#add-a-repository-collaborator)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/commits/comments.md b/translations/es-ES/content/rest/commits/comments.md new file mode 100644 index 0000000000..34ff1e9f90 --- /dev/null +++ b/translations/es-ES/content/rest/commits/comments.md @@ -0,0 +1,25 @@ +--- +title: Commit comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Custom media types for commit comments + +These are the supported media types for commit comments. You can read more +about the use of media types in the API [here](/rest/overview/media-types). + + application/vnd.github-commitcomment.raw+json + application/vnd.github-commitcomment.text+json + application/vnd.github-commitcomment.html+json + application/vnd.github-commitcomment.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/commits/commits.md b/translations/es-ES/content/rest/commits/commits.md new file mode 100644 index 0000000000..8b0fa3f792 --- /dev/null +++ b/translations/es-ES/content/rest/commits/commits.md @@ -0,0 +1,12 @@ +--- +title: Commits +intro: 'The Commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/es-ES/content/rest/commits/index.md b/translations/es-ES/content/rest/commits/index.md new file mode 100644 index 0000000000..425b0999cf --- /dev/null +++ b/translations/es-ES/content/rest/commits/index.md @@ -0,0 +1,19 @@ +--- +title: Commits +intro: 'The commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /commits + - /comments + - /statuses +redirect_from: + - /rest/reference/commits +--- diff --git a/translations/es-ES/content/rest/commits/statuses.md b/translations/es-ES/content/rest/commits/statuses.md new file mode 100644 index 0000000000..27050e2439 --- /dev/null +++ b/translations/es-ES/content/rest/commits/statuses.md @@ -0,0 +1,23 @@ +--- +title: Commit statuses +intro: 'The status API allows external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Statuses can also include an optional `description` and `target_url`, and we highly recommend providing them as they make statuses much more useful in the GitHub UI. + +As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The `target_url` would be the full URL to the build output, and the `description` would be the high level summary of what happened with the build. + +Statuses can include a `context` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. + +Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the `repo` scope grants permission to code as well as statuses. + +If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks). \ No newline at end of file diff --git a/translations/es-ES/content/rest/dependabot/index.md b/translations/es-ES/content/rest/dependabot/index.md new file mode 100644 index 0000000000..9de244ec7d --- /dev/null +++ b/translations/es-ES/content/rest/dependabot/index.md @@ -0,0 +1,16 @@ +--- +title: Dependabot +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /secrets +redirect_from: + - /rest/reference/dependabot +--- diff --git a/translations/es-ES/content/rest/dependabot/secrets.md b/translations/es-ES/content/rest/dependabot/secrets.md new file mode 100644 index 0000000000..f57bff7358 --- /dev/null +++ b/translations/es-ES/content/rest/dependabot/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +topics: + - API +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +allowTitleToDifferFromFilename: true +--- + +The {% data variables.product.prodname_dependabot %} Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/translations/es-ES/content/rest/dependency-graph/dependency-review.md b/translations/es-ES/content/rest/dependency-graph/dependency-review.md new file mode 100644 index 0000000000..b08e657b46 --- /dev/null +++ b/translations/es-ES/content/rest/dependency-graph/dependency-review.md @@ -0,0 +1,19 @@ +--- +title: Dependency Review +intro: 'The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment.' +versions: + fpt: '*' + ghes: '>=3.6' + ghec: '*' + ghae: 'issue-6396' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +## Dependency review + +{% data reusables.dependency-review.dependency-review-api-beta-note %} + +The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/reference/dependency-graph.md b/translations/es-ES/content/rest/dependency-graph/index.md similarity index 54% rename from translations/zh-CN/content/rest/reference/dependency-graph.md rename to translations/es-ES/content/rest/dependency-graph/index.md index 0ec60a6128..393c5eaa5c 100644 --- a/translations/zh-CN/content/rest/reference/dependency-graph.md +++ b/translations/es-ES/content/rest/dependency-graph/index.md @@ -1,16 +1,16 @@ --- -title: 依赖关系图 +title: Dependency Graph intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.' versions: fpt: '*' ghes: '>=3.6' ghec: '*' - ghae: issue-6396 + ghae: 'issue-6396' topics: - API miniTocMaxHeadingLevel: 3 +children: + - /dependency-review +redirect_from: + - /rest/reference/dependency-graph --- - - diff --git a/translations/es-ES/content/rest/deploy-keys.md b/translations/es-ES/content/rest/deploy-keys.md new file mode 100644 index 0000000000..0158b1194b --- /dev/null +++ b/translations/es-ES/content/rest/deploy-keys.md @@ -0,0 +1,19 @@ +--- +title: Deploy Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/deploy_keys +--- + +{% data reusables.repositories.deploy-keys %} + +Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/deployments/deployments.md b/translations/es-ES/content/rest/deployments/deployments.md new file mode 100644 index 0000000000..84f4f9eea3 --- /dev/null +++ b/translations/es-ES/content/rest/deployments/deployments.md @@ -0,0 +1,60 @@ +--- +title: Deployments +intro: 'The Deployments API allows you to create and delete deployments and deployment environments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). + +Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume. + +Deployment statuses can also include an optional `description` and `log_url`, which are highly recommended because they make deployment statuses more useful. The `log_url` is the full URL to the deployment output, and +the `description` is a high-level summary of what happened with the deployment. + +GitHub dispatches `deployment` and `deployment_status` events when new deployments and deployment statuses are created. These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made. + +Below is a simple sequence diagram for how these interactions would work. + +``` ++---------+ +--------+ +-----------+ +-------------+ +| Tooling | | GitHub | | 3rd Party | | Your Server | ++---------+ +--------+ +-----------+ +-------------+ + | | | | + | Create Deployment | | | + |--------------------->| | | + | | | | + | Deployment Created | | | + |<---------------------| | | + | | | | + | | Deployment Event | | + | |---------------------->| | + | | | SSH+Deploys | + | | |-------------------->| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | + | | | Deploy Completed | + | | |<--------------------| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | +``` + +Keep in mind that GitHub is never actually accessing your servers. It's up to your third-party integration to interact with deployment events. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether they're responsible for pushing the code out to your servers, building native code, etc. + +Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the {% ifversion not ghae %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well. + +### Inactive deployments + +When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status. + +You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. diff --git a/translations/es-ES/content/rest/deployments/environments.md b/translations/es-ES/content/rest/deployments/environments.md new file mode 100644 index 0000000000..1d90c1aa6b --- /dev/null +++ b/translations/es-ES/content/rest/deployments/environments.md @@ -0,0 +1,16 @@ +--- +title: Environments +intro: 'The Environments API allows you to create, configure, and delete environments.' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." + +{% data reusables.gated-features.environments %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/deployments/index.md b/translations/es-ES/content/rest/deployments/index.md new file mode 100644 index 0000000000..c92c19aec6 --- /dev/null +++ b/translations/es-ES/content/rest/deployments/index.md @@ -0,0 +1,19 @@ +--- +title: Deployments +intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /deployments + - /environments + - /statuses +redirect_from: + - /rest/reference/deployments +--- diff --git a/translations/es-ES/content/rest/deployments/statuses.md b/translations/es-ES/content/rest/deployments/statuses.md new file mode 100644 index 0000000000..0896d48e75 --- /dev/null +++ b/translations/es-ES/content/rest/deployments/statuses.md @@ -0,0 +1,13 @@ +--- +title: Deployment Statuses +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/emojis.md b/translations/es-ES/content/rest/emojis.md new file mode 100644 index 0000000000..ca45960388 --- /dev/null +++ b/translations/es-ES/content/rest/emojis.md @@ -0,0 +1,14 @@ +--- +title: Emojis +intro: 'With the Emojis API, you can list and view all the available emojis to use in {% data variables.product.product_name %}.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/emojis +--- diff --git a/translations/es-ES/content/rest/enterprise-admin/admin-stats.md b/translations/es-ES/content/rest/enterprise-admin/admin-stats.md new file mode 100644 index 0000000000..d18be10342 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/admin-stats.md @@ -0,0 +1,12 @@ +--- +title: Admin stats +intro: 'The Admin Stats API provides a variety of metrics about your installation.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/announcement.md b/translations/es-ES/content/rest/enterprise-admin/announcement.md new file mode 100644 index 0000000000..05a248af24 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/announcement.md @@ -0,0 +1,14 @@ +--- +title: Announcement +intro: 'The Announcement API allows you to manage the global announcement banner in your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +## Announcement + +The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/audit-log.md b/translations/es-ES/content/rest/enterprise-admin/audit-log.md new file mode 100644 index 0000000000..7fa5096e21 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/audit-log.md @@ -0,0 +1,11 @@ +--- +title: Audit log +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/enterprise-admin/billing.md b/translations/es-ES/content/rest/enterprise-admin/billing.md new file mode 100644 index 0000000000..15f8a05d8f --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/billing.md @@ -0,0 +1,11 @@ +--- +title: Billing +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/enterprise-admin/global-webhooks.md b/translations/es-ES/content/rest/enterprise-admin/global-webhooks.md new file mode 100644 index 0000000000..b14fc8ab70 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/global-webhooks.md @@ -0,0 +1,14 @@ +--- +title: Global Webhooks +intro: 'Global Webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. + +*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/index.md b/translations/es-ES/content/rest/enterprise-admin/index.md new file mode 100644 index 0000000000..2845bef7e0 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/index.md @@ -0,0 +1,82 @@ +--- +title: GitHub Enterprise administration +intro: You can use these endpoints to administer your enterprise. +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/enterprise-admin + - /v3/enterprise + - /rest/reference/enterprise-admin +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +shortTitle: Enterprise administration +children: + - /admin-stats + - /announcement + - /audit-log + - /billing + - /global-webhooks + - /ldap + - /license + - /management-console + - /org-pre-receive-hooks + - /orgs + - /pre-receive-environments + - /pre-receive-hooks + - /repo-pre-receive-hooks + - /users + - /scim +--- + +{% ifversion fpt or ghec %} + +{% note %} + +**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. + +{% endnote %} + +{% endif %} + +### Endpoint URLs + +REST API endpoints{% ifversion ghes %}—except [Management Console](#management-console) API endpoints—{% endif %} are prefixed with the following URL: + +```shell +{% data variables.product.api_url_pre %} +``` + +{% ifversion fpt or ghec %} +When endpoints include `{enterprise}`, replace `{enterprise}` with the handle for your enterprise account, which is included in the URL for your enterprise settings. For example, if your enterprise account is located at `https://github.com/enterprises/octo-enterprise`, replace `{enterprise}` with `octo-enterprise`. +{% endif %} + +{% ifversion ghes %} +[Management Console](#management-console) API endpoints are only prefixed with a hostname: + +```shell +http(s)://hostname/ +``` +{% endif %} +{% ifversion ghae or ghes %} +### Authentication + +Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** {% ifversion ghes %}(which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) {% endif %}or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% ifversion ghes %} +OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %} + +Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/){% endif %}. + +{% endif %} + +{% ifversion ghae or ghes %} +### Version information + +The current version of your enterprise is returned in the response header of every API: +`X-GitHub-Enterprise-Version: {{currentVersion}}.0` +You can also read the current version by calling the [meta endpoint](/rest/reference/meta/). + +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/ldap.md b/translations/es-ES/content/rest/enterprise-admin/ldap.md new file mode 100644 index 0000000000..af2f31c0a7 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/ldap.md @@ -0,0 +1,11 @@ +--- +title: LDAP +intro: 'You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/license.md b/translations/es-ES/content/rest/enterprise-admin/license.md new file mode 100644 index 0000000000..2fd64bd48e --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/license.md @@ -0,0 +1,12 @@ +--- +title: License +intro: 'The License API provides information on your Enterprise license.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/management-console.md b/translations/es-ES/content/rest/enterprise-admin/management-console.md new file mode 100644 index 0000000000..5e9f95ee02 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/management-console.md @@ -0,0 +1,35 @@ +--- +title: Management Console +intro: 'The Management Console API helps you manage your {% data variables.product.product_name %} installation.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% tip %} + +You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`; otherwise, the port number is `8080`. + +If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. + +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/). + +{% endtip %} + +### Authentication + +You need to pass your [Management Console password](/enterprise/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#create-a-github-enterprise-server-license). + +Use the `api_key` parameter to send this token with each request. For example: + +```shell +$ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' +``` + +You can also use standard HTTP authentication to send this token. For example: + +```shell +$ curl -L -u "api_key:your-amazing-password" 'https://hostname:admin_port/setup/api' +``` \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/org-pre-receive-hooks.md b/translations/es-ES/content/rest/enterprise-admin/org-pre-receive-hooks.md new file mode 100644 index 0000000000..bc8b8b31ea --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/org-pre-receive-hooks.md @@ -0,0 +1,23 @@ +--- +title: Organization Pre-receive Hooks +intro: 'The Organization Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to an organization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Object attributes + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this endpoint or this hook's global configuration. Only site admins are able to access the global configuration. \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/orgs.md b/translations/es-ES/content/rest/enterprise-admin/orgs.md new file mode 100644 index 0000000000..f8fdc559dc --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: 'The Organization Administration API allows you to create organizations on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md b/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md new file mode 100644 index 0000000000..feb2ce08b5 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md @@ -0,0 +1,34 @@ +--- +title: Pre-receive Environments +intro: 'The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Environment + +| Name | Type | Description | +|-----------------------|-----------|----------------------------------------------------------------------------| +| `name` | `string` | The name of the environment as displayed in the UI. | +| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. | +| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. | +| `download` | `object` | This environment's download status. | +| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. | + +#### Pre-receive Environment Download + +| Name | Type | Description | +|-----------------|----------|---------------------------------------------------------| +| `state` | `string` | The state of the most recent download. | +| `downloaded_at` | `string` | The time when the most recent download started. | +| `message` | `string` | On failure, this will have any error messages produced. | + +Possible values for `state` are `not_started`, `in_progress`, `success`, `failed`. \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md b/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md new file mode 100644 index 0000000000..08d5c5f3ce --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md @@ -0,0 +1,27 @@ +--- +title: Pre-receive Hooks +intro: 'The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Hook + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `script` | `string` | The script that the hook runs. | +| `script_repository` | `object` | The GitHub repository where the script is kept. | +| `environment` | `object` | The pre-receive environment where the script is executed. | +| `enforcement` | `string` | The state of enforcement for this hook. | +| `allow_downstream_configuration` | `boolean` | Whether enforcement can be overridden at the org or repo level. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/repo-pre-receive-hooks.md b/translations/es-ES/content/rest/enterprise-admin/repo-pre-receive-hooks.md new file mode 100644 index 0000000000..831ca1a06a --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/repo-pre-receive-hooks.md @@ -0,0 +1,22 @@ +--- +title: Repository Pre-receive Hooks +intro: 'The Repository Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to a repository.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Object attributes + +| Name | Type | Description | +|---------------------|----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. \ No newline at end of file diff --git a/translations/es-ES/content/rest/enterprise-admin/scim.md b/translations/es-ES/content/rest/enterprise-admin/scim.md new file mode 100644 index 0000000000..326d333cbf --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/scim.md @@ -0,0 +1,11 @@ +--- +title: SCIM +intro: '' +versions: + fpt: '*' + ghec: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/enterprise-admin/users.md b/translations/es-ES/content/rest/enterprise-admin/users.md new file mode 100644 index 0000000000..6d9aea56c7 --- /dev/null +++ b/translations/es-ES/content/rest/enterprise-admin/users.md @@ -0,0 +1,12 @@ +--- +title: Users +intro: 'The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. \ No newline at end of file diff --git a/translations/es-ES/content/rest/gists/comments.md b/translations/es-ES/content/rest/gists/comments.md new file mode 100644 index 0000000000..9b01fd1f71 --- /dev/null +++ b/translations/es-ES/content/rest/gists/comments.md @@ -0,0 +1,21 @@ +--- +title: Comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Custom media types for Gist comments + +These are the supported media types for gist comments. + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.base64 + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/gists/gists.md b/translations/es-ES/content/rest/gists/gists.md new file mode 100644 index 0000000000..5cb6fef354 --- /dev/null +++ b/translations/es-ES/content/rest/gists/gists.md @@ -0,0 +1,35 @@ +--- +title: Gists +intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on GitHub.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Authentication + +You can read public gists {% ifversion ghae or ghes %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." + + + +### Truncation + +The Gist API provides up to one megabyte of content for each file in the gist. Each file returned for a gist through the API has a key called `truncated`. If `truncated` is `true`, the file is too large and only a portion of the contents were returned in `content`. + +If you need the full contents of the file, you can make a `GET` request to the URL specified by `raw_url`. Be aware that for files larger than ten megabytes, you'll need to clone the gist via the URL provided by `git_pull_url`. + +In addition to a specific file's contents being truncated, the entire files list may be truncated if the total number exceeds 300 files. If the top level `truncated` key is `true`, only the first 300 files have been returned in the files list. If you need to fetch all of the gist's files, you'll need to clone the gist via the URL provided by `git_pull_url`. + +### Custom media types for gists + +These are the supported media types for fetching gist contents. + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.base64 + +For more information, see "[Media types](/rest/overview/media-types)." diff --git a/content/rest/reference/gists.md b/translations/es-ES/content/rest/gists/index.md similarity index 70% rename from content/rest/reference/gists.md rename to translations/es-ES/content/rest/gists/index.md index 7bc85d1bad..7c9ddbab2c 100644 --- a/content/rest/reference/gists.md +++ b/translations/es-ES/content/rest/gists/index.md @@ -3,6 +3,7 @@ title: Gists intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on {% data variables.product.product_name %}.' redirect_from: - /v3/gists + - /rest/reference/gists versions: fpt: '*' ghes: '*' @@ -11,8 +12,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /gists + - /comments --- - - \ No newline at end of file diff --git a/translations/es-ES/content/rest/git/blobs.md b/translations/es-ES/content/rest/git/blobs.md new file mode 100644 index 0000000000..a4df5aca84 --- /dev/null +++ b/translations/es-ES/content/rest/git/blobs.md @@ -0,0 +1,24 @@ +--- +title: Blobs +intro: 'A Git blob (binary large object) is the object type used to store the contents of each file in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) +to your Git database on {% data variables.product.product_name %}. Blobs leverage [these custom media types](#custom-media-types-for-blobs). You can read more about the use of media types in the API [here](/rest/overview/media-types). + +### Custom media types for blobs + +These are the supported media types for blobs. + + application/json + application/vnd.github.VERSION.raw + +For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/git/commits.md b/translations/es-ES/content/rest/git/commits.md new file mode 100644 index 0000000000..18c14bb2ac --- /dev/null +++ b/translations/es-ES/content/rest/git/commits.md @@ -0,0 +1,14 @@ +--- +title: Commits +intro: 'A Git commit is a snapshot of the hierarchy ([Git tree](/rest/reference/git#trees)) and the contents of the files ([Git blob](/rest/reference/git#blobs)) in a Git repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/es-ES/content/rest/git/index.md b/translations/es-ES/content/rest/git/index.md new file mode 100644 index 0000000000..da1de11653 --- /dev/null +++ b/translations/es-ES/content/rest/git/index.md @@ -0,0 +1,24 @@ +--- +title: Git database +intro: 'The Git Database API enables you to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update Git references (branch heads and tags).' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/git + - /rest/reference/git +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /blobs + - /commits + - /refs + - /tags + - /trees +--- + +The Git Database API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the Git Database API, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/git/refs.md b/translations/es-ES/content/rest/git/refs.md new file mode 100644 index 0000000000..55b5f8122a --- /dev/null +++ b/translations/es-ES/content/rest/git/refs.md @@ -0,0 +1,15 @@ +--- +title: References +intro: 'A Git reference (`git ref`) is just a file that contains a Git commit SHA-1 hash.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is just a Git reference that stores the new Git commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v1/Git-Internals-Git-References) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/es-ES/content/rest/git/tags.md b/translations/es-ES/content/rest/git/tags.md new file mode 100644 index 0000000000..101fde046a --- /dev/null +++ b/translations/es-ES/content/rest/git/tags.md @@ -0,0 +1,14 @@ +--- +title: Tags +intro: 'A Git tag is similar to a [Git reference](/rest/reference/git#refs), but the Git commit that it points to never changes.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags) to your Git database on {% data variables.product.product_name %}. The Git tags API only supports [annotated tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags), not lightweight tags. diff --git a/translations/es-ES/content/rest/git/trees.md b/translations/es-ES/content/rest/git/trees.md new file mode 100644 index 0000000000..7471c1d66a --- /dev/null +++ b/translations/es-ES/content/rest/git/trees.md @@ -0,0 +1,14 @@ +--- +title: Trees +intro: 'A Git tree object creates the hierarchy between files in a Git repository. ' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/es-ES/content/rest/gitignore.md b/translations/es-ES/content/rest/gitignore.md new file mode 100644 index 0000000000..0a641c3994 --- /dev/null +++ b/translations/es-ES/content/rest/gitignore.md @@ -0,0 +1,24 @@ +--- +title: Gitignore +intro: 'The Gitignore API fetches `.gitignore` templates that can be used to ignore files and directories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/gitignore +--- + +When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). + +### Custom media types for gitignore + +You can use this custom media type when getting a gitignore template. + + application/vnd.github.VERSION.raw + +For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/index.md b/translations/es-ES/content/rest/index.md index ed572b8d65..773fa86484 100644 --- a/translations/es-ES/content/rest/index.md +++ b/translations/es-ES/content/rest/index.md @@ -1,7 +1,7 @@ --- -title: API de REST de GitHub -shortTitle: API de REST -intro: 'Para crear integraciones, recuperar datos y automatizar tus flujos de trabajo, compila con la API de REST de {% data variables.product.prodname_dotcom %}.' +title: GitHub REST API +shortTitle: REST API +intro: 'To create integrations, retrieve data, and automate your workflows, build with the {% data variables.product.prodname_dotcom %} REST API.' introLinks: quickstart: /rest/guides/getting-started-with-the-rest-api featuredLinks: @@ -31,7 +31,49 @@ versions: ghec: '*' children: - /overview - - /reference - /guides + - /actions + - /activity + - /apps + - /billing + - /branches + - /checks + - /codes-of-conduct + - /code-scanning + - /codespaces + - /collaborators + - /commits + - /dependabot + - /dependency-graph + - /deploy-keys + - /deployments + - /emojis + - /enterprise-admin + - /gists + - /git + - /gitignore + - /interactions + - /issues + - /licenses + - /markdown + - /meta + - /metrics + - /migrations + - /oauth-authorizations + - /orgs + - /packages + - /pages + - /projects + - /pulls + - /rate-limit + - /reactions + - /releases + - /repos + - /scim + - /search + - /secret-scanning + - /teams + - /users + - /webhooks --- diff --git a/translations/es-ES/content/rest/interactions/index.md b/translations/es-ES/content/rest/interactions/index.md new file mode 100644 index 0000000000..10c5349a73 --- /dev/null +++ b/translations/es-ES/content/rest/interactions/index.md @@ -0,0 +1,19 @@ +--- +title: Interactions +intro: 'With the Interactions API, people with owner or admin access can set the interaction limit for the users in their organizations and repositories.' +redirect_from: + - /v3/interactions + - /rest/reference/interactions +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /repos + - /user +--- + +Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. \ No newline at end of file diff --git a/translations/es-ES/content/rest/interactions/orgs.md b/translations/es-ES/content/rest/interactions/orgs.md new file mode 100644 index 0000000000..2185e2bb46 --- /dev/null +++ b/translations/es-ES/content/rest/interactions/orgs.md @@ -0,0 +1,19 @@ +--- +title: Organization +intro: "The Organization Interactions API allows organization owners to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories." +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} in the organization. +* {% data reusables.interactions.contributor-user-limit-definition %} in the organization. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the organization. + +Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the [Repository](#repository) interactions endpoints instead. \ No newline at end of file diff --git a/translations/es-ES/content/rest/interactions/repos.md b/translations/es-ES/content/rest/interactions/repos.md new file mode 100644 index 0000000000..5bba6ae46d --- /dev/null +++ b/translations/es-ES/content/rest/interactions/repos.md @@ -0,0 +1,19 @@ +--- +title: Repository +intro: 'The Repository Interactions API allows people with owner or admin access to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} in the repository. +* {% data reusables.interactions.contributor-user-limit-definition %} in the repository. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the repository. + +If an interaction limit is enabled for the user or organization that owns the repository, the limit cannot be changed for the individual repository. Instead, use the [User](#user) or [Organization](#organization) interactions endpoints to change the interaction limit. \ No newline at end of file diff --git a/translations/es-ES/content/rest/interactions/user.md b/translations/es-ES/content/rest/interactions/user.md new file mode 100644 index 0000000000..b7fa0c6174 --- /dev/null +++ b/translations/es-ES/content/rest/interactions/user.md @@ -0,0 +1,18 @@ +--- +title: User +intro: 'The User Interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories. + +Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the [Repository](#repository) interactions endpoints instead. \ No newline at end of file diff --git a/translations/es-ES/content/rest/issues/assignees.md b/translations/es-ES/content/rest/issues/assignees.md new file mode 100644 index 0000000000..3d465a739e --- /dev/null +++ b/translations/es-ES/content/rest/issues/assignees.md @@ -0,0 +1,12 @@ +--- +title: Assignees +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/issues/comments.md b/translations/es-ES/content/rest/issues/comments.md new file mode 100644 index 0000000000..9d68676a6a --- /dev/null +++ b/translations/es-ES/content/rest/issues/comments.md @@ -0,0 +1,14 @@ +--- +title: Comments +intro: 'The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Issue Comments use [these custom media types](#custom-media-types). You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/translations/es-ES/content/rest/issues/events.md b/translations/es-ES/content/rest/issues/events.md new file mode 100644 index 0000000000..e6eaa7a53c --- /dev/null +++ b/translations/es-ES/content/rest/issues/events.md @@ -0,0 +1,14 @@ +--- +title: Events +intro: 'The Issue Events API can return different types of events triggered by activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[Events API](/developers/webhooks-and-events/github-event-types)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/issues/index.md b/translations/es-ES/content/rest/issues/index.md new file mode 100644 index 0000000000..11fae409e7 --- /dev/null +++ b/translations/es-ES/content/rest/issues/index.md @@ -0,0 +1,23 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +redirect_from: + - /v3/issues + - /rest/reference/issues +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /issues + - /assignees + - /comments + - /events + - /labels + - /milestones + - /timeline +--- diff --git a/translations/es-ES/content/rest/issues/issues.md b/translations/es-ES/content/rest/issues/issues.md new file mode 100644 index 0000000000..630bf7315f --- /dev/null +++ b/translations/es-ES/content/rest/issues/issues.md @@ -0,0 +1,23 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Custom media types for issues + +These are the supported media types for issues. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/issues/labels.md b/translations/es-ES/content/rest/issues/labels.md new file mode 100644 index 0000000000..c2d910ec3e --- /dev/null +++ b/translations/es-ES/content/rest/issues/labels.md @@ -0,0 +1,12 @@ +--- +title: Labels +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/issues/milestones.md b/translations/es-ES/content/rest/issues/milestones.md new file mode 100644 index 0000000000..2ae71632ba --- /dev/null +++ b/translations/es-ES/content/rest/issues/milestones.md @@ -0,0 +1,12 @@ +--- +title: Milestones +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/issues/timeline.md b/translations/es-ES/content/rest/issues/timeline.md new file mode 100644 index 0000000000..4d7a73e4ca --- /dev/null +++ b/translations/es-ES/content/rest/issues/timeline.md @@ -0,0 +1,16 @@ +--- +title: Timeline +intro: 'The Timeline Events API can return different types of events triggered by timeline activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[GitHub Events API](/developers/webhooks-and-events/github-event-types)." + +You can use this API to display information about issues and pull request or determine who should be notified of issue comments. \ No newline at end of file diff --git a/translations/es-ES/content/rest/licenses.md b/translations/es-ES/content/rest/licenses.md new file mode 100644 index 0000000000..78619bfa73 --- /dev/null +++ b/translations/es-ES/content/rest/licenses.md @@ -0,0 +1,35 @@ +--- +title: Licenses +intro: "The Licenses API lets you to retrieve popular open source licenses and information about a particular project's license file." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/licenses +--- + +The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's `LICENSE` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation. + +If a license is matched, the license key and name returned conforms to the [SPDX specification](https://spdx.org/). + +**Note:** These endpoints will also return a repository's license information: + +- [Get a repository](/rest/reference/repos#get-a-repository) +- [List repositories for a user](/rest/reference/repos#list-repositories-for-a-user) +- [List organization repositories](/rest/reference/repos#list-organization-repositories) +- [List forks](/rest/reference/repos#list-forks) +- [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user) +- [List team repositories](/rest/reference/teams#list-team-repositories) + +{% warning %} + +GitHub is a lot of things, but it’s not a law firm. As such, GitHub does not provide legal advice. Using the Licenses API or sending us an email about it does not constitute legal advice nor does it create an attorney-client relationship. If you have any questions about what you can and can't do with a particular license, you should consult with your own legal counsel before moving forward. In fact, you should always consult with your own lawyer before making any decisions that might have legal ramifications or that may impact your legal rights. + +GitHub created the License API to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers (at least most of us aren't) and that we make mistakes like everyone else. For that reason, GitHub provides the API on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API. + +{% endwarning %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/markdown.md b/translations/es-ES/content/rest/markdown.md new file mode 100644 index 0000000000..2f782424e3 --- /dev/null +++ b/translations/es-ES/content/rest/markdown.md @@ -0,0 +1,14 @@ +--- +title: Markdown +intro: 'The Markdown API enables you to render a markdown document as an HTML page or as raw text.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/markdown +--- diff --git a/translations/es-ES/content/rest/meta.md b/translations/es-ES/content/rest/meta.md new file mode 100644 index 0000000000..6ecb71fe20 --- /dev/null +++ b/translations/es-ES/content/rest/meta.md @@ -0,0 +1,14 @@ +--- +title: Meta +intro: 'The Meta API returns meta information about {% data variables.product.product_name %} including the IP addresses of {% data variables.product.product_name %} services.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/meta +--- diff --git a/translations/es-ES/content/rest/metrics/community.md b/translations/es-ES/content/rest/metrics/community.md new file mode 100644 index 0000000000..725ad20ea0 --- /dev/null +++ b/translations/es-ES/content/rest/metrics/community.md @@ -0,0 +1,10 @@ +--- +title: Community +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/metrics/index.md b/translations/es-ES/content/rest/metrics/index.md new file mode 100644 index 0000000000..4f450b3a9e --- /dev/null +++ b/translations/es-ES/content/rest/metrics/index.md @@ -0,0 +1,20 @@ +--- +title: Metrics +intro: 'The repository metrics API allows you to retrieve community profile, statistics, and traffic for your repository.' +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/repository-metrics + - /rest/reference/metrics +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /community + - /statistics + - /traffic +--- diff --git a/translations/es-ES/content/rest/metrics/statistics.md b/translations/es-ES/content/rest/metrics/statistics.md new file mode 100644 index 0000000000..955c527812 --- /dev/null +++ b/translations/es-ES/content/rest/metrics/statistics.md @@ -0,0 +1,31 @@ +--- +title: Statistics +intro: 'The Repository Statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different types of repository activity.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### A word about caching + +Computing repository statistics is an expensive operation, so we try to return cached +data whenever possible. If the data hasn't been cached when you query a repository's +statistics, you'll receive a `202` response; a background job is also fired to +start compiling these statistics. Give the job a few moments to complete, and +then submit the request again. If the job has completed, that request will receive a +`200` response with the statistics in the response body. + +Repository statistics are cached by the SHA of the repository's default branch; pushing to the default branch resets the statistics cache. + +### Statistics exclude some types of commits + +The statistics exposed by the API match the statistics shown by [different repository graphs](/github/visualizing-repository-data-with-graphs/about-repository-graphs). + +To summarize: +- All statistics exclude merge commits. +- Contributor statistics also exclude empty commits. \ No newline at end of file diff --git a/translations/es-ES/content/rest/metrics/traffic.md b/translations/es-ES/content/rest/metrics/traffic.md new file mode 100644 index 0000000000..9360f43231 --- /dev/null +++ b/translations/es-ES/content/rest/metrics/traffic.md @@ -0,0 +1,12 @@ +--- +title: Traffic +intro: 'For repositories that you have push access to, the traffic API provides access to the information provided in your repository graph. ' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "Viewing traffic to a repository." \ No newline at end of file diff --git a/translations/es-ES/content/rest/migrations/index.md b/translations/es-ES/content/rest/migrations/index.md new file mode 100644 index 0000000000..46ce2d736a --- /dev/null +++ b/translations/es-ES/content/rest/migrations/index.md @@ -0,0 +1,21 @@ +--- +title: Migrations +intro: 'The Migration API lets you migrate the repositories and users of your organization from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.' +redirect_from: + - /v3/migrations + - /v3/migration + - /v3/migration/migrations + - /rest/reference/migrations +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /source-imports + - /users +--- diff --git a/translations/es-ES/content/rest/migrations/orgs.md b/translations/es-ES/content/rest/migrations/orgs.md new file mode 100644 index 0000000000..4ee5218d95 --- /dev/null +++ b/translations/es-ES/content/rest/migrations/orgs.md @@ -0,0 +1,17 @@ +--- +title: Organization +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.organization_migrations_intro %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/migrations/source-imports.md b/translations/es-ES/content/rest/migrations/source-imports.md new file mode 100644 index 0000000000..01bd775089 --- /dev/null +++ b/translations/es-ES/content/rest/migrations/source-imports.md @@ -0,0 +1,87 @@ +--- +title: Source Imports +intro: '{% data variables.migrations.source_imports_intro %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) to find out the status of the import. + +A more detailed example can be seen in this diagram: + +``` ++---------+ +--------+ +---------------------+ +| Tooling | | GitHub | | Original Repository | ++---------+ +--------+ +---------------------+ + | | | + | Start import | | + |----------------------------->| | + | | | + | | Download source data | + | |--------------------------------------------->| + | | Begin streaming data | + | |<---------------------------------------------| + | | | + | Get import progress | | + |----------------------------->| | + | "status": "importing" | | + |<-----------------------------| | + | | | + | Get commit authors | | + |----------------------------->| | + | | | + | Map a commit author | | + |----------------------------->| | + | | | + | | | + | | Finish streaming data | + | |<---------------------------------------------| + | | | + | | Rewrite commits with mapped authors | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Map a commit author | | + |----------------------------->| | + | | Rewrite commits with mapped authors | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Get large files | | + |----------------------------->| | + | | | + | opt_in to Git LFS | | + |----------------------------->| | + | | Rewrite commits for large files | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Get import progress | | + |----------------------------->| | + | "status": "complete" | | + |<-----------------------------| | + | | | + | | | +``` \ No newline at end of file diff --git a/translations/es-ES/content/rest/migrations/users.md b/translations/es-ES/content/rest/migrations/users.md new file mode 100644 index 0000000000..185cc1a43e --- /dev/null +++ b/translations/es-ES/content/rest/migrations/users.md @@ -0,0 +1,20 @@ +--- +title: Users +intro: 'The Users migrations API is only available to authenticated account owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.user_migrations_intro %} For a list of migration data that you can download, see "[Download a user migration archive](#download-a-user-migration-archive)." + +To download an archive, you'll need to start a user migration first. Once the status of the migration is `exported`, you can download the migration. + +Once you've created a migration archive, it will be available to download for seven days. But, you can delete the user migration archive sooner if you'd like. You can unlock your repository when the migration is `exported` to begin using your repository again or delete the repository if you no longer need the source data. diff --git a/translations/es-ES/content/rest/oauth-authorizations.md b/translations/es-ES/content/rest/oauth-authorizations.md new file mode 100644 index 0000000000..2f6e8fab75 --- /dev/null +++ b/translations/es-ES/content/rest/oauth-authorizations.md @@ -0,0 +1,17 @@ +--- +title: OAuth Authorizations +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/oauth-authorizations +--- + +You can use this API to manage the access OAuth applications have to your account. You can only access this API via [Basic Authentication](/rest/overview/other-authentication-methods#basic-authentication) using your username and password, not tokens. + +If you or your users have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication). \ No newline at end of file diff --git a/translations/es-ES/content/rest/orgs/blocking.md b/translations/es-ES/content/rest/orgs/blocking.md new file mode 100644 index 0000000000..9e0982fa5d --- /dev/null +++ b/translations/es-ES/content/rest/orgs/blocking.md @@ -0,0 +1,13 @@ +--- +title: Blocking users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +The token used to authenticate the call must have the `admin:org` scope in order to make any blocking calls for an organization. Otherwise, the response returns `HTTP 404`. \ No newline at end of file diff --git a/translations/es-ES/content/rest/orgs/custom-roles.md b/translations/es-ES/content/rest/orgs/custom-roles.md new file mode 100644 index 0000000000..6944dff7d0 --- /dev/null +++ b/translations/es-ES/content/rest/orgs/custom-roles.md @@ -0,0 +1,14 @@ +--- +title: Custom Repository Roles +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/orgs/custom_roles +--- diff --git a/translations/es-ES/content/rest/orgs/index.md b/translations/es-ES/content/rest/orgs/index.md new file mode 100644 index 0000000000..917eba0b84 --- /dev/null +++ b/translations/es-ES/content/rest/orgs/index.md @@ -0,0 +1,23 @@ +--- +title: Organizations +intro: 'The Organizations API gives you access to control and manage all your {% data variables.product.product_name %} organizations.' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/orgs + - /rest/reference/orgs +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /blocking + - /custom-roles + - /members + - /outside-collaborators + - /webhooks +--- diff --git a/translations/es-ES/content/rest/orgs/members.md b/translations/es-ES/content/rest/orgs/members.md new file mode 100644 index 0000000000..40c46bda07 --- /dev/null +++ b/translations/es-ES/content/rest/orgs/members.md @@ -0,0 +1,12 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/orgs/orgs.md b/translations/es-ES/content/rest/orgs/orgs.md new file mode 100644 index 0000000000..d9d89ac9cb --- /dev/null +++ b/translations/es-ES/content/rest/orgs/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/translations/es-ES/content/rest/orgs/outside-collaborators.md b/translations/es-ES/content/rest/orgs/outside-collaborators.md new file mode 100644 index 0000000000..8975f3a093 --- /dev/null +++ b/translations/es-ES/content/rest/orgs/outside-collaborators.md @@ -0,0 +1,12 @@ +--- +title: Outside Collaborators +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/orgs/webhooks.md b/translations/es-ES/content/rest/orgs/webhooks.md new file mode 100644 index 0000000000..97ae08ff1c --- /dev/null +++ b/translations/es-ES/content/rest/orgs/webhooks.md @@ -0,0 +1,35 @@ +--- +title: Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in an organization. {% data reusables.webhooks.webhooks-rest-api-links %} + +For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)." + +### Scopes & Restrictions + +All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require the `admin:org_hook` scope. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." + +In order to protect sensitive data which may be present in webhook configurations, we also enforce the following access control rules: + +- OAuth applications cannot list, view, or edit webhooks which they did not create. +- Users cannot list, view, or edit webhooks which were created by OAuth applications. + +### Receiving Webhooks + +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +For more best practices, [see our guide](/guides/best-practices-for-integrators/). + +#### Webhook headers + +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/webhooks/event-payloads/#delivery-headers) for details. \ No newline at end of file diff --git a/translations/es-ES/content/rest/packages.md b/translations/es-ES/content/rest/packages.md new file mode 100644 index 0000000000..32204571ad --- /dev/null +++ b/translations/es-ES/content/rest/packages.md @@ -0,0 +1,23 @@ +--- +title: Packages +intro: 'With the {% data variables.product.prodname_registry %} API, you can manage packages for your {% data variables.product.prodname_dotcom %} repositories and organizations.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/packages +--- + +The {% data variables.product.prodname_registry %} API enables you to manage packages using the REST API.{% ifversion fpt or ghec or ghes > 3.1 or ghae %} To learn more about restoring or deleting packages, see "[Restoring and deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)."{% endif %} + +To use this API, you must authenticate using a personal access token. + - To access package metadata, your token must include the `read:packages` scope. + - To delete packages and package versions, your token must include the `read:packages` and `delete:packages` scopes. + - To restore packages and package versions, your token must include the `read:packages` and `write:packages` scopes. + +If your `package_type` is `npm`, `maven`, `rubygems`, or `nuget`, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. If your package is in the {% data variables.product.prodname_container_registry %}, then your `package_type` is `container` and your token does not need the `repo` scope to access or manage this `package_type`. `container` packages offer granular permissions separate from a repository. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)." + +If you want to use the {% data variables.product.prodname_registry %} API to access resources in an organization with SSO enabled, then you must enable SSO for your personal access token. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} diff --git a/translations/es-ES/content/rest/pages.md b/translations/es-ES/content/rest/pages.md new file mode 100644 index 0000000000..2864c8aae6 --- /dev/null +++ b/translations/es-ES/content/rest/pages.md @@ -0,0 +1,14 @@ +--- +title: Pages +intro: 'The GitHub Pages API allows you to interact with GitHub Pages sites and build information.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/pages +--- \ No newline at end of file diff --git a/translations/es-ES/content/rest/projects/cards.md b/translations/es-ES/content/rest/projects/cards.md new file mode 100644 index 0000000000..f92c719935 --- /dev/null +++ b/translations/es-ES/content/rest/projects/cards.md @@ -0,0 +1,12 @@ +--- +title: Cards +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/projects/collaborators.md b/translations/es-ES/content/rest/projects/collaborators.md new file mode 100644 index 0000000000..a68e1809bc --- /dev/null +++ b/translations/es-ES/content/rest/projects/collaborators.md @@ -0,0 +1,13 @@ +--- +title: Collaborators +intro: "This API allows you to interact with an organization's projects." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/translations/es-ES/content/rest/projects/columns.md b/translations/es-ES/content/rest/projects/columns.md new file mode 100644 index 0000000000..e3c0985574 --- /dev/null +++ b/translations/es-ES/content/rest/projects/columns.md @@ -0,0 +1,12 @@ +--- +title: Columns +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/projects/index.md b/translations/es-ES/content/rest/projects/index.md new file mode 100644 index 0000000000..7afcf086c6 --- /dev/null +++ b/translations/es-ES/content/rest/projects/index.md @@ -0,0 +1,20 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +redirect_from: + - /v3/projects + - /rest/reference/projects +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /projects + - /cards + - /collaborators + - /columns +--- diff --git a/translations/es-ES/content/rest/projects/projects.md b/translations/es-ES/content/rest/projects/projects.md new file mode 100644 index 0000000000..ff85668198 --- /dev/null +++ b/translations/es-ES/content/rest/projects/projects.md @@ -0,0 +1,12 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/es-ES/content/rest/pulls/comments.md b/translations/es-ES/content/rest/pulls/comments.md new file mode 100644 index 0000000000..c18aa3d812 --- /dev/null +++ b/translations/es-ES/content/rest/pulls/comments.md @@ -0,0 +1,26 @@ +--- +title: Review Comments +intro: 'Pull request review comments are comments on a portion of the unified diff made during a pull request review.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Commit comments and issue comments are different from pull request review comments. You apply commit comments directly to a commit and you apply issue comments without referencing a portion of the unified diff. For more information, see "[Create a commit comment](/rest/reference/commits#create-a-commit-comment)" and "[Create an issue comment](/rest/reference/issues#create-an-issue-comment)." + +### Custom media types for pull request review comments + +These are the supported media types for pull request review comments. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/reference/pulls.md b/translations/es-ES/content/rest/pulls/index.md similarity index 65% rename from translations/es-ES/content/rest/reference/pulls.md rename to translations/es-ES/content/rest/pulls/index.md index 90834e5cab..17a7f54a5d 100644 --- a/translations/es-ES/content/rest/reference/pulls.md +++ b/translations/es-ES/content/rest/pulls/index.md @@ -3,6 +3,7 @@ title: Pulls intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' redirect_from: - /v3/pulls + - /rest/reference/pulls versions: fpt: '*' ghes: '*' @@ -11,8 +12,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /pulls + - /comments + - /review-requests + - /reviews --- - - diff --git a/translations/es-ES/content/rest/pulls/pulls.md b/translations/es-ES/content/rest/pulls/pulls.md new file mode 100644 index 0000000000..7e094d8d90 --- /dev/null +++ b/translations/es-ES/content/rest/pulls/pulls.md @@ -0,0 +1,46 @@ +--- +title: Pulls +intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](/rest/reference/issues#comments). + +Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like manipulating assignees, labels and milestones, are provided within [the Issues API](/rest/reference/issues). + +### Custom media types for pull requests + +These are the supported media types for pull requests. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + application/vnd.github.VERSION.diff + application/vnd.github.VERSION.patch + +For more information, see "[Custom media types](/rest/overview/media-types)." + +If a diff is corrupt, contact {% data variables.contact.contact_support %}. Include the repository name and pull request ID in your message. + +### Link Relations + +Pull Requests have these possible link relations: + +Name | Description +-----|-----------| +`self`| The API location of this Pull Request. +`html`| The HTML location of this Pull Request. +`issue`| The API location of this Pull Request's [Issue](/rest/reference/issues). +`comments`| The API location of this Pull Request's [Issue comments](/rest/reference/issues#comments). +`review_comments`| The API location of this Pull Request's [Review comments](/rest/reference/pulls#comments). +`review_comment`| The [URL template](/rest#hypermedia) to construct the API location for a [Review comment](/rest/reference/pulls#comments) in this Pull Request's repository. +`commits`|The API location of this Pull Request's [commits](#list-commits-on-a-pull-request). +`statuses`| The API location of this Pull Request's [commit statuses](/rest/reference/commits#commit-statuses), which are the statuses of its `head` branch. diff --git a/translations/es-ES/content/rest/pulls/review-requests.md b/translations/es-ES/content/rest/pulls/review-requests.md new file mode 100644 index 0000000000..dc43b989bb --- /dev/null +++ b/translations/es-ES/content/rest/pulls/review-requests.md @@ -0,0 +1,14 @@ +--- +title: Review Requests +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request. \ No newline at end of file diff --git a/translations/es-ES/content/rest/pulls/reviews.md b/translations/es-ES/content/rest/pulls/reviews.md new file mode 100644 index 0000000000..8912d09ecb --- /dev/null +++ b/translations/es-ES/content/rest/pulls/reviews.md @@ -0,0 +1,13 @@ +--- +title: Reviews +intro: 'Pull Request Reviews are groups of Pull Request Review Comments on the Pull Request, grouped together with a state and optional body comment.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/translations/es-ES/content/rest/rate-limit.md b/translations/es-ES/content/rest/rate-limit.md new file mode 100644 index 0000000000..502ba87c86 --- /dev/null +++ b/translations/es-ES/content/rest/rate-limit.md @@ -0,0 +1,33 @@ +--- +title: Rate limit +intro: 'With the Rate Limit API, you can check the current rate limit status of various REST APIs.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/rate-limit +--- + +The REST API overview documentation describes the [rate limit rules](/rest/overview/resources-in-the-rest-api#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below. + +### Understanding your rate limit status + +The Search API has a [custom rate limit](/rest/reference/search#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations#rate-limit) that is separate from and calculated differently than rate limits in the REST API. + +For these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four +objects: + +* The `core` object provides your rate limit status for all non-search-related resources in the REST API. + +* The `search` object provides your rate limit status for the [Search API](/rest/reference/search). + +* The `graphql` object provides your rate limit status for the [GraphQL API]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql). + +* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint. + +For more information on the headers and values in the rate limit response, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limit-http-headers)." diff --git a/translations/es-ES/content/rest/reactions.md b/translations/es-ES/content/rest/reactions.md new file mode 100644 index 0000000000..6ba29b6b1d --- /dev/null +++ b/translations/es-ES/content/rest/reactions.md @@ -0,0 +1,20 @@ +--- +title: Reactions +intro: 'The Reactions API enables you to create, list and delete the reactions on comments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/reactions +--- + +### Reaction types + +When creating a reaction, the allowed values for the `content` parameter are as follows (with the corresponding emoji for reference): + +{% data reusables.repositories.reaction_list %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/reference/actions.md b/translations/es-ES/content/rest/reference/actions.md deleted file mode 100644 index 683cb89180..0000000000 --- a/translations/es-ES/content/rest/reference/actions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Actions -intro: 'With the Actions API, you can manage and control {% data variables.product.prodname_actions %} for an organization or repository.' -redirect_from: - - /v3/actions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/billing.md b/translations/es-ES/content/rest/reference/billing.md deleted file mode 100644 index 42a5e06e06..0000000000 --- a/translations/es-ES/content/rest/reference/billing.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Billing -intro: 'With the Billing API, you can monitor the charges and usage {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} for a user or organization.' -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.4' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/translations/es-ES/content/rest/reference/branches.md b/translations/es-ES/content/rest/reference/branches.md deleted file mode 100644 index 38db5d41c2..0000000000 --- a/translations/es-ES/content/rest/reference/branches.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Ramas -intro: La API de ramas te permite modificar las ramas y sus ajustes de protección. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/checks.md b/translations/es-ES/content/rest/reference/checks.md deleted file mode 100644 index 2075cb128b..0000000000 --- a/translations/es-ES/content/rest/reference/checks.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Checks -intro: 'With the Checks API, you can build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' -redirect_from: - - /v3/checks -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/translations/es-ES/content/rest/reference/code-scanning.md b/translations/es-ES/content/rest/reference/code-scanning.md deleted file mode 100644 index 87f7efa0a3..0000000000 --- a/translations/es-ES/content/rest/reference/code-scanning.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Escaneo de código -intro: La API de Escaneo de Código te permite recuperar y actualizar las alertas y análisis de escaneo de código desde un repositorio. -redirect_from: - - /v3/code-scanning -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: reference -topics: - - API - - Code scanning - - REST -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/codes-of-conduct.md b/translations/es-ES/content/rest/reference/codes-of-conduct.md deleted file mode 100644 index dfd64ae7b3..0000000000 --- a/translations/es-ES/content/rest/reference/codes-of-conduct.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Códigos de conducta -intro: La API de Códigos de Conducta te permite recuperar la información sobre el código de conducta específico de un repositorio. -redirect_from: - - /v3/codes_of_conduct - - /v3/codes-of-conduct -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/codespaces.md b/translations/es-ES/content/rest/reference/codespaces.md deleted file mode 100644 index 6bc0d14872..0000000000 --- a/translations/es-ES/content/rest/reference/codespaces.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Codespaces -intro: 'La API de {% data variables.product.prodname_codespaces %} te permite administrar tus codespaces utilizando la API de REST.' -product: '{% data reusables.gated-features.codespaces %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/collaborators.md b/translations/es-ES/content/rest/reference/collaborators.md deleted file mode 100644 index ce826663d6..0000000000 --- a/translations/es-ES/content/rest/reference/collaborators.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Colaboradores -intro: 'La API de colaboradores te permite agregar, invitar y eliminar colaboradores de un repositorio.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/commits.md b/translations/es-ES/content/rest/reference/commits.md deleted file mode 100644 index 5317c458e7..0000000000 --- a/translations/es-ES/content/rest/reference/commits.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Confirmaciones -intro: 'La API de confirmaciones te permite listar, ver y comparar confirmaciones en un repositorio. También puedes interactuar con los comentarios y estados de las confirmaciones.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/dependabot.md b/translations/es-ES/content/rest/reference/dependabot.md deleted file mode 100644 index ba8a69ca4b..0000000000 --- a/translations/es-ES/content/rest/reference/dependabot.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Dependabot -intro: 'Con la API de secretos del {% data variables.product.prodname_dependabot %}, puedes administrar y controlar los secretos del {% data variables.product.prodname_dependabot %} para una organización o repositorio.' -versions: - fpt: '*' - ghes: '>=3.4' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/deploy_keys.md b/translations/es-ES/content/rest/reference/deploy_keys.md deleted file mode 100644 index 6c6e6d3f37..0000000000 --- a/translations/es-ES/content/rest/reference/deploy_keys.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Deploy Keys -intro: The Deploy Keys API allows to create an SSH key that is stored on your server and grants access to a GitHub repository. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/deployments.md b/translations/es-ES/content/rest/reference/deployments.md deleted file mode 100644 index 51838a94ba..0000000000 --- a/translations/es-ES/content/rest/reference/deployments.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Implementaciones -intro: La API de despliegues te permite crear y borrar despliegues y ambientes de despliegue. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/emojis.md b/translations/es-ES/content/rest/reference/emojis.md deleted file mode 100644 index 0c28f7ce59..0000000000 --- a/translations/es-ES/content/rest/reference/emojis.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Emojis -intro: 'Con la API de Emojis, puedes listar y ver todos los emojis disponibles para utilizar en {% data variables.product.product_name %}.' -redirect_from: - - /v3/emojis - - /v3/misc -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/enterprise-admin.md b/translations/es-ES/content/rest/reference/enterprise-admin.md deleted file mode 100644 index c68a10d42d..0000000000 --- a/translations/es-ES/content/rest/reference/enterprise-admin.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: GitHub Enterprise administration -intro: You can use these endpoints to administer your enterprise. -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/enterprise-admin - - /v3/enterprise -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 -shortTitle: Enterprise administration ---- - - diff --git a/translations/es-ES/content/rest/reference/gists.md b/translations/es-ES/content/rest/reference/gists.md deleted file mode 100644 index 46aad2876d..0000000000 --- a/translations/es-ES/content/rest/reference/gists.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Gists -intro: 'La API de Gists habilita al usuario autorizado para listar, crear, actualizar y borrar los gists públicos en {% data variables.product.product_name %}.' -redirect_from: - - /v3/gists -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/git.md b/translations/es-ES/content/rest/reference/git.md deleted file mode 100644 index 1504ac51e6..0000000000 --- a/translations/es-ES/content/rest/reference/git.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Base de datos de Git -intro: 'La API de base de datos de Git te permite leer y escribir objetos sin procesar de Git en tu base de datos de Git en {% data variables.product.product_name %} y listar y actualizar las referencias de Git (encabezados de rama y etiquetas).' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/git -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/gitignore.md b/translations/es-ES/content/rest/reference/gitignore.md deleted file mode 100644 index a651874adb..0000000000 --- a/translations/es-ES/content/rest/reference/gitignore.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Gitignore -intro: La API de Gitignore recupera las plantillas de `.gitignore` que pueden utilizarse para ignorar archivos y directorios. -redirect_from: - - /v3/gitignore -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/index.md b/translations/es-ES/content/rest/reference/index.md deleted file mode 100644 index b2a283c0af..0000000000 --- a/translations/es-ES/content/rest/reference/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Referencia -shortTitle: Referencia -intro: Lee la documentación de referencia para conocer sobre los recursos que están disponibles en la API de REST de GitHub. -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -children: - - /actions - - /activity - - /apps - - /billing - - /branches - - /checks - - /codes-of-conduct - - /code-scanning - - /codespaces - - /collaborators - - /commits - - /dependabot - - /dependency-graph - - /deploy_keys - - /deployments - - /emojis - - /enterprise-admin - - /gists - - /git - - /gitignore - - /interactions - - /issues - - /licenses - - /markdown - - /meta - - /metrics - - /migrations - - /oauth-authorizations - - /orgs - - /packages - - /pages - - /projects - - /pulls - - /rate-limit - - /reactions - - /releases - - /repos - - /scim - - /search - - /secret-scanning - - /teams - - /users - - /webhooks ---- - diff --git a/translations/es-ES/content/rest/reference/interactions.md b/translations/es-ES/content/rest/reference/interactions.md deleted file mode 100644 index b839ad92a7..0000000000 --- a/translations/es-ES/content/rest/reference/interactions.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Interacciones -intro: 'Con la API de interacciones, las personas con acceso administrativo o de propietario pueden configurar el límite de interacciones para los usuarios en sus organizaciones y repositorios.' -redirect_from: - - /v3/interactions -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/issues.md b/translations/es-ES/content/rest/reference/issues.md deleted file mode 100644 index 0381301db9..0000000000 --- a/translations/es-ES/content/rest/reference/issues.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Problemas -intro: 'La API de Propuestas te permite ver y administrar las propuestas, incluyendo a sus asignados, comentarios, etiquetas e hitos.' -redirect_from: - - /v3/issues -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/licenses.md b/translations/es-ES/content/rest/reference/licenses.md deleted file mode 100644 index e7fbd1e995..0000000000 --- a/translations/es-ES/content/rest/reference/licenses.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Licencias -intro: La API de Licencias te permite recuperar las licencias populares de código abierto y la información sobre un archivo de licencia de un proyecto en particular. -redirect_from: - - /v3/licenses -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/markdown.md b/translations/es-ES/content/rest/reference/markdown.md deleted file mode 100644 index 43aba49657..0000000000 --- a/translations/es-ES/content/rest/reference/markdown.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Markdown -intro: La API de Lenguaje de marcado te permite generar un documento de lenguaje de marcado como una página HTML o como texto sin procesar. -redirect_from: - - /v3/markdown -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/meta.md b/translations/es-ES/content/rest/reference/meta.md deleted file mode 100644 index aa2eea1448..0000000000 --- a/translations/es-ES/content/rest/reference/meta.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Meta -intro: 'La API de Meta devuelve la información de meta sobre {% data variables.product.product_name %}, incluyendo las direcciones IP de los servicios de {% data variables.product.product_name %}.' -redirect_from: - - /v3/meta -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/metrics.md b/translations/es-ES/content/rest/reference/metrics.md deleted file mode 100644 index 5f39a33d8e..0000000000 --- a/translations/es-ES/content/rest/reference/metrics.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Metrics -intro: 'La API de las métricas de repositorio te permiten recuperar el perfil, estadísticas y tráfico de la comunidad para tu repositorio.' -allowTitleToDifferFromFilename: true -redirect_from: - - /rest/reference/repository-metrics -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/migrations.md b/translations/es-ES/content/rest/reference/migrations.md deleted file mode 100644 index a49666dce7..0000000000 --- a/translations/es-ES/content/rest/reference/migrations.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Migraciones -intro: 'La API de Migración te permite migrar los repositorios y usuarios de tu organización de {% data variables.product.prodname_dotcom_the_website %} a {% data variables.product.prodname_ghe_server %}.' -redirect_from: - - /v3/migrations - - /v3/migration - - /v3/migration/migrations -versions: - fpt: '*' - ghec: '*' - ghes: '>3.3' - ghae: issue-6184 -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/oauth-authorizations.md b/translations/es-ES/content/rest/reference/oauth-authorizations.md deleted file mode 100644 index dc3e120e98..0000000000 --- a/translations/es-ES/content/rest/reference/oauth-authorizations.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Autorizaciones de OAuth -redirect_from: - - /v3/oauth_authorizations - - /v3/oauth-authorizations -versions: - ghes: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/orgs.md b/translations/es-ES/content/rest/reference/orgs.md deleted file mode 100644 index 63baa20df7..0000000000 --- a/translations/es-ES/content/rest/reference/orgs.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Organizaciones -intro: 'La API de Organizaciones te da acceso para controlar y administrar todas tus organizaciones de {% data variables.product.product_name %}.' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/orgs -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/packages.md b/translations/es-ES/content/rest/reference/packages.md deleted file mode 100644 index 65ebafa631..0000000000 --- a/translations/es-ES/content/rest/reference/packages.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Packages -intro: 'Con la API del {% data variables.product.prodname_registry %}, puedes administrar paquetes para tus repositorios y organizaciones de {% data variables.product.prodname_dotcom %}.' -product: '{% data reusables.gated-features.packages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/pages.md b/translations/es-ES/content/rest/reference/pages.md deleted file mode 100644 index c5c7960548..0000000000 --- a/translations/es-ES/content/rest/reference/pages.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Pages -intro: La API de GitHub Pages te permite interactuar con la información de compilación y los sitios de GitHub Pages. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/projects.md b/translations/es-ES/content/rest/reference/projects.md deleted file mode 100644 index 7190b6ce7b..0000000000 --- a/translations/es-ES/content/rest/reference/projects.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Proyectos -intro: 'La API de Proyectos te permite crear, listar, actualizar, borrar y personalizar los proyectos en un repositorio.' -redirect_from: - - /v3/projects -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/rate-limit.md b/translations/es-ES/content/rest/reference/rate-limit.md deleted file mode 100644 index ec13bdc807..0000000000 --- a/translations/es-ES/content/rest/reference/rate-limit.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Limite de tasa -intro: 'Con la API de Límite de Tasa, puedes verificar el estado de límite de tasa actual para varias API de REST.' -redirect_from: - - /v3/rate_limit - - /v3/rate-limit -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/reactions.md b/translations/es-ES/content/rest/reference/reactions.md deleted file mode 100644 index 8f9506da01..0000000000 --- a/translations/es-ES/content/rest/reference/reactions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Reacciones -intro: 'La API de Reacciones te permite crear, listar y borrar las reacciones en los comentarios.' -redirect_from: - - /v3/reactions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/releases.md b/translations/es-ES/content/rest/reference/releases.md deleted file mode 100644 index 305835b030..0000000000 --- a/translations/es-ES/content/rest/reference/releases.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Lanzamientos -intro: 'La API de lanzamientos te permite crear, modificar y borrar los lanzamientos y los activos de estos.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/scim.md b/translations/es-ES/content/rest/reference/scim.md deleted file mode 100644 index 4dc117d0ac..0000000000 --- a/translations/es-ES/content/rest/reference/scim.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: SCIM -intro: 'Puedes controlar y administrar el accesp de tus miembros de la organización de {% data variables.product.product_name %} utilizando la API de SCIM.' -redirect_from: - - /v3/scim -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/search.md b/translations/es-ES/content/rest/reference/search.md deleted file mode 100644 index f22157a05e..0000000000 --- a/translations/es-ES/content/rest/reference/search.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Buscar -intro: 'La API de búsqueda de {% data variables.product.product_name %} te permite buscar el elemento específico eficientemente.' -redirect_from: - - /v3/search -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/secret-scanning.md b/translations/es-ES/content/rest/reference/secret-scanning.md deleted file mode 100644 index ffdc5f95b9..0000000000 --- a/translations/es-ES/content/rest/reference/secret-scanning.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Escaneo de secretos -intro: Utiliza la API de escaneo de secretos para recuperar y actualizar las alertas secretas de un repositorio. -versions: - fpt: '*' - ghes: '*' - ghec: '*' - ghae: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/teams.md b/translations/es-ES/content/rest/reference/teams.md deleted file mode 100644 index b1da1945f4..0000000000 --- a/translations/es-ES/content/rest/reference/teams.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Equipos -intro: 'Con la API de Equipos puedes crear y administrar los equipos en tu organización de {% data variables.product.product_name %}.' -redirect_from: - - /v3/teams -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/users.md b/translations/es-ES/content/rest/reference/users.md deleted file mode 100644 index e17aeff265..0000000000 --- a/translations/es-ES/content/rest/reference/users.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Usuarios -intro: La API de Usuarios te permite obtener información pública y privada sobre el usuario autenticado. -redirect_from: - - /v3/users -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/reference/webhooks.md b/translations/es-ES/content/rest/reference/webhooks.md deleted file mode 100644 index c7ed6d9d52..0000000000 --- a/translations/es-ES/content/rest/reference/webhooks.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Webhooks -intro: La API de webhooks te permite crear y administrar webhooks para tus repositorios. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/es-ES/content/rest/releases/assets.md b/translations/es-ES/content/rest/releases/assets.md new file mode 100644 index 0000000000..44956c13a1 --- /dev/null +++ b/translations/es-ES/content/rest/releases/assets.md @@ -0,0 +1,13 @@ +--- +title: Release Assets +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/releases/index.md b/translations/es-ES/content/rest/releases/index.md new file mode 100644 index 0000000000..c3447b9110 --- /dev/null +++ b/translations/es-ES/content/rest/releases/index.md @@ -0,0 +1,18 @@ +--- +title: Releases +intro: 'The releases API allows you to create, modify, and delete releases and release assets.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /releases + - /assets +redirect_from: + - /rest/reference/releases +--- diff --git a/translations/es-ES/content/rest/releases/releases.md b/translations/es-ES/content/rest/releases/releases.md new file mode 100644 index 0000000000..fa1cb398fc --- /dev/null +++ b/translations/es-ES/content/rest/releases/releases.md @@ -0,0 +1,19 @@ +--- +title: Releases +intro: 'The Releases API allows you to create, modify, and delete releases and release assets. +' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% note %} + +**Note:** The Releases API replaces the Downloads API. You can retrieve the download count and browser download URL from the endpoints in this API that return releases and release assets. + +{% endnote %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/repos/autolinks.md b/translations/es-ES/content/rest/repos/autolinks.md new file mode 100644 index 0000000000..ba9b5afafd --- /dev/null +++ b/translations/es-ES/content/rest/repos/autolinks.md @@ -0,0 +1,16 @@ +--- +title: Autolinks +intro: 'To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets.' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." + +{% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. \ No newline at end of file diff --git a/translations/es-ES/content/rest/repos/contents.md b/translations/es-ES/content/rest/repos/contents.md new file mode 100644 index 0000000000..a402506eeb --- /dev/null +++ b/translations/es-ES/content/rest/repos/contents.md @@ -0,0 +1,34 @@ +--- +title: Contents +intro: 'These API endpoints let you create, modify, and delete Base64 encoded content in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +To request the raw format or rendered HTML (when supported), use custom media types for repository contents. + +### Custom media types for repository contents + +[READMEs](/rest/reference/repos#get-a-repository-readme), [files](/rest/reference/repos#get-repository-content), and [symlinks](/rest/reference/repos#get-repository-content) support the following custom media types: + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.html + +Use the `.raw` media type to retrieve the contents of the file. + +For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). + +[All objects](/rest/reference/repos#get-repository-content) support the following custom media type: + + application/vnd.github.VERSION.object + +Use the `object` media type parameter to retrieve the contents in a consistent object format regardless of the content type. For example, instead of an array of objects +for a directory, the response will be an object with an `entries` attribute containing the array of objects. + +You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/translations/es-ES/content/rest/repos/forks.md b/translations/es-ES/content/rest/repos/forks.md new file mode 100644 index 0000000000..5a7928f9aa --- /dev/null +++ b/translations/es-ES/content/rest/repos/forks.md @@ -0,0 +1,12 @@ +--- +title: Forks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/reference/repos.md b/translations/es-ES/content/rest/repos/index.md similarity index 71% rename from translations/pt-BR/content/rest/reference/repos.md rename to translations/es-ES/content/rest/repos/index.md index 51710d0f0c..7232e7da73 100644 --- a/translations/pt-BR/content/rest/reference/repos.md +++ b/translations/es-ES/content/rest/repos/index.md @@ -4,6 +4,7 @@ intro: 'The Repos API allows to create, manage and control the workflow of publi allowTitleToDifferFromFilename: true redirect_from: - /v3/repos + - /rest/reference/repos versions: fpt: '*' ghes: '*' @@ -12,8 +13,11 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /repos + - /autolinks + - /contents + - /forks + - /lfs + - /tags --- - - \ No newline at end of file diff --git a/translations/es-ES/content/rest/repos/lfs.md b/translations/es-ES/content/rest/repos/lfs.md new file mode 100644 index 0000000000..3b11137030 --- /dev/null +++ b/translations/es-ES/content/rest/repos/lfs.md @@ -0,0 +1,13 @@ +--- +title: Git LFS +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/repos/repos.md b/translations/es-ES/content/rest/repos/repos.md new file mode 100644 index 0000000000..8941c62602 --- /dev/null +++ b/translations/es-ES/content/rest/repos/repos.md @@ -0,0 +1,13 @@ +--- +title: Repositories +intro: 'The Repos API allows to create, manage and control the workflow of public and private GitHub Enterprise Server repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/repos/tags.md b/translations/es-ES/content/rest/repos/tags.md new file mode 100644 index 0000000000..7685300da2 --- /dev/null +++ b/translations/es-ES/content/rest/repos/tags.md @@ -0,0 +1,10 @@ +--- +title: Tags +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/es-ES/content/rest/scim.md b/translations/es-ES/content/rest/scim.md new file mode 100644 index 0000000000..8f63ea1bb9 --- /dev/null +++ b/translations/es-ES/content/rest/scim.md @@ -0,0 +1,54 @@ +--- +title: SCIM +intro: 'You can control and manage your GitHub organization members access using SCIM API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/scim +--- + +### SCIM Provisioning for Organizations + +The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.product_name %} organization membership. The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). The {% data variables.product.product_name %} SCIM endpoint that an IdP should use is: `{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`. + +{% note %} + +**Notes:** + - The SCIM API is available only to organizations on [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. {% data reusables.scim.enterprise-account-scim %} For more information about SCIM, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." + - The SCIM API cannot be used with {% data variables.product.prodname_emus %}. + +{% endnote %} + +### Authenticating calls to the SCIM API + +You must authenticate as an owner of a {% data variables.product.product_name %} organization to use its SCIM API. The API expects an [OAuth 2.0 Bearer](/developers/apps/authenticating-with-github-apps) token to be included in the `Authorization` header. You may also use a personal access token, but you must first [authorize it for use with your SAML SSO organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). + +### Mapping of SAML and SCIM data + +{% data reusables.scim.nameid-and-username-must-match %} + +### Supported SCIM User attributes + +Name | Type | Description +-----|------|-------------- +`userName`|`string` | The username for the user. +`name.givenName`|`string` | The first name of the user. +`name.familyName`|`string` | The last name of the user. +`emails` | `array` | List of user emails. +`externalId` | `string` | This identifier is generated by the SAML provider, and is used as a unique ID by the SAML provider to match against a GitHub user. You can find the `externalID` for a user either at the SAML provider, or using the [List SCIM provisioned identities](#list-scim-provisioned-identities) endpoint and filtering on other known attributes, such as a user's GitHub username or email address. +`id` | `string` | Identifier generated by the GitHub SCIM endpoint. +`active` | `boolean` | Used to indicate whether the identity is active (true) or should be deprovisioned (false). + +{% note %} + +**Note:** Endpoint URLs for the SCIM API are case sensitive. For example, the first letter in the `Users` endpoint must be capitalized: + +```shell +GET /scim/v2/organizations/{org}/Users/{scim_user_id} +``` + +{% endnote %} diff --git a/translations/es-ES/content/rest/search.md b/translations/es-ES/content/rest/search.md new file mode 100644 index 0000000000..a463da9363 --- /dev/null +++ b/translations/es-ES/content/rest/search.md @@ -0,0 +1,175 @@ +--- +title: Search +intro: 'The GitHub Search API lets you to search for the specific item efficiently.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/search +--- + +The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. + +You can narrow your search using queries. To learn more about the search query syntax, see "[Constructing a search query](/rest/reference/search#constructing-a-search-query)." + +### Ranking search results + +Unless another sort option is provided as a query parameter, results are sorted by best match in descending order. Multiple factors are combined to boost the most relevant item to the top of the result list. + +### Rate limit + +{% data reusables.enterprise.rate_limit %} + +The Search API has a custom rate limit. For requests using [Basic +Authentication](/rest#authentication), [OAuth](/rest#authentication), or [client +ID and secret](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to +30 requests per minute. For unauthenticated requests, the rate limit allows you +to make up to 10 requests per minute. + +See the [rate limit documentation](/rest/reference/rate-limit) for details on +determining your current rate limit status. + +### Constructing a search query + +Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoint in the Search API for an example that includes the endpoint and query parameters. + +A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: + +``` +SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N +``` + +For example, if you wanted to search for all _repositories_ owned by `defunkt` that +contained the word `GitHub` and `Octocat` in the README file, you would use the +following query with the _search repositories_ endpoint: + +``` +GitHub Octocat in:readme user:defunkt +``` + +**Note:** Be sure to use your language's preferred HTML-encoder to construct your query strings. For example: +```javascript +// JavaScript +const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); +``` + +See "[Searching on GitHub](/search-github/searching-on-github)" +for a complete list of available qualifiers, their format, and an example of +how to use them. For information about how to use operators to match specific +quantities, dates, or to exclude results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)." + +### Limitations on query length + +The Search API does not support queries that: +- are longer than 256 characters (not including operators or qualifiers). +- have more than five `AND`, `OR`, or `NOT` operators. + +These search queries will return a "Validation failed" error message. + +### Timeouts and incomplete results + +To keep the Search API fast for everyone, we limit how long any individual query +can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), +the API returns the matches that were already found prior to the timeout, and +the response has the `incomplete_results` property set to `true`. + +Reaching a timeout does not necessarily mean that search results are incomplete. +More results might have been found, but also might not. + +### Access errors or missing search results + +You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a `422 Unprocessable Entry` error with a "Validation Failed" message. For example, your search will fail if your query includes `repo:`, `user:`, or `org:` qualifiers that request resources that you don't have access to when you sign in on {% data variables.product.prodname_dotcom %}. + +When your search query requests multiple resources, the response will only contain the resources that you have access to and will **not** provide an error message listing the resources that were not returned. + +For example, if your search query searches for the `octocat/test` and `codertocat/test` repositories, but you only have access to `octocat/test`, your response will show search results for `octocat/test` and nothing for `codertocat/test`. This behavior mimics how search works on {% data variables.product.prodname_dotcom %}. + +### Text match metadata + +On GitHub, you can use the context provided by code snippets and highlights in search results. The Search API offers additional metadata that allows you to highlight the matching search terms when displaying search results. + +![code-snippet-highlighting](/assets/images/text-match-search-api.png) + +Requests can opt to receive those text fragments in the response, and every fragment is accompanied by numeric offsets identifying the exact location of each matching search term. + +To get this metadata in your search results, specify the `text-match` media type in your `Accept` header. + +```shell +application/vnd.github.v3.text-match+json +``` + +When you provide the `text-match` media type, you will receive an extra key in the JSON payload called `text_matches` that provides information about the position of your search terms within the text and the `property` that includes the search term. Inside the `text_matches` array, each object includes +the following attributes: + +Name | Description +-----|-----------| +`object_url` | The URL for the resource that contains a string property matching one of the search terms. +`object_type` | The name for the type of resource that exists at the given `object_url`. +`property` | The name of a property of the resource that exists at `object_url`. That property is a string that matches one of the search terms. (In the JSON returned from `object_url`, the full content for the `fragment` will be found in the property with this name.) +`fragment` | A subset of the value of `property`. This is the text fragment that matches one or more of the search terms. +`matches` | An array of one or more search terms that are present in `fragment`. The indices (i.e., "offsets") are relative to the fragment. (They are not relative to the _full_ content of `property`.) + +#### Example + +Using cURL, and the [example issue search](#search-issues-and-pull-requests) above, our API +request would look like this: + +``` shell +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ +'{% data variables.product.api_url_pre %}/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' +``` + +The response will include a `text_matches` array for each search result. In the JSON below, we have two objects in the `text_matches` array. + +The first text match occurred in the `body` property of the issue. We see a fragment of text from the issue body. The search term (`windows`) appears twice within that fragment, and we have the indices for each occurrence. + +The second text match occurred in the `body` property of one of the issue's comments. We have the URL for the issue comment. And of course, we see a fragment of text from the comment body. The search term (`windows`) appears once within that fragment. + +```json +{ + "text_matches": [ + { + "object_url": "https://api.github.com/repositories/215335/issues/132", + "object_type": "Issue", + "property": "body", + "fragment": "comprehensive windows font I know of).\n\nIf we can find a commonly distributed windows font that supports them then no problem (we can use html font tags) but otherwise the '(21)' style is probably better.\n", + "matches": [ + { + "text": "windows", + "indices": [ + 14, + 21 + ] + }, + { + "text": "windows", + "indices": [ + 78, + 85 + ] + } + ] + }, + { + "object_url": "https://api.github.com/repositories/215335/issues/comments/25688", + "object_type": "IssueComment", + "property": "body", + "fragment": " right after that are a bit broken IMHO :). I suppose we could have some hack that maxes out at whatever the font does...\n\nI'll check what the state of play is on Windows.\n", + "matches": [ + { + "text": "Windows", + "indices": [ + 163, + 170 + ] + } + ] + } + ] +} +``` diff --git a/translations/es-ES/content/rest/secret-scanning.md b/translations/es-ES/content/rest/secret-scanning.md new file mode 100644 index 0000000000..fad846994e --- /dev/null +++ b/translations/es-ES/content/rest/secret-scanning.md @@ -0,0 +1,23 @@ +--- +title: Secret Scanning +intro: 'Use the Secret Scanning API to retrieve and update secret alerts from a repository.' +versions: + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/secret-scanning +--- + +{% data reusables.secret-scanning.api-beta %} + +The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae %}: + +- Enable or disable {% data variables.product.prodname_secret_scanning %}{% if secret-scanning-push-protection %} and push protection{% endif %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" and expand the "Properties of the `security_and_analysis` object" section in the REST API documentation. +- Retrieve and update {% data variables.product.prodname_secret_scanning_GHAS %} alerts from a repository. For further details, see the sections below. +{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a repository.{% endif %} + +For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." diff --git a/translations/es-ES/content/rest/teams/discussion-comments.md b/translations/es-ES/content/rest/teams/discussion-comments.md new file mode 100644 index 0000000000..0dde5647e0 --- /dev/null +++ b/translations/es-ES/content/rest/teams/discussion-comments.md @@ -0,0 +1,14 @@ +--- +title: Discussion Comments +intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/translations/es-ES/content/rest/teams/discussions.md b/translations/es-ES/content/rest/teams/discussions.md new file mode 100644 index 0000000000..1a6cc51805 --- /dev/null +++ b/translations/es-ES/content/rest/teams/discussions.md @@ -0,0 +1,14 @@ +--- +title: Discussions +intro: "The Team Discussions API allows you to get, create, edit, and delete discussion posts on a team's page." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/translations/es-ES/content/rest/teams/external-groups.md b/translations/es-ES/content/rest/teams/external-groups.md new file mode 100644 index 0000000000..ab172bd084 --- /dev/null +++ b/translations/es-ES/content/rest/teams/external-groups.md @@ -0,0 +1,24 @@ +--- +title: External Groups +intro: 'The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.' +versions: + fpt: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. + +{% ifversion ghec %} +{% note %} + +**Notes:** + +- The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." +- If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/teams/index.md b/translations/es-ES/content/rest/teams/index.md new file mode 100644 index 0000000000..fc2c3a44cb --- /dev/null +++ b/translations/es-ES/content/rest/teams/index.md @@ -0,0 +1,22 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your {% data variables.product.product_name %} organization.' +redirect_from: + - /v3/teams + - /rest/reference/teams +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /teams + - /discussion-comments + - /discussions + - /external-groups + - /members + - /team-sync +--- diff --git a/translations/es-ES/content/rest/teams/members.md b/translations/es-ES/content/rest/teams/members.md new file mode 100644 index 0000000000..fdcee06601 --- /dev/null +++ b/translations/es-ES/content/rest/teams/members.md @@ -0,0 +1,23 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + +{% ifversion fpt or ghes or ghec %} +{% note %} + +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% endnote %} + +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/teams/team-sync.md b/translations/es-ES/content/rest/teams/team-sync.md new file mode 100644 index 0000000000..3b6dfa15dd --- /dev/null +++ b/translations/es-ES/content/rest/teams/team-sync.md @@ -0,0 +1,21 @@ +--- +title: Team Synchronization +intro: 'The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." + +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% note %} + +**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". + +{% endnote %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/teams/teams.md b/translations/es-ES/content/rest/teams/teams.md new file mode 100644 index 0000000000..fa741a215e --- /dev/null +++ b/translations/es-ES/content/rest/teams/teams.md @@ -0,0 +1,14 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your GitHub organization.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. diff --git a/translations/es-ES/content/rest/users/blocking.md b/translations/es-ES/content/rest/users/blocking.md new file mode 100644 index 0000000000..297347554f --- /dev/null +++ b/translations/es-ES/content/rest/users/blocking.md @@ -0,0 +1,11 @@ +--- +title: Blocking Users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/users/emails.md b/translations/es-ES/content/rest/users/emails.md new file mode 100644 index 0000000000..1526e6e0a6 --- /dev/null +++ b/translations/es-ES/content/rest/users/emails.md @@ -0,0 +1,13 @@ +--- +title: Emails +intro: '' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Management of email addresses via the API requires that you authenticate through basic auth, or through OAuth with a correct scope for the endpoint. \ No newline at end of file diff --git a/translations/es-ES/content/rest/users/followers.md b/translations/es-ES/content/rest/users/followers.md new file mode 100644 index 0000000000..b93b9303cd --- /dev/null +++ b/translations/es-ES/content/rest/users/followers.md @@ -0,0 +1,12 @@ +--- +title: Followers +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/es-ES/content/rest/users/gpg-keys.md b/translations/es-ES/content/rest/users/gpg-keys.md new file mode 100644 index 0000000000..8cc12ab55d --- /dev/null +++ b/translations/es-ES/content/rest/users/gpg-keys.md @@ -0,0 +1,14 @@ +--- +title: GPG Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The data returned in the `public_key` response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what is returned by the APIs on this page. This key is not suitable to be used directly by programs like GPG. \ No newline at end of file diff --git a/translations/es-ES/content/rest/users/index.md b/translations/es-ES/content/rest/users/index.md new file mode 100644 index 0000000000..22145785f5 --- /dev/null +++ b/translations/es-ES/content/rest/users/index.md @@ -0,0 +1,22 @@ +--- +title: Users +intro: The Users API allows to get public and private information about the authenticated user. +redirect_from: + - /v3/users + - /rest/reference/users +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /users + - /blocking + - /emails + - /followers + - /gpg-keys + - /keys +--- diff --git a/translations/es-ES/content/rest/users/keys.md b/translations/es-ES/content/rest/users/keys.md new file mode 100644 index 0000000000..ac61f9554f --- /dev/null +++ b/translations/es-ES/content/rest/users/keys.md @@ -0,0 +1,13 @@ +--- +title: Git SSH Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/translations/es-ES/content/rest/users/users.md b/translations/es-ES/content/rest/users/users.md new file mode 100644 index 0000000000..e299587e74 --- /dev/null +++ b/translations/es-ES/content/rest/users/users.md @@ -0,0 +1,14 @@ +--- +title: Users +intro: 'The Users API allows to get public and private information about the authenticated user.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a `{username}` parameter then the response will be for the logged in user (and you must pass [authentication information](/rest/overview/resources-in-the-rest-api#authentication) with your request).{% ifversion fpt or ghes or ghec %} Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the `user` scope.{% endif %} \ No newline at end of file diff --git a/translations/es-ES/content/rest/webhooks/index.md b/translations/es-ES/content/rest/webhooks/index.md new file mode 100644 index 0000000000..fb833f3c0b --- /dev/null +++ b/translations/es-ES/content/rest/webhooks/index.md @@ -0,0 +1,79 @@ +--- +title: Webhooks +intro: The webhooks API allows you to create and manage webhooks for your repositories. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /repo-config + - /repo-deliveries + - /repos +redirect_from: + - /rest/reference/webhooks +--- + +Repository webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in a repository. {% data reusables.webhooks.webhooks-rest-api-links %} + +If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks). + +In addition to the REST API, {% data variables.product.prodname_dotcom %} can also serve as a [PubSubHubbub](#pubsubhubbub) hub for repositories. + +## Receiving Webhooks + +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +### Webhook headers + +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers) for details. + +## PubSubHubbub + +GitHub can also serve as a [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) hub for all repositories. PSHB is a simple publish/subscribe protocol that lets servers register to receive updates when a topic is updated. The updates are sent with an HTTP POST request to a callback URL. +Topic URLs for a GitHub repository's pushes are in this format: + +`https://github.com/{owner}/{repo}/events/{event}` + +The event can be any available webhook event. For more information, see "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads)." + +### Response format + +The default format is what [existing post-receive hooks should expect](/post-receive-hooks/): A JSON body sent as the `payload` parameter in a POST. You can also specify to receive the raw JSON body with either an `Accept` header, or a `.json` extension. + + Accept: application/json + https://github.com/{owner}/{repo}/events/push.json + +### Callback URLs + +Callback URLs can use the `http://` protocol. + + # Send updates to postbin.org + http://postbin.org/123 + +### Subscribing + +The GitHub PubSubHubbub endpoint is: `{% data variables.product.api_url_code %}/hub`. A successful request with curl looks like: + +``` shell +curl -u "user" -i \ + {% data variables.product.api_url_pre %}/hub \ + -F "hub.mode=subscribe" \ + -F "hub.topic=https://github.com/{owner}/{repo}/events/push" \ + -F "hub.callback=http://postbin.org/123" +``` + +PubSubHubbub requests can be sent multiple times. If the hook already exists, it will be modified according to the request. + +#### Parameters + +Name | Type | Description +-----|------|-------------- +``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. +``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. +``hub.callback``|`string` | The URI to receive the updates to the topic. +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 3.0 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. \ No newline at end of file diff --git a/translations/es-ES/content/rest/webhooks/repo-config.md b/translations/es-ES/content/rest/webhooks/repo-config.md new file mode 100644 index 0000000000..5653146886 --- /dev/null +++ b/translations/es-ES/content/rest/webhooks/repo-config.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Configuration +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/webhooks/repo-deliveries.md b/translations/es-ES/content/rest/webhooks/repo-deliveries.md new file mode 100644 index 0000000000..ee3f49cc36 --- /dev/null +++ b/translations/es-ES/content/rest/webhooks/repo-deliveries.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Deliveries +intro: '' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/es-ES/content/rest/webhooks/repos.md b/translations/es-ES/content/rest/webhooks/repos.md new file mode 100644 index 0000000000..51d4dd89a8 --- /dev/null +++ b/translations/es-ES/content/rest/webhooks/repos.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md index 5fc5483539..d1cdc255de 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md @@ -18,7 +18,11 @@ shortTitle: Organization's profile You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4749 %} You can customize your organization's profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %} -{% ifversion fpt or ghec %}自分の Organization の素性を確認し、Organization のプロフィールページに "Verified (検証済み)" バッジを表示するには、Organization のドメインを {% data variables.product.product_name %}で検証しなければなりません。 For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)."{% endif %} +{% ifversion fpt %} +Organizations that use {% data variables.product.prodname_ghe_cloud %} can confirm their organization's identity and display a "Verified" badge on their organization's profile page by verifying the organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)" in the {% data variables.product.prodname_ghe_cloud %} documenatation. +{% elsif ghec or ghes > 3.1 %} +To confirm your organization's identity and display a "Verified" badge on your organization profile page, you can verify your organization's domains with {% data variables.product.prodname_dotcom %}. 詳しい情報については「[Organizationのドメインの検証もしくは承認](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)」を参照してください。 +{% endif %} {% ifversion fpt or ghes > 3.2 or ghec %} ![Organization プロフィールページのサンプル](/assets/images/help/organizations/org_profile_with_overview.png) diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 9426b2ff4b..7adf2c01fc 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -45,7 +45,7 @@ For more information about installing and using self-hosted runners, see "[Addin - Use free minutes on your {% data variables.product.prodname_dotcom %} plan, with per-minute rates applied after surpassing the free minutes. **Self-hosted runners:**{% endif %} -- Receive automatic updates for the self-hosted runner application only{% ifversion fpt or ghec or ghes > 3.2 %}, though you may disable automatic updates of the runner. For more information about controlling runner software updates on self-hosted runners, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)."{% else %}.{% endif %} You are responsible for updating the operating system and all other software. +- Receive automatic updates for the self-hosted runner application only{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6143 %}, though you may disable automatic updates of the runner. For more information about controlling runner software updates on self-hosted runners, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)."{% else %}.{% endif %} You are responsible for updating the operating system and all other software. - Can use cloud services or local machines that you already pay for. - Are customizable to your hardware, operating system, software, and security requirements. - Don't need to have a clean instance for every job execution. diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index fae179712b..502e37383f 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -54,6 +54,8 @@ The {% data variables.product.prodname_actions %} service will then automaticall {% endnote %} +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6143 %} + ## Controlling runner software updates on self-hosted runners By default, self-hosted runners will automatically perform a software update whenever a new version of the runner software is available. If you use ephemeral runners in containers then this can lead to repeated software updates when a new runner version is released. Turning off automatic updates allows you to update the runner version on the container image directly on your own schedule. @@ -76,6 +78,8 @@ For instructions on how to install the latest runner version, see the installati {% endnote %} +{% endif %} + ## Using webhooks for autoscaling You can create your own autoscaling environment by using payloads received from the [`workflow_job`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) webhook. This webhook is available at the repository, organization, and enterprise levels, and the payload for this event contains an `action` key that corresponds to the stages of a workflow job's life-cycle; for example when jobs are `queued`, `in_progress`, and `completed`. You must then create your own scaling automation in response to these webhook payloads. diff --git a/translations/ja-JP/content/code-security/code-scanning/index.md b/translations/ja-JP/content/code-security/code-scanning/index.md index 915ff6aff7..4aa0115ac4 100644 --- a/translations/ja-JP/content/code-security/code-scanning/index.md +++ b/translations/ja-JP/content/code-security/code-scanning/index.md @@ -1,5 +1,5 @@ --- -title: Finding security vulnerabilities and errors in your code with code scanning +title: Code scanningでのコード中のセキュリティ脆弱性とエラーの発見 shortTitle: Code scanning intro: '{% data variables.product.prodname_code_scanning %}を使ってコード中の潜在的なセキュリティ脆弱性やその他のエラーを特定して修正することによって、コードをセキュアに保ってください。' product: '{% data reusables.gated-features.code-scanning %}' diff --git a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/browsing-security-vulnerabilities-in-the-github-advisory-database.md b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/browsing-security-vulnerabilities-in-the-github-advisory-database.md index 9d9787663d..275deeeb95 100644 --- a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/browsing-security-vulnerabilities-in-the-github-advisory-database.md +++ b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/browsing-security-vulnerabilities-in-the-github-advisory-database.md @@ -27,23 +27,23 @@ topics: ## {% data variables.product.prodname_advisory_database %} について -The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities, grouped in two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories. +{% data variables.product.prodname_advisory_database %}には既知のセキュリティ脆弱性のリストが含まれており、これは{% data variables.product.company_short %}がレビューしたアドバイザリと、レビューされていないアドバイザリという2つの分類にグループ化されています。 {% data reusables.repositories.tracks-vulnerabilities %} -### About {% data variables.product.company_short %}-reviewed advisories +### {% data variables.product.company_short %}がレビューしたアドバイザリについて -{% data variables.product.company_short %}-reviewed advisories are security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. +{% data variables.product.company_short %}あレビューしたアドバイザリは、{% data variables.product.company_short %}の依存関係グラフが追跡したパッケージにマップされたセキュリティ脆弱性です。 -We carefully review each advisory for validity. Each {% data variables.product.company_short %}-reviewed advisory has a full description, and contains both ecosystem and package information. +各アドバイザリの妥当性は慎重にレビューされています。 {% data variables.product.company_short %}がレビューした各アドバイザリには完全な説明があり、エコシステムとパッケージ情報が含まれます。 -If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory affects packages you depend on. 詳しい情報については「[{% data variables.product.prodname_dependabot_alerts %}について](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」を参照してください。 +リポジトリで{% data variables.product.prodname_dependabot_alerts %}を有効化すると、新しい{% data variables.product.company_short %}がレビューしたアドバイザリが依存対象のパッケージに影響する場合、自動的に通知されます。 詳しい情報については「[{% data variables.product.prodname_dependabot_alerts %}について](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)」を参照してください。 -### About unreviewed advisories +### レビューされていないアドバイザリについて -Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. +レビューされていないアドバイザリは、自動的にNational Vulnerability Databaseフィードから直接{% data variables.product.prodname_advisory_database %}へ展開されたセキュリティ脆弱性です。 -{% data variables.product.prodname_dependabot %} doesn't create {% data variables.product.prodname_dependabot_alerts %} for unreviewed advisories as this type of advisory isn't checked for validity or completion. +この種のアドバイザリは妥当性あるいは完全性がチェックされていないので、レビューされていないアドバイザリに対して{% data variables.product.prodname_dependabot %}は{% data variables.product.prodname_dependabot_alerts %}を生成しません。 ## About security advisories diff --git a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index c7aa8fda69..27c059527d 100644 --- a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md @@ -60,7 +60,7 @@ When a new {% data variables.product.prodname_dependabot %} alert is detected, { ## 脆弱性のある依存関係の通知を減らす方法 -{% data variables.product.prodname_dependabot_alerts %}の通知をあまりに多く受け取ることが心配なら、週次のメールダイジェストにオプトインするか、{% data variables.product.prodname_dependabot_alerts %}を有効化したままで通知をオフにすることをおすすめします。 その場合でも、リポジトリのセキュリティタブで{% data variables.product.prodname_dependabot_alerts %}を確認することはできます。 For more information, see "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." +{% data variables.product.prodname_dependabot_alerts %}の通知をあまりに多く受け取ることが心配なら、週次のメールダイジェストにオプトインするか、{% data variables.product.prodname_dependabot_alerts %}を有効化したままで通知をオフにすることをおすすめします。 その場合でも、リポジトリのセキュリティタブで{% data variables.product.prodname_dependabot_alerts %}を確認することはできます。 詳しい情報については「[脆弱性のある依存関係に対する{% data variables.product.prodname_dependabot_alerts %}の表示](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)」を参照してください。 ## 参考リンク diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index a9acffd590..e37e23c8ce 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -83,7 +83,7 @@ webhook を保護するためにシークレットが必要なアプリケーシ | `plan` | 「[ユーザの取得](/rest/reference/users#get-a-user)」エンドポイントを使用してユーザの GitHub プランについての情報を取得するためのアクセス権を付与します。 `none`、`read` のいずれかです。 | | [`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | さまざまなプルリクエストエンドポイントへのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | | [`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | [Repository Webhooks API](/rest/reference/repos#hooks) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | -| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | [Projects API](/rest/reference/projects) へのアクセス権を付与します。 `none`、`read`、`write`、`admin` のいずれかです。{% ifversion fpt or ghes or ghec %} +| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | [Projects API](/rest/reference/projects) へのアクセス権を付与します。 `none`、`read`、`write`、`admin` のいずれかです。{% ifversion ghes or ghec %} | [`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | [Secret scanning API](/rest/reference/secret-scanning) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% endif %}{% ifversion fpt or ghes or ghec %} | [`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | [Code scanning API](/rest/reference/code-scanning/) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。{% endif %} | [`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | [Contents API](/rest/reference/repos#contents) へのアクセス権を付与します。 `none`、`read`、`write` のいずれかです。 | diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index cf9e1a0bbe..d8536a2b79 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -39,43 +39,43 @@ X-Accepted-OAuth-Scopes: user ## 利用できるスコープ -| 名前 | 説明 | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} +| 名前 | 説明 | +| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} | **`(スコープなし)`** | パブリックな情報への読み取りのみのアクセスを許可します (ユーザのプロフィール情報、リポジトリの情報、Gist){% endif %}{% ifversion ghes or ghae %} | **`site_admin`** | サイト管理者に[{% data variables.product.prodname_ghe_server %}の管理APIエンドポイント](/rest/reference/enterprise-admin)へのアクセスを許可します。{% endif %} -| **`repo`** | プライベートリポジトリを含め、リポジトリへの完全なアクセスを許可します。 これにはコード、コミットのステータス、リポジトリおよびOrganizationのプロジェクト、招待、コラボレータ、Teamのメンバーシップの追加、デプロイメントのステータス、リポジトリとOrganizationのためのリポジトリwebhookが含まれます。 また、ユーザプロジェクトを管理する機能も許可します。 | -|  `repo:status` | Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザあるいはサービスにプライベートリポジトリのコミットステータスへのアクセスを許可したい場合のみです。 | +| **`repo`** | プライベートリポジトリを含め、リポジトリへの完全なアクセスを許可します。 これにはコード、コミットのステータス、リポジトリおよびOrganizationのプロジェクト、招待、コラボレータ、Teamのメンバーシップの追加、デプロイメントのステータス、リポジトリとOrganizationのためのリポジトリwebhookが含まれます。 また、ユーザプロジェクトを管理する機能も許可します。 | +|  `repo:status` | Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザあるいはサービスにプライベートリポジトリのコミットステータスへのアクセスを許可したい場合のみです。 | |  `repo_deployment` | [デプロイメントステータス](/rest/reference/repos#deployments) for {% ifversion not ghae %}パブリック{% else %}内部{% endif %}およびプライベートリポジトリへのアクセスを許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*デプロイメントステータスへのアクセスをユーザまたはサービスに許可する場合のみです。{% ifversion not ghae %} |  `public_repo` | アクセスをパブリックリポジトリのみに制限します。 これには、コード、コミットステータス、リポジトリプロジェクト、コラボレータ、パブリックリポジトリ及びOrganizationのデプロイメントステータスへの読み書きアクセスが含まれます。 パブリックリポジトリにStarを付けるためにも必要です。{% endif %} |  `repo:invite` | リポジトリでのコラボレーションへの招待の承認／拒否を許可します。 このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザまたはサービスに招待へのアクセスを許可する場合のみです。{% ifversion fpt or ghes or ghec %} -|  `security_events` | 以下のアクセスを許可します。
    [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)中のセキュリティイベントへの読み取りおよび書き込みアクセス
    [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)中のセキュリティイベントへの読み取りおよび書き込みアクセス
    このスコープが必要になるのは、コードへのアクセスを許可*することなく*他のユーザまたはサービスにセキュリティイベントへのアクセスを許可したい場合のみです。{% endif %} -| **`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. `repo`{% ifversion fpt or ghec or ghes %}および`public_repo`スコープは、{% else %}{% endif %}リポジトリフックを含むリポジトリへの完全なアクセスを許可します。 アクセスをリポジトリフックのみに限定するには、`admin:repo_hook`スコープを使ってください。 | -|  `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. | -|  `read:repo_hook` | Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. | -| **`admin:org`** | OrganizationとそのTeam、プロジェクト、メンバーシップを完全に管理できます。 | -|  `write:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み書きアクセス。 | -|  `read:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み取りのみのアクセス。 | -| **`admin:public_key`** | 公開鍵を完全に管理できます。 | -|  `write:public_key` | 公開鍵の作成、リスト、詳細の表示。 | -|  `read:public_key` | 公開鍵のリストと詳細の表示。 | -| **`admin:org_hook`** | Organizationフックへの読み書き、ping、削除アクセスを許可します。 **ノート:** OAuthトークンがこれらのアクションを行えるのは、OAuth Appが作成したOrganizationフックに対してのみです。 個人アクセストークンがこれらのアクションを行えるのは、ユーザが作成したOrganizationフックに対してのみです。 | -| **`gist`** | Gistへの書き込みアクセスを許可します。 | -| **`notifications`** | 許可するアクセス:
    * ユーザの通知に対する読み取りアクセス
    * スレッドへの既読アクセス
    * リポジトリへのWatch及びWatch解除のアクセス
    * スレッドのサブスクリプションに対する読み書き及び削除アクセス。 | -| **`ユーザ`** | プロフィール情報にのみ読み書きアクセスを許可します。 このスコープには`user:email`と`user:follow`が含まれることに注意してください。 | -|  `read:user` | ユーザのプロフィールデータへの読み取りアクセスを許可します。 | -|  `user:email` | ユーザのメールアドレスへの読み取りアクセスを許可します。 | -|  `user:follow` | 他のユーザのフォローあるいはフォロー解除のアクセスを許可します。 | -| **`delete_repo`** | 管理可能なリポジトリの削除アクセスを許可します。 | -| **`write:discussion`** | Teamのディスカッションの読み書きアクセスを許可します。 | +|  `security_events` | Grants:
    read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) {%- ifversion ghec %}
    read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning){%- endif %}
    This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} +| **`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. `repo`{% ifversion fpt or ghec or ghes %}および`public_repo`スコープは、{% else %}{% endif %}リポジトリフックを含むリポジトリへの完全なアクセスを許可します。 アクセスをリポジトリフックのみに限定するには、`admin:repo_hook`スコープを使ってください。 | +|  `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. | +|  `read:repo_hook` | Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. | +| **`admin:org`** | OrganizationとそのTeam、プロジェクト、メンバーシップを完全に管理できます。 | +|  `write:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み書きアクセス。 | +|  `read:org` | Organizationのメンバーシップ、Organizationのプロジェクト、Teamのメンバーシップへの読み取りのみのアクセス。 | +| **`admin:public_key`** | 公開鍵を完全に管理できます。 | +|  `write:public_key` | 公開鍵の作成、リスト、詳細の表示。 | +|  `read:public_key` | 公開鍵のリストと詳細の表示。 | +| **`admin:org_hook`** | Organizationフックへの読み書き、ping、削除アクセスを許可します。 **ノート:** OAuthトークンがこれらのアクションを行えるのは、OAuth Appが作成したOrganizationフックに対してのみです。 個人アクセストークンがこれらのアクションを行えるのは、ユーザが作成したOrganizationフックに対してのみです。 | +| **`gist`** | Gistへの書き込みアクセスを許可します。 | +| **`notifications`** | 許可するアクセス:
    * ユーザの通知に対する読み取りアクセス
    * スレッドへの既読アクセス
    * リポジトリへのWatch及びWatch解除のアクセス
    * スレッドのサブスクリプションに対する読み書き及び削除アクセス。 | +| **`ユーザ`** | プロフィール情報にのみ読み書きアクセスを許可します。 このスコープには`user:email`と`user:follow`が含まれることに注意してください。 | +|  `read:user` | ユーザのプロフィールデータへの読み取りアクセスを許可します。 | +|  `user:email` | ユーザのメールアドレスへの読み取りアクセスを許可します。 | +|  `user:follow` | 他のユーザのフォローあるいはフォロー解除のアクセスを許可します。 | +| **`delete_repo`** | 管理可能なリポジトリの削除アクセスを許可します。 | +| **`write:discussion`** | Teamのディスカッションの読み書きアクセスを許可します。 | |  `read:discussion` | Team ディスカッションの読み取りアクセスを許可します。{% ifversion fpt or ghae or ghec %} -| **`write:packages`** | {% data variables.product.prodname_registry %}でのパッケージのアップロードあるいは公開のアクセスを許可します。 詳しい情報については「[パッケージの公開](/github/managing-packages-with-github-packages/publishing-a-package)」を参照してください。 | -| **`read:packages`** | {% data variables.product.prodname_registry %}からのパッケージのダウンロードあるいはインストールのアクセスを許可します。 詳しい情報については「[パッケージのインストール](/github/managing-packages-with-github-packages/installing-a-package)」を参照してください。 | -| **`delete:packages`** | {% data variables.product.prodname_registry %}からのパッケージの削除アクセスを許可します。 For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)."{% endif %} -| **`admin:gpg_key`** | GPGキーを完全に管理できます。 | -|  `write:gpg_key` | GPGキーの作成、リスト、詳細の表示ができます。 | +| **`write:packages`** | {% data variables.product.prodname_registry %}でのパッケージのアップロードあるいは公開のアクセスを許可します。 詳しい情報については「[パッケージの公開](/github/managing-packages-with-github-packages/publishing-a-package)」を参照してください。 | +| **`read:packages`** | {% data variables.product.prodname_registry %}からのパッケージのダウンロードあるいはインストールのアクセスを許可します。 詳しい情報については「[パッケージのインストール](/github/managing-packages-with-github-packages/installing-a-package)」を参照してください。 | +| **`delete:packages`** | {% data variables.product.prodname_registry %}からのパッケージの削除アクセスを許可します。 詳しい情報については、「[パッケージの削除とリストア](/packages/learn-github-packages/deleting-and-restoring-a-package)」を参照してください。{% endif %} +| **`admin:gpg_key`** | GPGキーを完全に管理できます。 | +|  `write:gpg_key` | GPGキーの作成、リスト、詳細の表示ができます。 | |  `read:gpg_key` | GPGキーのリストと詳細を表示できます。{% ifversion fpt or ghec %} | **`codespace`** | Grants the ability to create and manage codespaces. Codespaces can expose a GITHUB_TOKEN which may have a different set of scopes. For more information, see "[Security in Codespaces](/codespaces/codespaces-reference/security-in-codespaces#authentication)."{% endif %} -| **`ワークフロー`** | {% data variables.product.prodname_actions %}のワークフローファイルの追加と更新機能を許可します。 同じリポジトリ内の他のブランチに同じファイル（パスと内容が同じ）が存在する場合、ワークフローファイルはこのスコープがなくてもコミットできます。 ワークフローファイルは、異なるスコープのセットを持ちうる`GITHUB_TOKEN`を公開できます。 詳しい情報については、「[ワークフローでの認証](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)」を参照してください。 | +| **`ワークフロー`** | {% data variables.product.prodname_actions %}のワークフローファイルの追加と更新機能を許可します。 同じリポジトリ内の他のブランチに同じファイル（パスと内容が同じ）が存在する場合、ワークフローファイルはこのスコープがなくてもコミットできます。 ワークフローファイルは、異なるスコープのセットを持ちうる`GITHUB_TOKEN`を公開できます。 詳しい情報については、「[ワークフローでの認証](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)」を参照してください。 | {% note %} diff --git a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 2fbd8441b4..d3bd686ff0 100644 --- a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1216,7 +1216,7 @@ GitHub Marketplace の購入に関連するアクティビティ。 {% data reus {% endif %} -{% ifversion fpt or ghes or ghec %} +{% ifversion ghes or ghec %} ## secret_scanning_alert @@ -1241,7 +1241,7 @@ GitHub Marketplace の購入に関連するアクティビティ。 {% data reus {{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }} {% endif %} -{% ifversion fpt or ghes > 3.4 or ghec or ghae-issue-6581 %} +{% ifversion ghes > 3.4 or ghec or ghae-issue-6581 %} ## secret_scanning_alert_location {% data reusables.webhooks.secret_scanning_alert_location_event_short_desc %} diff --git a/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md b/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md index 4d8f4ee246..eb9b05ea29 100644 --- a/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md +++ b/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md @@ -1,7 +1,6 @@ --- title: Organizationのメール通知の制限 intro: Organizationの情報が個人のメールアカウントに漏れてしまうことを避けるために、メンバーがOrganizationのアクティビティに関するメール通知を受信できるドメインを制限できます。 -product: '{% data reusables.gated-features.restrict-email-domain %}' permissions: Organization owners can restrict email notifications for an organization. redirect_from: - /articles/restricting-email-notifications-about-organization-activity-to-an-approved-email-domain @@ -10,7 +9,6 @@ redirect_from: - /organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain - /organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization versions: - fpt: '*' ghes: '>=3.2' ghec: '*' type: how_to @@ -26,11 +24,7 @@ shortTitle: メール通知の制限 Organization で制限付きのメール通知が有効になっている場合、メンバーは Organization の検証済みあるいは承認済みドメインに関連付けられたメールアドレスのみを使用して、Organization のアクティビティに関するメール通知を受信できます。 詳しい情報については「[Organizationのドメインの検証もしくは承認](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)」を参照してください。 -{% data reusables.enterprise-accounts.approved-domains-beta-note %} - -{% data reusables.notifications.email-restrictions-verification %} - -{% ifversion fpt or ghec %} +{% ifversion ghec %} {% note %} **ノート:** メール通知を制限するには、Organizationは{% data variables.product.prodname_ghe_cloud %}を使っていなければなりません。 {% data reusables.enterprise.link-to-ghec-trial %} @@ -38,6 +32,8 @@ Organization で制限付きのメール通知が有効になっている場合 {% endnote %} {% endif %} +{% data reusables.notifications.email-restrictions-verification %} + 外部のコラボレーターは、検証済みあるいは承認済みドメインへのメール通知の制限の対象になりません。 外部コラボレータに関する詳しい情報については「[Organization内のロール](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)」を参照してください。 Enterprise アカウントがオーナーの Organization の場合、Organization のメンバーは、Organization の検証済みあるいは承認済みドメインに加えて、Enterprise アカウントの検証済みあるいは承認済みドメインから通知を受け取ることができます。 詳しい情報については「[Enterpriseのためのドメインの検証あるいは承認](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。 diff --git a/translations/ja-JP/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md b/translations/ja-JP/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md index bff5242e4c..5e4597b10c 100644 --- a/translations/ja-JP/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md +++ b/translations/ja-JP/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md @@ -1,7 +1,6 @@ --- title: Organizationのためのドメインの検証あるいは承認 intro: 'Organizationのアイデンティティを確認するために、{% data variables.product.company_short %}でドメインの所有権を検証できます。 Organization　のメンバーに{% data variables.product.company_short %}がメール通知を送信できるドメインを承認することもできます。' -product: '{% data reusables.gated-features.verify-and-approve-domain %}' redirect_from: - /articles/verifying-your-organization-s-domain - /articles/verifying-your-organizations-domain @@ -9,7 +8,6 @@ redirect_from: - /organizations/managing-organization-settings/verifying-your-organizations-domain permissions: Organization owners can verify or approve a domain for an organization. versions: - fpt: '*' ghes: '>=3.2' ghec: '*' type: how_to @@ -23,15 +21,25 @@ shortTitle: ドメインの検証もしくは承認 ## ドメイン検証について -Organization のドメインの所有権を検証したあと、「検証済み」バッジが Organization のプロフィールに表示されます。 {% ifversion fpt or ghec %}Organization が {% data variables.product.prodname_ghe_cloud %} 上にあり、企業向け利用規約に同意した場合、Organization のオーナーは、検証済みドメインにある各メンバーのメールアドレスを見て、Organization メンバーの身元を検証できるようになります。 詳しい情報については「[Organizationのプロフィールページについて](/articles/about-your-organization-s-profile/)」および「企業利用規約にアップグレードする」を参照してください。{% endif %} +Organization のドメインの所有権を検証したあと、「検証済み」バッジが Organization のプロフィールに表示されます。 {% ifversion ghec %}If your organization has agreed to the Corporate Terms of Service, organization owners will be able to verify the identity of organization members by viewing each member's email address within the verified domain. 詳しい情報については「[Organizationのプロフィールページについて](/articles/about-your-organization-s-profile/)」および「企業利用規約にアップグレードする」を参照してください。{% endif %} -{% ifversion fpt or ghec %}Enterprise アカウントがオーナーの Organization の場合、{% elsif ghes %}{% endif %}Organization による検証済みのドメインに加えて、Enterprise アカウントで検証されたドメインの「検証済み」バッジが Organization のプロフィールに表示されます。 Organizationのオーナーは、Enterpriseのオーナーが検証もしくは承認したドメインをすべて見ることができ、OrganizationオーナーがEnterpriseオーナーでもある場合は、それらのドメインを編集できます。 {% ifversion fpt or ghec %}詳しい情報については「[Enterpriseのドメインの検証もしくは承認](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。{% endif %}{% ifversion ghes > 3.1 %}詳しい情報については「[Enterpriseのドメインの検証もしくは承認](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。{% endif %} +{% ifversion ghec %}Enterprise アカウントがオーナーの Organization の場合、{% elsif ghes %}{% endif %}Organization による検証済みのドメインに加えて、Enterprise アカウントで検証されたドメインの「検証済み」バッジが Organization のプロフィールに表示されます。 Organizationのオーナーは、Enterpriseのオーナーが検証もしくは承認したドメインをすべて見ることができ、OrganizationオーナーがEnterpriseオーナーでもある場合は、それらのドメインを編集できます。 詳しい情報については「[Enterpriseのためのドメインの検証あるいは承認](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。 + +{% ifversion ghec %} +{% note %} + +**Note:** To verify or approve domains, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} + +{% endnote %} +{% endif %} {% data reusables.organizations.verified-domains-details %} -{% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_cloud %} では、Organization のドメインの所有権を検証したあと、その Organization へのメール通知を制限することができます。 詳しい情報については「[Organizationのメール通知の制限](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)」を参照してください。 {% ifversion fpt %}{% data reusables.enterprise.link-to-ghec-trial %}{% endif %}{% endif %} +{% ifversion ghec or ghes > 3.1 %} +After verifying ownership of your organization's domain, you can restrict email notifications for the organization to that domain. 詳しい情報については「[Organizationのメール通知の制限](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)」を参照してください。 +{% endif %} -{% ifversion fpt or ghec %}{% data variables.product.prodname_pages %}で使われているカスタムドメインを検証して、カスタムドメインが設定されたままになっていながら{% data variables.product.prodname_pages %}のサイドが無効化された、あるいはそのドメインを使用していない状態になっている場合のドメイン乗っ取りを回避することもできます。 詳しい情報については「[{% data variables.product.prodname_pages %}のカスタムドメインの検証](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)」を参照してください。{% endif %} +{% ifversion ghec %}{% data variables.product.prodname_pages %}で使われているカスタムドメインを検証して、カスタムドメインが設定されたままになっていながら{% data variables.product.prodname_pages %}のサイドが無効化された、あるいはそのドメインを使用していない状態になっている場合のドメイン乗っ取りを回避することもできます。 詳しい情報については「[{% data variables.product.prodname_pages %}のカスタムドメインの検証](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)」を参照してください。{% endif %} ## ドメインの承認について @@ -43,7 +51,7 @@ Organizationのためのドメインを承認したあと、Organization内の Enterpriseオーナーは、承認済みドメイン内の通知をどのOrganizationメンバーあるいはメールアドレスが受け取るのかを、見ることはできません。 -Enterpriseオーナーは、Enterpriseが所有するOrganizationのための追加ドメインを承認することもできます。 {% ifversion fpt or ghec %}詳しい情報については「[Enterpriseのドメインの検証もしくは承認](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。{% endif %}{% ifversion ghes > 3.1 %}詳しい情報については「[Enterpriseのドメインの検証もしくは承認](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。{% endif %} +Enterpriseオーナーは、Enterpriseが所有するOrganizationのための追加ドメインを承認することもできます。 {% ifversion ghec %}詳しい情報については「[Enterpriseのドメインの検証もしくは承認](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。{% endif %}{% ifversion ghes > 3.1 %}詳しい情報については「[Enterpriseのドメインの検証もしくは承認](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)」を参照してください。{% endif %} ## Organizationのためのドメインの検証 @@ -65,12 +73,8 @@ Enterpriseオーナーは、Enterpriseが所有するOrganizationのための追 ## Organizationのためのドメインの承認 -{% ifversion fpt or ghes > 3.1 or ghec %} - {% data reusables.enterprise-accounts.approved-domains-beta-note %} -{% endif %} - {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.verified-domains %} diff --git a/translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md b/translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md index 21d4ae612b..0eb4c2031a 100644 --- a/translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md +++ b/translations/ja-JP/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md @@ -92,9 +92,10 @@ Organizationでの{% data variables.product.prodname_github_app %}マネージ | スケジュールされたリマインダーを設定する (「[プルリクエストのスケジュールされたリマインダーを管理する](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests)」を参照) | **X** | | | | | | **すべてのリポジトリに**コラボレーターを追加する | **X** | | | | | | Organization 参加ログにアクセスする | **X** | | | | | -| Organizationのプロフィールページの編集（「[Organizationのプロフィールについて](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile)」参照） | **X** | | | | | +| Organizationのプロフィールページの編集（「[Organizationのプロフィールについて](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile)」参照） | **X** | | | | |{% ifversion ghec %} | Organizationのドメインの検証（「[Organizationのドメインの検証](/articles/verifying-your-organization-s-domain)」参照） | **X** | | | | | -| 検証済みあるいは承認済みドメインへのメール通知の制限（「[Organizationのメール通知の制限](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)」参照） | **X** | | | | | +| 検証済みあるいは承認済みドメインへのメール通知の制限（「[Organizationのメール通知の制限](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)」参照） | **X** | | | | +{% endif %} | **すべての Team** を削除する | **X** | | | | | | すべてのリポジトリを含めて Organization のアカウントを削除する | **X** | | | | | | Teamの作成（「[OrganizationでのTeam作成権限の設定](/articles/setting-team-creation-permissions-in-your-organization)」参照） | **X** | **X** | **X** | | **X** | diff --git a/translations/ja-JP/content/rest/actions/artifacts.md b/translations/ja-JP/content/rest/actions/artifacts.md new file mode 100644 index 0000000000..50728ce183 --- /dev/null +++ b/translations/ja-JP/content/rest/actions/artifacts.md @@ -0,0 +1,15 @@ +--- +title: Artifacts +intro: 'The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/actions/cache.md b/translations/ja-JP/content/rest/actions/cache.md new file mode 100644 index 0000000000..227622ec99 --- /dev/null +++ b/translations/ja-JP/content/rest/actions/cache.md @@ -0,0 +1,11 @@ +--- +title: Cache +intro: 'The Cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories.' +topics: + - API +versions: + fpt: '*' + ghec: '*' +--- + +The cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories. For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)." diff --git a/translations/ja-JP/content/rest/actions/index.md b/translations/ja-JP/content/rest/actions/index.md new file mode 100644 index 0000000000..1eef306da9 --- /dev/null +++ b/translations/ja-JP/content/rest/actions/index.md @@ -0,0 +1,26 @@ +--- +title: Actions +intro: 'With the Actions API, you can manage and control {% data variables.product.prodname_actions %} for an organization or repository.' +redirect_from: + - /v3/actions + - /rest/reference/actions +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /artifacts + - /cache + - /permissions + - /secrets + - /self-hosted-runner-groups + - /self-hosted-runners + - /workflow-jobs + - /workflow-runs + - /workflows +--- +The {% data variables.product.prodname_actions %} API enables you to manage {% data variables.product.prodname_actions %} using the REST API. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/actions/permissions.md b/translations/ja-JP/content/rest/actions/permissions.md new file mode 100644 index 0000000000..250824f7dd --- /dev/null +++ b/translations/ja-JP/content/rest/actions/permissions.md @@ -0,0 +1,15 @@ +--- +title: Permissions +intro: 'The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Permissions + +The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/actions/secrets.md b/translations/ja-JP/content/rest/actions/secrets.md new file mode 100644 index 0000000000..bb9cdca350 --- /dev/null +++ b/translations/ja-JP/content/rest/actions/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. ' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/actions/self-hosted-runner-groups.md b/translations/ja-JP/content/rest/actions/self-hosted-runner-groups.md new file mode 100644 index 0000000000..77b15aa36f --- /dev/null +++ b/translations/ja-JP/content/rest/actions/self-hosted-runner-groups.md @@ -0,0 +1,17 @@ +--- +title: Self-hosted runner groups +intro: 'The Self-hosted Runners Groups API allows you manage groups of self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Self-hosted runner groups + +The Self-hosted Runners Groups API allows you manage groups of self-hosted runners. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/actions/self-hosted-runners.md b/translations/ja-JP/content/rest/actions/self-hosted-runners.md new file mode 100644 index 0000000000..61c8aa3d5a --- /dev/null +++ b/translations/ja-JP/content/rest/actions/self-hosted-runners.md @@ -0,0 +1,17 @@ +--- +title: Self-hosted runners +intro: 'The Self-hosted Runners API allows you to register, view, and delete self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Self-hosted runners + +The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/actions/workflow-jobs.md b/translations/ja-JP/content/rest/actions/workflow-jobs.md new file mode 100644 index 0000000000..469ea0382f --- /dev/null +++ b/translations/ja-JP/content/rest/actions/workflow-jobs.md @@ -0,0 +1,15 @@ +--- +title: Workflow jobs +intro: 'The Workflow Jobs API allows you to view logs and workflow jobs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/actions/workflow-runs.md b/translations/ja-JP/content/rest/actions/workflow-runs.md new file mode 100644 index 0000000000..3fca12a420 --- /dev/null +++ b/translations/ja-JP/content/rest/actions/workflow-runs.md @@ -0,0 +1,15 @@ +--- +title: Workflow runs +intro: 'The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/actions/workflows.md b/translations/ja-JP/content/rest/actions/workflows.md new file mode 100644 index 0000000000..55dad18cea --- /dev/null +++ b/translations/ja-JP/content/rest/actions/workflows.md @@ -0,0 +1,15 @@ +--- +title: Workflows +intro: 'The Workflows API allows you to view workflows for a repository.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/activity/events.md b/translations/ja-JP/content/rest/activity/events.md new file mode 100644 index 0000000000..9b3f58527b --- /dev/null +++ b/translations/ja-JP/content/rest/activity/events.md @@ -0,0 +1,33 @@ +--- +title: Events +intro: 'The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These events power the various activity streams on the site. + +The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{% data variables.product.prodname_dotcom %} Event types](/developers/webhooks-and-events/github-event-types)." An events API for repository issues is also available. For more information, see the "[Issue Events API](/rest/reference/issues#events)." + +Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events +> HTTP/2 200 +> X-Poll-Interval: 60 +> ETag: "a18c3bded88eb5dbb5c849a489412bf3" + +# The quotes around the ETag value are important +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events \ +$ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). \ No newline at end of file diff --git a/translations/ja-JP/content/rest/activity/feeds.md b/translations/ja-JP/content/rest/activity/feeds.md new file mode 100644 index 0000000000..e11e4cf1f4 --- /dev/null +++ b/translations/ja-JP/content/rest/activity/feeds.md @@ -0,0 +1,63 @@ +--- +title: Feeds +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Example of getting an Atom feed + +To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories: + + curl -H "Accept: application/atom+xml" https://github.com/security-advisories + +#### Response + +```shell +HTTP/2 200 +``` + +```xml + + + tag:github.com,2008:/security-advisories + + GitHub Security Advisory Feed + + GitHub + + 2019-01-14T19:34:52Z + + tag:github.com,2008:GHSA-abcd-12ab-23cd + 2018-07-26T15:14:52Z + 2019-01-14T19:34:52Z + [GHSA-abcd-12ab-23cd] Moderate severity vulnerability that affects Octoapp + + + <p>Octoapp node module before 4.17.5 suffers from a Modification of Assumed-Immutable Data (MAID) vulnerability via defaultsDeep, merge, and mergeWith functions, which allows a malicious user to modify the prototype of "Object" via <strong>proto</strong>, causing the addition or modification of an existing property that will exist on all objects.</p> + <p><strong>Affected Packages</strong></p> + + <dl> + <dt>Octoapp</dt> + <dd>Ecosystem: npm</dd> + <dd>Severity: moderate</dd> + <dd>Versions: &lt; 4.17.5</dd> + <dd>Fixed in: 4.17.5</dd> + </dl> + + <p><strong>References</strong></p> + + <ul> + <li>https://nvd.nist.gov/vuln/detail/CVE-2018-123</li> + </ul> + + + + +``` \ No newline at end of file diff --git a/translations/ja-JP/content/rest/activity/index.md b/translations/ja-JP/content/rest/activity/index.md new file mode 100644 index 0000000000..3f18631406 --- /dev/null +++ b/translations/ja-JP/content/rest/activity/index.md @@ -0,0 +1,21 @@ +--- +title: Activity +intro: 'The Activity API allows you to list events and feeds and manage notifications, starring, and watching for the authenticated user.' +redirect_from: + - /v3/activity + - /rest/reference/activity +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /events + - /feeds + - /notifications + - /starring + - /watching +--- diff --git a/translations/ja-JP/content/rest/activity/notifications.md b/translations/ja-JP/content/rest/activity/notifications.md new file mode 100644 index 0000000000..49678f8f9c --- /dev/null +++ b/translations/ja-JP/content/rest/activity/notifications.md @@ -0,0 +1,70 @@ +--- +title: Notifications +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Users receive notifications for conversations in repositories they watch including: + +* Issues and their comments +* Pull Requests and their comments +* Comments on any commits + +Notifications are also sent for conversations in unwatched repositories when the user is involved including: + +* **@mentions** +* Issue assignments +* Commits the user authors or commits +* Any discussion in which the user actively participates + +All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints. + +Notifications come back as "threads". A thread contains information about the current discussion of an issue, pull request, or commit. + +Notifications are optimized for polling with the `Last-Modified` header. If there are no new notifications, you will see a `304 Not Modified` response, leaving your current rate limit untouched. There is an `X-Poll-Interval` header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +# Add authentication to your requests +$ curl -I {% data variables.product.api_url_pre %}/notifications +HTTP/2 200 +Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT +X-Poll-Interval: 60 + +# Pass the Last-Modified header exactly +$ curl -I {% data variables.product.api_url_pre %}/notifications +$ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +### Notification reasons + +When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification. + +Here's a list of potential `reason`s for receiving a notification: + +Reason Name | Description +------------|------------ +`assign` | You were assigned to the issue. +`author` | You created the thread. +`comment` | You commented on the thread. +`ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. +`invitation` | You accepted an invitation to contribute to the repository. +`manual` | You subscribed to the thread (via an issue or pull request). +`mention` | You were specifically **@mentioned** in the content. +`review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} +`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in your repository.{% endif %} +`state_change` | You changed the thread state (for example, closing an issue or merging a pull request). +`subscribed` | You're watching the repository. +`team_mention` | You were on a team that was mentioned. + +Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different. + +For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then **@mentioned** on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/activity/starring.md b/translations/ja-JP/content/rest/activity/starring.md new file mode 100644 index 0000000000..9c45ddad6f --- /dev/null +++ b/translations/ja-JP/content/rest/activity/starring.md @@ -0,0 +1,30 @@ +--- +title: Starring +intro: 'Repository starring is a feature that lets users bookmark repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. + +### Starring vs. Watching + +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Many API +client applications may be using the original "watcher" endpoints for accessing +this data. You can now start using the "star" endpoints instead (described +below). For more information, see the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) and the "[Repository Watching API](/rest/reference/activity#watching)." + +### Custom media types for starring + +There is one supported custom media type for the Starring REST API. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`. + + application/vnd.github.v3.star+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/activity/watching.md b/translations/ja-JP/content/rest/activity/watching.md new file mode 100644 index 0000000000..10f078782e --- /dev/null +++ b/translations/ja-JP/content/rest/activity/watching.md @@ -0,0 +1,14 @@ +--- +title: Watching +intro: "Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/apps/apps.md b/translations/ja-JP/content/rest/apps/apps.md new file mode 100644 index 0000000000..7f7fa4b74f --- /dev/null +++ b/translations/ja-JP/content/rest/apps/apps.md @@ -0,0 +1,22 @@ +--- +title: Apps +intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.apps.general-apps-restrictions %} + +This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more. + +When authenticated as a GitHub App, the GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of an app. + +You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user. + +A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints. diff --git a/translations/ja-JP/content/rest/apps/index.md b/translations/ja-JP/content/rest/apps/index.md new file mode 100644 index 0000000000..5bbc724e11 --- /dev/null +++ b/translations/ja-JP/content/rest/apps/index.md @@ -0,0 +1,21 @@ +--- +title: Apps +intro: The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps. +redirect_from: + - /v3/apps + - /rest/reference/apps +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /apps + - /installations + - /marketplace + - /oauth-applications + - /webhooks +--- diff --git a/translations/ja-JP/content/rest/apps/installations.md b/translations/ja-JP/content/rest/apps/installations.md new file mode 100644 index 0000000000..8e858caed4 --- /dev/null +++ b/translations/ja-JP/content/rest/apps/installations.md @@ -0,0 +1,16 @@ +--- +title: Installations +intro: 'The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." + +To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." diff --git a/translations/ja-JP/content/rest/apps/marketplace.md b/translations/ja-JP/content/rest/apps/marketplace.md new file mode 100644 index 0000000000..d49e3bed46 --- /dev/null +++ b/translations/ja-JP/content/rest/apps/marketplace.md @@ -0,0 +1,22 @@ +--- +title: Marketplace +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' +--- + +For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)." + +The {% data variables.product.prodname_marketplace %} API allows you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription. + +### Testing with stubbed endpoints + +This API includes endpoints that allow you to [test your {% data variables.product.prodname_github_app %}](/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/) with **stubbed data**. Stubbed data is hard-coded, fake data that will not change based on actual subscriptions. + +To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether API logic succeeds before listing {% data variables.product.prodname_github_apps %} on {% data variables.product.prodname_marketplace %}. + +Be sure to replace stubbed endpoints with production endpoints before deploying your {% data variables.product.prodname_github_app %}. diff --git a/translations/ja-JP/content/rest/apps/oauth-applications.md b/translations/ja-JP/content/rest/apps/oauth-applications.md new file mode 100644 index 0000000000..037850e51c --- /dev/null +++ b/translations/ja-JP/content/rest/apps/oauth-applications.md @@ -0,0 +1,14 @@ +--- +title: OAuth Applications +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. diff --git a/translations/ja-JP/content/rest/apps/webhooks.md b/translations/ja-JP/content/rest/apps/webhooks.md new file mode 100644 index 0000000000..c3cf61466f --- /dev/null +++ b/translations/ja-JP/content/rest/apps/webhooks.md @@ -0,0 +1,14 @@ +--- +title: Webhooks +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %} diff --git a/translations/ja-JP/content/rest/billing.md b/translations/ja-JP/content/rest/billing.md new file mode 100644 index 0000000000..6f9ccd86a6 --- /dev/null +++ b/translations/ja-JP/content/rest/billing.md @@ -0,0 +1,15 @@ +--- +title: Billing +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.4' +redirect_from: + - /rest/reference/billing +--- + +You can get billing information for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#billing)" REST API. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/branches/branch-protection.md b/translations/ja-JP/content/rest/branches/branch-protection.md new file mode 100644 index 0000000000..e831cd0fea --- /dev/null +++ b/translations/ja-JP/content/rest/branches/branch-protection.md @@ -0,0 +1,13 @@ +--- +title: Protected branches +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/branches/branches.md b/translations/ja-JP/content/rest/branches/branches.md new file mode 100644 index 0000000000..99f1050d0a --- /dev/null +++ b/translations/ja-JP/content/rest/branches/branches.md @@ -0,0 +1,12 @@ +--- +title: Branches +intro: 'The Branches API allows you to modify branches and their protection settings.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/ja-JP/content/rest/branches/index.md b/translations/ja-JP/content/rest/branches/index.md new file mode 100644 index 0000000000..6b13175895 --- /dev/null +++ b/translations/ja-JP/content/rest/branches/index.md @@ -0,0 +1,18 @@ +--- +title: Branches +intro: The branches API allows you to modify branches and their protection settings. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /branches + - /branch-protection +redirect_from: + - /rest/reference/branches +--- diff --git a/translations/ja-JP/content/rest/checks/index.md b/translations/ja-JP/content/rest/checks/index.md new file mode 100644 index 0000000000..6b0e064cb8 --- /dev/null +++ b/translations/ja-JP/content/rest/checks/index.md @@ -0,0 +1,20 @@ +--- +title: Checks +intro: 'With the Checks API, you can build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' +redirect_from: + - /v3/checks + - /rest/reference/checks +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /runs + - /suites +--- + +You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/checks/runs.md b/translations/ja-JP/content/rest/checks/runs.md new file mode 100644 index 0000000000..c49d26fd02 --- /dev/null +++ b/translations/ja-JP/content/rest/checks/runs.md @@ -0,0 +1,13 @@ +--- +title: Check Runs +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/checks/suites.md b/translations/ja-JP/content/rest/checks/suites.md new file mode 100644 index 0000000000..9aec42aad3 --- /dev/null +++ b/translations/ja-JP/content/rest/checks/suites.md @@ -0,0 +1,19 @@ +--- +title: Check Suites +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% note %} + + **Note:** A GitHub App only receives one [`check_suite`](/webhooks/event-payloads/#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks/event-payloads/#create) events. + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/code-scanning.md b/translations/ja-JP/content/rest/code-scanning.md new file mode 100644 index 0000000000..8c464645a9 --- /dev/null +++ b/translations/ja-JP/content/rest/code-scanning.md @@ -0,0 +1,32 @@ +--- +title: Code Scanning +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API + - Code scanning + - REST +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/code-scanning +--- + +{% data reusables.code-scanning.beta %} + +The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[Finding security vulnerabilities and errors in your code](/github/finding-security-vulnerabilities-and-errors-in-your-code)." + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +### Custom media type for {% data variables.product.prodname_code_scanning %} + +There is one supported custom media type for the {% data variables.product.prodname_code_scanning %} REST API. + + application/sarif+json + +You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. For more information about this operation, see "[Get a {% data variables.product.prodname_code_scanning %} analysis for a repository](#get-a-code-scanning-analysis-for-a-repository)." When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than the summary of the analysis that's returned when you use the default media type. The response also includes additional data such as the `github/alertNumber` and `github/alertUrl` properties. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + +For more information, see "[Media types](/rest/overview/media-types)." +{% endif %} diff --git a/translations/ja-JP/content/rest/codes-of-conduct.md b/translations/ja-JP/content/rest/codes-of-conduct.md new file mode 100644 index 0000000000..dd96f59734 --- /dev/null +++ b/translations/ja-JP/content/rest/codes-of-conduct.md @@ -0,0 +1,16 @@ +--- +title: Codes of Conduct +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/codes-of-conduct +--- + +You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a repository's code of conduct, use the "[Get a repository](/rest/reference/repos#get-a-repository)" endpoint. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/codespaces/codespaces.md b/translations/ja-JP/content/rest/codespaces/codespaces.md new file mode 100644 index 0000000000..11d920b1c2 --- /dev/null +++ b/translations/ja-JP/content/rest/codespaces/codespaces.md @@ -0,0 +1,14 @@ +--- +title: Codespaces +intro: 'The Codespaces API enables you to manage your codespaces using the REST API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% data reusables.codespaces.codespaces-api-beta-note %} + +The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)." diff --git a/translations/ja-JP/content/rest/codespaces/index.md b/translations/ja-JP/content/rest/codespaces/index.md new file mode 100644 index 0000000000..d97a0755c0 --- /dev/null +++ b/translations/ja-JP/content/rest/codespaces/index.md @@ -0,0 +1,18 @@ +--- +title: Codespaces +intro: 'The {% data variables.product.prodname_codespaces %} API enables you to manage your codespaces using the REST API.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /codespaces + - /machines + - /repository-secrets + - /secrets +redirect_from: + - /rest/reference/codespaces +--- diff --git a/translations/ja-JP/content/rest/codespaces/machines.md b/translations/ja-JP/content/rest/codespaces/machines.md new file mode 100644 index 0000000000..b39416253f --- /dev/null +++ b/translations/ja-JP/content/rest/codespaces/machines.md @@ -0,0 +1,14 @@ +--- +title: Machines +intro: 'The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)." + +You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/codespaces/repository-secrets.md b/translations/ja-JP/content/rest/codespaces/repository-secrets.md new file mode 100644 index 0000000000..ccab41f36e --- /dev/null +++ b/translations/ja-JP/content/rest/codespaces/repository-secrets.md @@ -0,0 +1,15 @@ +--- +title: Repository Secrets +intro: 'The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.5' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +## Repository Secrets + +The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/codespaces/secrets.md b/translations/ja-JP/content/rest/codespaces/secrets.md new file mode 100644 index 0000000000..fb315dc8ce --- /dev/null +++ b/translations/ja-JP/content/rest/codespaces/secrets.md @@ -0,0 +1,15 @@ +--- +title: User Secrets +intro: 'The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +## User Secrets + +The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/collaborators/collaborators.md b/translations/ja-JP/content/rest/collaborators/collaborators.md new file mode 100644 index 0000000000..e2c617d39f --- /dev/null +++ b/translations/ja-JP/content/rest/collaborators/collaborators.md @@ -0,0 +1,12 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/collaborators/index.md b/translations/ja-JP/content/rest/collaborators/index.md new file mode 100644 index 0000000000..925f1ff4e9 --- /dev/null +++ b/translations/ja-JP/content/rest/collaborators/index.md @@ -0,0 +1,18 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /collaborators + - /invitations +redirect_from: + - /rest/reference/collaborators +--- diff --git a/translations/ja-JP/content/rest/collaborators/invitations.md b/translations/ja-JP/content/rest/collaborators/invitations.md new file mode 100644 index 0000000000..502e22608a --- /dev/null +++ b/translations/ja-JP/content/rest/collaborators/invitations.md @@ -0,0 +1,22 @@ +--- +title: Invitations +intro: 'The Repository Invitations API allows users or external services to invite other users to collaborate on a repo.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. + +Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted +access to invitations **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as invitations. + +### Invite a user to a repository + +Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/collaborators/collaborators#add-a-repository-collaborator)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/commits/comments.md b/translations/ja-JP/content/rest/commits/comments.md new file mode 100644 index 0000000000..34ff1e9f90 --- /dev/null +++ b/translations/ja-JP/content/rest/commits/comments.md @@ -0,0 +1,25 @@ +--- +title: Commit comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Custom media types for commit comments + +These are the supported media types for commit comments. You can read more +about the use of media types in the API [here](/rest/overview/media-types). + + application/vnd.github-commitcomment.raw+json + application/vnd.github-commitcomment.text+json + application/vnd.github-commitcomment.html+json + application/vnd.github-commitcomment.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/commits/commits.md b/translations/ja-JP/content/rest/commits/commits.md new file mode 100644 index 0000000000..8b0fa3f792 --- /dev/null +++ b/translations/ja-JP/content/rest/commits/commits.md @@ -0,0 +1,12 @@ +--- +title: Commits +intro: 'The Commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/ja-JP/content/rest/commits/index.md b/translations/ja-JP/content/rest/commits/index.md new file mode 100644 index 0000000000..425b0999cf --- /dev/null +++ b/translations/ja-JP/content/rest/commits/index.md @@ -0,0 +1,19 @@ +--- +title: Commits +intro: 'The commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /commits + - /comments + - /statuses +redirect_from: + - /rest/reference/commits +--- diff --git a/translations/ja-JP/content/rest/commits/statuses.md b/translations/ja-JP/content/rest/commits/statuses.md new file mode 100644 index 0000000000..27050e2439 --- /dev/null +++ b/translations/ja-JP/content/rest/commits/statuses.md @@ -0,0 +1,23 @@ +--- +title: Commit statuses +intro: 'The status API allows external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Statuses can also include an optional `description` and `target_url`, and we highly recommend providing them as they make statuses much more useful in the GitHub UI. + +As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The `target_url` would be the full URL to the build output, and the `description` would be the high level summary of what happened with the build. + +Statuses can include a `context` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. + +Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the `repo` scope grants permission to code as well as statuses. + +If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks). \ No newline at end of file diff --git a/translations/ja-JP/content/rest/dependabot/index.md b/translations/ja-JP/content/rest/dependabot/index.md new file mode 100644 index 0000000000..9de244ec7d --- /dev/null +++ b/translations/ja-JP/content/rest/dependabot/index.md @@ -0,0 +1,16 @@ +--- +title: Dependabot +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /secrets +redirect_from: + - /rest/reference/dependabot +--- diff --git a/translations/ja-JP/content/rest/dependabot/secrets.md b/translations/ja-JP/content/rest/dependabot/secrets.md new file mode 100644 index 0000000000..f57bff7358 --- /dev/null +++ b/translations/ja-JP/content/rest/dependabot/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +topics: + - API +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +allowTitleToDifferFromFilename: true +--- + +The {% data variables.product.prodname_dependabot %} Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/dependency-graph/dependency-review.md b/translations/ja-JP/content/rest/dependency-graph/dependency-review.md new file mode 100644 index 0000000000..b08e657b46 --- /dev/null +++ b/translations/ja-JP/content/rest/dependency-graph/dependency-review.md @@ -0,0 +1,19 @@ +--- +title: Dependency Review +intro: 'The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment.' +versions: + fpt: '*' + ghes: '>=3.6' + ghec: '*' + ghae: 'issue-6396' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +## Dependency review + +{% data reusables.dependency-review.dependency-review-api-beta-note %} + +The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." \ No newline at end of file diff --git a/translations/es-ES/content/rest/reference/dependency-graph.md b/translations/ja-JP/content/rest/dependency-graph/index.md similarity index 53% rename from translations/es-ES/content/rest/reference/dependency-graph.md rename to translations/ja-JP/content/rest/dependency-graph/index.md index a02181deed..393c5eaa5c 100644 --- a/translations/es-ES/content/rest/reference/dependency-graph.md +++ b/translations/ja-JP/content/rest/dependency-graph/index.md @@ -1,16 +1,16 @@ --- -title: Gráfica de dependencias +title: Dependency Graph intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.' versions: fpt: '*' ghes: '>=3.6' ghec: '*' - ghae: issue-6396 + ghae: 'issue-6396' topics: - API miniTocMaxHeadingLevel: 3 +children: + - /dependency-review +redirect_from: + - /rest/reference/dependency-graph --- - - diff --git a/translations/ja-JP/content/rest/deploy-keys.md b/translations/ja-JP/content/rest/deploy-keys.md new file mode 100644 index 0000000000..0158b1194b --- /dev/null +++ b/translations/ja-JP/content/rest/deploy-keys.md @@ -0,0 +1,19 @@ +--- +title: Deploy Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/deploy_keys +--- + +{% data reusables.repositories.deploy-keys %} + +Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/deployments/deployments.md b/translations/ja-JP/content/rest/deployments/deployments.md new file mode 100644 index 0000000000..84f4f9eea3 --- /dev/null +++ b/translations/ja-JP/content/rest/deployments/deployments.md @@ -0,0 +1,60 @@ +--- +title: Deployments +intro: 'The Deployments API allows you to create and delete deployments and deployment environments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). + +Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume. + +Deployment statuses can also include an optional `description` and `log_url`, which are highly recommended because they make deployment statuses more useful. The `log_url` is the full URL to the deployment output, and +the `description` is a high-level summary of what happened with the deployment. + +GitHub dispatches `deployment` and `deployment_status` events when new deployments and deployment statuses are created. These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made. + +Below is a simple sequence diagram for how these interactions would work. + +``` ++---------+ +--------+ +-----------+ +-------------+ +| Tooling | | GitHub | | 3rd Party | | Your Server | ++---------+ +--------+ +-----------+ +-------------+ + | | | | + | Create Deployment | | | + |--------------------->| | | + | | | | + | Deployment Created | | | + |<---------------------| | | + | | | | + | | Deployment Event | | + | |---------------------->| | + | | | SSH+Deploys | + | | |-------------------->| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | + | | | Deploy Completed | + | | |<--------------------| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | +``` + +Keep in mind that GitHub is never actually accessing your servers. It's up to your third-party integration to interact with deployment events. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether they're responsible for pushing the code out to your servers, building native code, etc. + +Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the {% ifversion not ghae %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well. + +### Inactive deployments + +When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status. + +You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. diff --git a/translations/ja-JP/content/rest/deployments/environments.md b/translations/ja-JP/content/rest/deployments/environments.md new file mode 100644 index 0000000000..1d90c1aa6b --- /dev/null +++ b/translations/ja-JP/content/rest/deployments/environments.md @@ -0,0 +1,16 @@ +--- +title: Environments +intro: 'The Environments API allows you to create, configure, and delete environments.' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." + +{% data reusables.gated-features.environments %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/deployments/index.md b/translations/ja-JP/content/rest/deployments/index.md new file mode 100644 index 0000000000..c92c19aec6 --- /dev/null +++ b/translations/ja-JP/content/rest/deployments/index.md @@ -0,0 +1,19 @@ +--- +title: Deployments +intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /deployments + - /environments + - /statuses +redirect_from: + - /rest/reference/deployments +--- diff --git a/translations/ja-JP/content/rest/deployments/statuses.md b/translations/ja-JP/content/rest/deployments/statuses.md new file mode 100644 index 0000000000..0896d48e75 --- /dev/null +++ b/translations/ja-JP/content/rest/deployments/statuses.md @@ -0,0 +1,13 @@ +--- +title: Deployment Statuses +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/emojis.md b/translations/ja-JP/content/rest/emojis.md new file mode 100644 index 0000000000..ca45960388 --- /dev/null +++ b/translations/ja-JP/content/rest/emojis.md @@ -0,0 +1,14 @@ +--- +title: Emojis +intro: 'With the Emojis API, you can list and view all the available emojis to use in {% data variables.product.product_name %}.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/emojis +--- diff --git a/translations/ja-JP/content/rest/enterprise-admin/admin-stats.md b/translations/ja-JP/content/rest/enterprise-admin/admin-stats.md new file mode 100644 index 0000000000..d18be10342 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/admin-stats.md @@ -0,0 +1,12 @@ +--- +title: Admin stats +intro: 'The Admin Stats API provides a variety of metrics about your installation.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/announcement.md b/translations/ja-JP/content/rest/enterprise-admin/announcement.md new file mode 100644 index 0000000000..05a248af24 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/announcement.md @@ -0,0 +1,14 @@ +--- +title: Announcement +intro: 'The Announcement API allows you to manage the global announcement banner in your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +## Announcement + +The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/audit-log.md b/translations/ja-JP/content/rest/enterprise-admin/audit-log.md new file mode 100644 index 0000000000..7fa5096e21 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/audit-log.md @@ -0,0 +1,11 @@ +--- +title: Audit log +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/enterprise-admin/billing.md b/translations/ja-JP/content/rest/enterprise-admin/billing.md new file mode 100644 index 0000000000..15f8a05d8f --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/billing.md @@ -0,0 +1,11 @@ +--- +title: Billing +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/enterprise-admin/global-webhooks.md b/translations/ja-JP/content/rest/enterprise-admin/global-webhooks.md new file mode 100644 index 0000000000..b14fc8ab70 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/global-webhooks.md @@ -0,0 +1,14 @@ +--- +title: Global Webhooks +intro: 'Global Webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. + +*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/index.md b/translations/ja-JP/content/rest/enterprise-admin/index.md new file mode 100644 index 0000000000..2845bef7e0 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/index.md @@ -0,0 +1,82 @@ +--- +title: GitHub Enterprise administration +intro: You can use these endpoints to administer your enterprise. +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/enterprise-admin + - /v3/enterprise + - /rest/reference/enterprise-admin +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +shortTitle: Enterprise administration +children: + - /admin-stats + - /announcement + - /audit-log + - /billing + - /global-webhooks + - /ldap + - /license + - /management-console + - /org-pre-receive-hooks + - /orgs + - /pre-receive-environments + - /pre-receive-hooks + - /repo-pre-receive-hooks + - /users + - /scim +--- + +{% ifversion fpt or ghec %} + +{% note %} + +**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. + +{% endnote %} + +{% endif %} + +### Endpoint URLs + +REST API endpoints{% ifversion ghes %}—except [Management Console](#management-console) API endpoints—{% endif %} are prefixed with the following URL: + +```shell +{% data variables.product.api_url_pre %} +``` + +{% ifversion fpt or ghec %} +When endpoints include `{enterprise}`, replace `{enterprise}` with the handle for your enterprise account, which is included in the URL for your enterprise settings. For example, if your enterprise account is located at `https://github.com/enterprises/octo-enterprise`, replace `{enterprise}` with `octo-enterprise`. +{% endif %} + +{% ifversion ghes %} +[Management Console](#management-console) API endpoints are only prefixed with a hostname: + +```shell +http(s)://hostname/ +``` +{% endif %} +{% ifversion ghae or ghes %} +### Authentication + +Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** {% ifversion ghes %}(which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) {% endif %}or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% ifversion ghes %} +OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %} + +Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/){% endif %}. + +{% endif %} + +{% ifversion ghae or ghes %} +### Version information + +The current version of your enterprise is returned in the response header of every API: +`X-GitHub-Enterprise-Version: {{currentVersion}}.0` +You can also read the current version by calling the [meta endpoint](/rest/reference/meta/). + +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/ldap.md b/translations/ja-JP/content/rest/enterprise-admin/ldap.md new file mode 100644 index 0000000000..af2f31c0a7 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/ldap.md @@ -0,0 +1,11 @@ +--- +title: LDAP +intro: 'You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/license.md b/translations/ja-JP/content/rest/enterprise-admin/license.md new file mode 100644 index 0000000000..2fd64bd48e --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/license.md @@ -0,0 +1,12 @@ +--- +title: License +intro: 'The License API provides information on your Enterprise license.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/management-console.md b/translations/ja-JP/content/rest/enterprise-admin/management-console.md new file mode 100644 index 0000000000..5e9f95ee02 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/management-console.md @@ -0,0 +1,35 @@ +--- +title: Management Console +intro: 'The Management Console API helps you manage your {% data variables.product.product_name %} installation.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% tip %} + +You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`; otherwise, the port number is `8080`. + +If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. + +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/). + +{% endtip %} + +### Authentication + +You need to pass your [Management Console password](/enterprise/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#create-a-github-enterprise-server-license). + +Use the `api_key` parameter to send this token with each request. For example: + +```shell +$ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' +``` + +You can also use standard HTTP authentication to send this token. For example: + +```shell +$ curl -L -u "api_key:your-amazing-password" 'https://hostname:admin_port/setup/api' +``` \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/org-pre-receive-hooks.md b/translations/ja-JP/content/rest/enterprise-admin/org-pre-receive-hooks.md new file mode 100644 index 0000000000..bc8b8b31ea --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/org-pre-receive-hooks.md @@ -0,0 +1,23 @@ +--- +title: Organization Pre-receive Hooks +intro: 'The Organization Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to an organization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Object attributes + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this endpoint or this hook's global configuration. Only site admins are able to access the global configuration. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/orgs.md b/translations/ja-JP/content/rest/enterprise-admin/orgs.md new file mode 100644 index 0000000000..f8fdc559dc --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: 'The Organization Administration API allows you to create organizations on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/pre-receive-environments.md b/translations/ja-JP/content/rest/enterprise-admin/pre-receive-environments.md new file mode 100644 index 0000000000..feb2ce08b5 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/pre-receive-environments.md @@ -0,0 +1,34 @@ +--- +title: Pre-receive Environments +intro: 'The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Environment + +| Name | Type | Description | +|-----------------------|-----------|----------------------------------------------------------------------------| +| `name` | `string` | The name of the environment as displayed in the UI. | +| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. | +| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. | +| `download` | `object` | This environment's download status. | +| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. | + +#### Pre-receive Environment Download + +| Name | Type | Description | +|-----------------|----------|---------------------------------------------------------| +| `state` | `string` | The state of the most recent download. | +| `downloaded_at` | `string` | The time when the most recent download started. | +| `message` | `string` | On failure, this will have any error messages produced. | + +Possible values for `state` are `not_started`, `in_progress`, `success`, `failed`. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/pre-receive-hooks.md b/translations/ja-JP/content/rest/enterprise-admin/pre-receive-hooks.md new file mode 100644 index 0000000000..08d5c5f3ce --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/pre-receive-hooks.md @@ -0,0 +1,27 @@ +--- +title: Pre-receive Hooks +intro: 'The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Hook + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `script` | `string` | The script that the hook runs. | +| `script_repository` | `object` | The GitHub repository where the script is kept. | +| `environment` | `object` | The pre-receive environment where the script is executed. | +| `enforcement` | `string` | The state of enforcement for this hook. | +| `allow_downstream_configuration` | `boolean` | Whether enforcement can be overridden at the org or repo level. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/repo-pre-receive-hooks.md b/translations/ja-JP/content/rest/enterprise-admin/repo-pre-receive-hooks.md new file mode 100644 index 0000000000..831ca1a06a --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/repo-pre-receive-hooks.md @@ -0,0 +1,22 @@ +--- +title: Repository Pre-receive Hooks +intro: 'The Repository Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to a repository.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Object attributes + +| Name | Type | Description | +|---------------------|----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/enterprise-admin/scim.md b/translations/ja-JP/content/rest/enterprise-admin/scim.md new file mode 100644 index 0000000000..326d333cbf --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/scim.md @@ -0,0 +1,11 @@ +--- +title: SCIM +intro: '' +versions: + fpt: '*' + ghec: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/enterprise-admin/users.md b/translations/ja-JP/content/rest/enterprise-admin/users.md new file mode 100644 index 0000000000..6d9aea56c7 --- /dev/null +++ b/translations/ja-JP/content/rest/enterprise-admin/users.md @@ -0,0 +1,12 @@ +--- +title: Users +intro: 'The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/gists/comments.md b/translations/ja-JP/content/rest/gists/comments.md new file mode 100644 index 0000000000..9b01fd1f71 --- /dev/null +++ b/translations/ja-JP/content/rest/gists/comments.md @@ -0,0 +1,21 @@ +--- +title: Comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Custom media types for Gist comments + +These are the supported media types for gist comments. + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.base64 + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/gists/gists.md b/translations/ja-JP/content/rest/gists/gists.md new file mode 100644 index 0000000000..5cb6fef354 --- /dev/null +++ b/translations/ja-JP/content/rest/gists/gists.md @@ -0,0 +1,35 @@ +--- +title: Gists +intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on GitHub.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Authentication + +You can read public gists {% ifversion ghae or ghes %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." + + + +### Truncation + +The Gist API provides up to one megabyte of content for each file in the gist. Each file returned for a gist through the API has a key called `truncated`. If `truncated` is `true`, the file is too large and only a portion of the contents were returned in `content`. + +If you need the full contents of the file, you can make a `GET` request to the URL specified by `raw_url`. Be aware that for files larger than ten megabytes, you'll need to clone the gist via the URL provided by `git_pull_url`. + +In addition to a specific file's contents being truncated, the entire files list may be truncated if the total number exceeds 300 files. If the top level `truncated` key is `true`, only the first 300 files have been returned in the files list. If you need to fetch all of the gist's files, you'll need to clone the gist via the URL provided by `git_pull_url`. + +### Custom media types for gists + +These are the supported media types for fetching gist contents. + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.base64 + +For more information, see "[Media types](/rest/overview/media-types)." diff --git a/translations/ja-JP/content/rest/gists/index.md b/translations/ja-JP/content/rest/gists/index.md new file mode 100644 index 0000000000..7c9ddbab2c --- /dev/null +++ b/translations/ja-JP/content/rest/gists/index.md @@ -0,0 +1,18 @@ +--- +title: Gists +intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on {% data variables.product.product_name %}.' +redirect_from: + - /v3/gists + - /rest/reference/gists +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /gists + - /comments +--- diff --git a/translations/ja-JP/content/rest/git/blobs.md b/translations/ja-JP/content/rest/git/blobs.md new file mode 100644 index 0000000000..a4df5aca84 --- /dev/null +++ b/translations/ja-JP/content/rest/git/blobs.md @@ -0,0 +1,24 @@ +--- +title: Blobs +intro: 'A Git blob (binary large object) is the object type used to store the contents of each file in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) +to your Git database on {% data variables.product.product_name %}. Blobs leverage [these custom media types](#custom-media-types-for-blobs). You can read more about the use of media types in the API [here](/rest/overview/media-types). + +### Custom media types for blobs + +These are the supported media types for blobs. + + application/json + application/vnd.github.VERSION.raw + +For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/git/commits.md b/translations/ja-JP/content/rest/git/commits.md new file mode 100644 index 0000000000..18c14bb2ac --- /dev/null +++ b/translations/ja-JP/content/rest/git/commits.md @@ -0,0 +1,14 @@ +--- +title: Commits +intro: 'A Git commit is a snapshot of the hierarchy ([Git tree](/rest/reference/git#trees)) and the contents of the files ([Git blob](/rest/reference/git#blobs)) in a Git repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/git/index.md b/translations/ja-JP/content/rest/git/index.md new file mode 100644 index 0000000000..da1de11653 --- /dev/null +++ b/translations/ja-JP/content/rest/git/index.md @@ -0,0 +1,24 @@ +--- +title: Git database +intro: 'The Git Database API enables you to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update Git references (branch heads and tags).' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/git + - /rest/reference/git +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /blobs + - /commits + - /refs + - /tags + - /trees +--- + +The Git Database API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the Git Database API, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/git/refs.md b/translations/ja-JP/content/rest/git/refs.md new file mode 100644 index 0000000000..55b5f8122a --- /dev/null +++ b/translations/ja-JP/content/rest/git/refs.md @@ -0,0 +1,15 @@ +--- +title: References +intro: 'A Git reference (`git ref`) is just a file that contains a Git commit SHA-1 hash.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is just a Git reference that stores the new Git commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v1/Git-Internals-Git-References) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/git/tags.md b/translations/ja-JP/content/rest/git/tags.md new file mode 100644 index 0000000000..101fde046a --- /dev/null +++ b/translations/ja-JP/content/rest/git/tags.md @@ -0,0 +1,14 @@ +--- +title: Tags +intro: 'A Git tag is similar to a [Git reference](/rest/reference/git#refs), but the Git commit that it points to never changes.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags) to your Git database on {% data variables.product.product_name %}. The Git tags API only supports [annotated tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags), not lightweight tags. diff --git a/translations/ja-JP/content/rest/git/trees.md b/translations/ja-JP/content/rest/git/trees.md new file mode 100644 index 0000000000..7471c1d66a --- /dev/null +++ b/translations/ja-JP/content/rest/git/trees.md @@ -0,0 +1,14 @@ +--- +title: Trees +intro: 'A Git tree object creates the hierarchy between files in a Git repository. ' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/gitignore.md b/translations/ja-JP/content/rest/gitignore.md new file mode 100644 index 0000000000..0a641c3994 --- /dev/null +++ b/translations/ja-JP/content/rest/gitignore.md @@ -0,0 +1,24 @@ +--- +title: Gitignore +intro: 'The Gitignore API fetches `.gitignore` templates that can be used to ignore files and directories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/gitignore +--- + +When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). + +### Custom media types for gitignore + +You can use this custom media type when getting a gitignore template. + + application/vnd.github.VERSION.raw + +For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/index.md b/translations/ja-JP/content/rest/index.md index 9d920a0911..773fa86484 100644 --- a/translations/ja-JP/content/rest/index.md +++ b/translations/ja-JP/content/rest/index.md @@ -1,7 +1,7 @@ --- -title: GitHubのREST API +title: GitHub REST API shortTitle: REST API -intro: 'インテグレーションを作成し、データを取り出し、ワークフローを自動化するために、{% data variables.product.prodname_dotcom %}のREST APIで構築してください。' +intro: 'To create integrations, retrieve data, and automate your workflows, build with the {% data variables.product.prodname_dotcom %} REST API.' introLinks: quickstart: /rest/guides/getting-started-with-the-rest-api featuredLinks: @@ -31,7 +31,49 @@ versions: ghec: '*' children: - /overview - - /reference - /guides + - /actions + - /activity + - /apps + - /billing + - /branches + - /checks + - /codes-of-conduct + - /code-scanning + - /codespaces + - /collaborators + - /commits + - /dependabot + - /dependency-graph + - /deploy-keys + - /deployments + - /emojis + - /enterprise-admin + - /gists + - /git + - /gitignore + - /interactions + - /issues + - /licenses + - /markdown + - /meta + - /metrics + - /migrations + - /oauth-authorizations + - /orgs + - /packages + - /pages + - /projects + - /pulls + - /rate-limit + - /reactions + - /releases + - /repos + - /scim + - /search + - /secret-scanning + - /teams + - /users + - /webhooks --- diff --git a/translations/ja-JP/content/rest/interactions/index.md b/translations/ja-JP/content/rest/interactions/index.md new file mode 100644 index 0000000000..10c5349a73 --- /dev/null +++ b/translations/ja-JP/content/rest/interactions/index.md @@ -0,0 +1,19 @@ +--- +title: Interactions +intro: 'With the Interactions API, people with owner or admin access can set the interaction limit for the users in their organizations and repositories.' +redirect_from: + - /v3/interactions + - /rest/reference/interactions +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /repos + - /user +--- + +Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/interactions/orgs.md b/translations/ja-JP/content/rest/interactions/orgs.md new file mode 100644 index 0000000000..2185e2bb46 --- /dev/null +++ b/translations/ja-JP/content/rest/interactions/orgs.md @@ -0,0 +1,19 @@ +--- +title: Organization +intro: "The Organization Interactions API allows organization owners to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories." +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} in the organization. +* {% data reusables.interactions.contributor-user-limit-definition %} in the organization. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the organization. + +Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the [Repository](#repository) interactions endpoints instead. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/interactions/repos.md b/translations/ja-JP/content/rest/interactions/repos.md new file mode 100644 index 0000000000..5bba6ae46d --- /dev/null +++ b/translations/ja-JP/content/rest/interactions/repos.md @@ -0,0 +1,19 @@ +--- +title: Repository +intro: 'The Repository Interactions API allows people with owner or admin access to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} in the repository. +* {% data reusables.interactions.contributor-user-limit-definition %} in the repository. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the repository. + +If an interaction limit is enabled for the user or organization that owns the repository, the limit cannot be changed for the individual repository. Instead, use the [User](#user) or [Organization](#organization) interactions endpoints to change the interaction limit. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/interactions/user.md b/translations/ja-JP/content/rest/interactions/user.md new file mode 100644 index 0000000000..b7fa0c6174 --- /dev/null +++ b/translations/ja-JP/content/rest/interactions/user.md @@ -0,0 +1,18 @@ +--- +title: User +intro: 'The User Interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories. + +Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the [Repository](#repository) interactions endpoints instead. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/issues/assignees.md b/translations/ja-JP/content/rest/issues/assignees.md new file mode 100644 index 0000000000..3d465a739e --- /dev/null +++ b/translations/ja-JP/content/rest/issues/assignees.md @@ -0,0 +1,12 @@ +--- +title: Assignees +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/issues/comments.md b/translations/ja-JP/content/rest/issues/comments.md new file mode 100644 index 0000000000..9d68676a6a --- /dev/null +++ b/translations/ja-JP/content/rest/issues/comments.md @@ -0,0 +1,14 @@ +--- +title: Comments +intro: 'The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Issue Comments use [these custom media types](#custom-media-types). You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/translations/ja-JP/content/rest/issues/events.md b/translations/ja-JP/content/rest/issues/events.md new file mode 100644 index 0000000000..e6eaa7a53c --- /dev/null +++ b/translations/ja-JP/content/rest/issues/events.md @@ -0,0 +1,14 @@ +--- +title: Events +intro: 'The Issue Events API can return different types of events triggered by activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[Events API](/developers/webhooks-and-events/github-event-types)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/issues/index.md b/translations/ja-JP/content/rest/issues/index.md new file mode 100644 index 0000000000..11fae409e7 --- /dev/null +++ b/translations/ja-JP/content/rest/issues/index.md @@ -0,0 +1,23 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +redirect_from: + - /v3/issues + - /rest/reference/issues +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /issues + - /assignees + - /comments + - /events + - /labels + - /milestones + - /timeline +--- diff --git a/translations/ja-JP/content/rest/issues/issues.md b/translations/ja-JP/content/rest/issues/issues.md new file mode 100644 index 0000000000..630bf7315f --- /dev/null +++ b/translations/ja-JP/content/rest/issues/issues.md @@ -0,0 +1,23 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Custom media types for issues + +These are the supported media types for issues. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/issues/labels.md b/translations/ja-JP/content/rest/issues/labels.md new file mode 100644 index 0000000000..c2d910ec3e --- /dev/null +++ b/translations/ja-JP/content/rest/issues/labels.md @@ -0,0 +1,12 @@ +--- +title: Labels +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/issues/milestones.md b/translations/ja-JP/content/rest/issues/milestones.md new file mode 100644 index 0000000000..2ae71632ba --- /dev/null +++ b/translations/ja-JP/content/rest/issues/milestones.md @@ -0,0 +1,12 @@ +--- +title: Milestones +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/issues/timeline.md b/translations/ja-JP/content/rest/issues/timeline.md new file mode 100644 index 0000000000..4d7a73e4ca --- /dev/null +++ b/translations/ja-JP/content/rest/issues/timeline.md @@ -0,0 +1,16 @@ +--- +title: Timeline +intro: 'The Timeline Events API can return different types of events triggered by timeline activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[GitHub Events API](/developers/webhooks-and-events/github-event-types)." + +You can use this API to display information about issues and pull request or determine who should be notified of issue comments. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/licenses.md b/translations/ja-JP/content/rest/licenses.md new file mode 100644 index 0000000000..78619bfa73 --- /dev/null +++ b/translations/ja-JP/content/rest/licenses.md @@ -0,0 +1,35 @@ +--- +title: Licenses +intro: "The Licenses API lets you to retrieve popular open source licenses and information about a particular project's license file." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/licenses +--- + +The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's `LICENSE` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation. + +If a license is matched, the license key and name returned conforms to the [SPDX specification](https://spdx.org/). + +**Note:** These endpoints will also return a repository's license information: + +- [Get a repository](/rest/reference/repos#get-a-repository) +- [List repositories for a user](/rest/reference/repos#list-repositories-for-a-user) +- [List organization repositories](/rest/reference/repos#list-organization-repositories) +- [List forks](/rest/reference/repos#list-forks) +- [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user) +- [List team repositories](/rest/reference/teams#list-team-repositories) + +{% warning %} + +GitHub is a lot of things, but it’s not a law firm. As such, GitHub does not provide legal advice. Using the Licenses API or sending us an email about it does not constitute legal advice nor does it create an attorney-client relationship. If you have any questions about what you can and can't do with a particular license, you should consult with your own legal counsel before moving forward. In fact, you should always consult with your own lawyer before making any decisions that might have legal ramifications or that may impact your legal rights. + +GitHub created the License API to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers (at least most of us aren't) and that we make mistakes like everyone else. For that reason, GitHub provides the API on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API. + +{% endwarning %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/markdown.md b/translations/ja-JP/content/rest/markdown.md new file mode 100644 index 0000000000..2f782424e3 --- /dev/null +++ b/translations/ja-JP/content/rest/markdown.md @@ -0,0 +1,14 @@ +--- +title: Markdown +intro: 'The Markdown API enables you to render a markdown document as an HTML page or as raw text.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/markdown +--- diff --git a/translations/ja-JP/content/rest/meta.md b/translations/ja-JP/content/rest/meta.md new file mode 100644 index 0000000000..6ecb71fe20 --- /dev/null +++ b/translations/ja-JP/content/rest/meta.md @@ -0,0 +1,14 @@ +--- +title: Meta +intro: 'The Meta API returns meta information about {% data variables.product.product_name %} including the IP addresses of {% data variables.product.product_name %} services.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/meta +--- diff --git a/translations/ja-JP/content/rest/metrics/community.md b/translations/ja-JP/content/rest/metrics/community.md new file mode 100644 index 0000000000..725ad20ea0 --- /dev/null +++ b/translations/ja-JP/content/rest/metrics/community.md @@ -0,0 +1,10 @@ +--- +title: Community +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/metrics/index.md b/translations/ja-JP/content/rest/metrics/index.md new file mode 100644 index 0000000000..4f450b3a9e --- /dev/null +++ b/translations/ja-JP/content/rest/metrics/index.md @@ -0,0 +1,20 @@ +--- +title: Metrics +intro: 'The repository metrics API allows you to retrieve community profile, statistics, and traffic for your repository.' +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/repository-metrics + - /rest/reference/metrics +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /community + - /statistics + - /traffic +--- diff --git a/translations/ja-JP/content/rest/metrics/statistics.md b/translations/ja-JP/content/rest/metrics/statistics.md new file mode 100644 index 0000000000..955c527812 --- /dev/null +++ b/translations/ja-JP/content/rest/metrics/statistics.md @@ -0,0 +1,31 @@ +--- +title: Statistics +intro: 'The Repository Statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different types of repository activity.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### A word about caching + +Computing repository statistics is an expensive operation, so we try to return cached +data whenever possible. If the data hasn't been cached when you query a repository's +statistics, you'll receive a `202` response; a background job is also fired to +start compiling these statistics. Give the job a few moments to complete, and +then submit the request again. If the job has completed, that request will receive a +`200` response with the statistics in the response body. + +Repository statistics are cached by the SHA of the repository's default branch; pushing to the default branch resets the statistics cache. + +### Statistics exclude some types of commits + +The statistics exposed by the API match the statistics shown by [different repository graphs](/github/visualizing-repository-data-with-graphs/about-repository-graphs). + +To summarize: +- All statistics exclude merge commits. +- Contributor statistics also exclude empty commits. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/metrics/traffic.md b/translations/ja-JP/content/rest/metrics/traffic.md new file mode 100644 index 0000000000..9360f43231 --- /dev/null +++ b/translations/ja-JP/content/rest/metrics/traffic.md @@ -0,0 +1,12 @@ +--- +title: Traffic +intro: 'For repositories that you have push access to, the traffic API provides access to the information provided in your repository graph. ' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "Viewing traffic to a repository." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/migrations/index.md b/translations/ja-JP/content/rest/migrations/index.md new file mode 100644 index 0000000000..46ce2d736a --- /dev/null +++ b/translations/ja-JP/content/rest/migrations/index.md @@ -0,0 +1,21 @@ +--- +title: Migrations +intro: 'The Migration API lets you migrate the repositories and users of your organization from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.' +redirect_from: + - /v3/migrations + - /v3/migration + - /v3/migration/migrations + - /rest/reference/migrations +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /source-imports + - /users +--- diff --git a/translations/ja-JP/content/rest/migrations/orgs.md b/translations/ja-JP/content/rest/migrations/orgs.md new file mode 100644 index 0000000000..4ee5218d95 --- /dev/null +++ b/translations/ja-JP/content/rest/migrations/orgs.md @@ -0,0 +1,17 @@ +--- +title: Organization +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.organization_migrations_intro %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/migrations/source-imports.md b/translations/ja-JP/content/rest/migrations/source-imports.md new file mode 100644 index 0000000000..01bd775089 --- /dev/null +++ b/translations/ja-JP/content/rest/migrations/source-imports.md @@ -0,0 +1,87 @@ +--- +title: Source Imports +intro: '{% data variables.migrations.source_imports_intro %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) to find out the status of the import. + +A more detailed example can be seen in this diagram: + +``` ++---------+ +--------+ +---------------------+ +| Tooling | | GitHub | | Original Repository | ++---------+ +--------+ +---------------------+ + | | | + | Start import | | + |----------------------------->| | + | | | + | | Download source data | + | |--------------------------------------------->| + | | Begin streaming data | + | |<---------------------------------------------| + | | | + | Get import progress | | + |----------------------------->| | + | "status": "importing" | | + |<-----------------------------| | + | | | + | Get commit authors | | + |----------------------------->| | + | | | + | Map a commit author | | + |----------------------------->| | + | | | + | | | + | | Finish streaming data | + | |<---------------------------------------------| + | | | + | | Rewrite commits with mapped authors | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Map a commit author | | + |----------------------------->| | + | | Rewrite commits with mapped authors | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Get large files | | + |----------------------------->| | + | | | + | opt_in to Git LFS | | + |----------------------------->| | + | | Rewrite commits for large files | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Get import progress | | + |----------------------------->| | + | "status": "complete" | | + |<-----------------------------| | + | | | + | | | +``` \ No newline at end of file diff --git a/translations/ja-JP/content/rest/migrations/users.md b/translations/ja-JP/content/rest/migrations/users.md new file mode 100644 index 0000000000..185cc1a43e --- /dev/null +++ b/translations/ja-JP/content/rest/migrations/users.md @@ -0,0 +1,20 @@ +--- +title: Users +intro: 'The Users migrations API is only available to authenticated account owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.user_migrations_intro %} For a list of migration data that you can download, see "[Download a user migration archive](#download-a-user-migration-archive)." + +To download an archive, you'll need to start a user migration first. Once the status of the migration is `exported`, you can download the migration. + +Once you've created a migration archive, it will be available to download for seven days. But, you can delete the user migration archive sooner if you'd like. You can unlock your repository when the migration is `exported` to begin using your repository again or delete the repository if you no longer need the source data. diff --git a/translations/ja-JP/content/rest/oauth-authorizations.md b/translations/ja-JP/content/rest/oauth-authorizations.md new file mode 100644 index 0000000000..2f6e8fab75 --- /dev/null +++ b/translations/ja-JP/content/rest/oauth-authorizations.md @@ -0,0 +1,17 @@ +--- +title: OAuth Authorizations +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/oauth-authorizations +--- + +You can use this API to manage the access OAuth applications have to your account. You can only access this API via [Basic Authentication](/rest/overview/other-authentication-methods#basic-authentication) using your username and password, not tokens. + +If you or your users have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication). \ No newline at end of file diff --git a/translations/ja-JP/content/rest/orgs/blocking.md b/translations/ja-JP/content/rest/orgs/blocking.md new file mode 100644 index 0000000000..9e0982fa5d --- /dev/null +++ b/translations/ja-JP/content/rest/orgs/blocking.md @@ -0,0 +1,13 @@ +--- +title: Blocking users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +The token used to authenticate the call must have the `admin:org` scope in order to make any blocking calls for an organization. Otherwise, the response returns `HTTP 404`. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/orgs/custom-roles.md b/translations/ja-JP/content/rest/orgs/custom-roles.md new file mode 100644 index 0000000000..6944dff7d0 --- /dev/null +++ b/translations/ja-JP/content/rest/orgs/custom-roles.md @@ -0,0 +1,14 @@ +--- +title: Custom Repository Roles +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/orgs/custom_roles +--- diff --git a/translations/ja-JP/content/rest/orgs/index.md b/translations/ja-JP/content/rest/orgs/index.md new file mode 100644 index 0000000000..917eba0b84 --- /dev/null +++ b/translations/ja-JP/content/rest/orgs/index.md @@ -0,0 +1,23 @@ +--- +title: Organizations +intro: 'The Organizations API gives you access to control and manage all your {% data variables.product.product_name %} organizations.' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/orgs + - /rest/reference/orgs +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /blocking + - /custom-roles + - /members + - /outside-collaborators + - /webhooks +--- diff --git a/translations/ja-JP/content/rest/orgs/members.md b/translations/ja-JP/content/rest/orgs/members.md new file mode 100644 index 0000000000..40c46bda07 --- /dev/null +++ b/translations/ja-JP/content/rest/orgs/members.md @@ -0,0 +1,12 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/orgs/orgs.md b/translations/ja-JP/content/rest/orgs/orgs.md new file mode 100644 index 0000000000..d9d89ac9cb --- /dev/null +++ b/translations/ja-JP/content/rest/orgs/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/translations/ja-JP/content/rest/orgs/outside-collaborators.md b/translations/ja-JP/content/rest/orgs/outside-collaborators.md new file mode 100644 index 0000000000..8975f3a093 --- /dev/null +++ b/translations/ja-JP/content/rest/orgs/outside-collaborators.md @@ -0,0 +1,12 @@ +--- +title: Outside Collaborators +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/orgs/webhooks.md b/translations/ja-JP/content/rest/orgs/webhooks.md new file mode 100644 index 0000000000..97ae08ff1c --- /dev/null +++ b/translations/ja-JP/content/rest/orgs/webhooks.md @@ -0,0 +1,35 @@ +--- +title: Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in an organization. {% data reusables.webhooks.webhooks-rest-api-links %} + +For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)." + +### Scopes & Restrictions + +All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require the `admin:org_hook` scope. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." + +In order to protect sensitive data which may be present in webhook configurations, we also enforce the following access control rules: + +- OAuth applications cannot list, view, or edit webhooks which they did not create. +- Users cannot list, view, or edit webhooks which were created by OAuth applications. + +### Receiving Webhooks + +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +For more best practices, [see our guide](/guides/best-practices-for-integrators/). + +#### Webhook headers + +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/webhooks/event-payloads/#delivery-headers) for details. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/overview/permissions-required-for-github-apps.md b/translations/ja-JP/content/rest/overview/permissions-required-for-github-apps.md index 84affebba6..1e784ea623 100644 --- a/translations/ja-JP/content/rest/overview/permissions-required-for-github-apps.md +++ b/translations/ja-JP/content/rest/overview/permissions-required-for-github-apps.md @@ -909,7 +909,7 @@ _Team_ - [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (:write) {% endif %} -{% ifversion fpt or ghes > 3.0 or ghec %} +{% ifversion ghes > 3.0 or ghec %} ### "secret scanning alerts"に対する権限 - [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) diff --git a/translations/ja-JP/content/rest/packages.md b/translations/ja-JP/content/rest/packages.md new file mode 100644 index 0000000000..32204571ad --- /dev/null +++ b/translations/ja-JP/content/rest/packages.md @@ -0,0 +1,23 @@ +--- +title: Packages +intro: 'With the {% data variables.product.prodname_registry %} API, you can manage packages for your {% data variables.product.prodname_dotcom %} repositories and organizations.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/packages +--- + +The {% data variables.product.prodname_registry %} API enables you to manage packages using the REST API.{% ifversion fpt or ghec or ghes > 3.1 or ghae %} To learn more about restoring or deleting packages, see "[Restoring and deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)."{% endif %} + +To use this API, you must authenticate using a personal access token. + - To access package metadata, your token must include the `read:packages` scope. + - To delete packages and package versions, your token must include the `read:packages` and `delete:packages` scopes. + - To restore packages and package versions, your token must include the `read:packages` and `write:packages` scopes. + +If your `package_type` is `npm`, `maven`, `rubygems`, or `nuget`, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. If your package is in the {% data variables.product.prodname_container_registry %}, then your `package_type` is `container` and your token does not need the `repo` scope to access or manage this `package_type`. `container` packages offer granular permissions separate from a repository. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)." + +If you want to use the {% data variables.product.prodname_registry %} API to access resources in an organization with SSO enabled, then you must enable SSO for your personal access token. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} diff --git a/translations/ja-JP/content/rest/pages.md b/translations/ja-JP/content/rest/pages.md new file mode 100644 index 0000000000..2864c8aae6 --- /dev/null +++ b/translations/ja-JP/content/rest/pages.md @@ -0,0 +1,14 @@ +--- +title: Pages +intro: 'The GitHub Pages API allows you to interact with GitHub Pages sites and build information.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/pages +--- \ No newline at end of file diff --git a/translations/ja-JP/content/rest/projects/cards.md b/translations/ja-JP/content/rest/projects/cards.md new file mode 100644 index 0000000000..f92c719935 --- /dev/null +++ b/translations/ja-JP/content/rest/projects/cards.md @@ -0,0 +1,12 @@ +--- +title: Cards +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/projects/collaborators.md b/translations/ja-JP/content/rest/projects/collaborators.md new file mode 100644 index 0000000000..a68e1809bc --- /dev/null +++ b/translations/ja-JP/content/rest/projects/collaborators.md @@ -0,0 +1,13 @@ +--- +title: Collaborators +intro: "This API allows you to interact with an organization's projects." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/translations/ja-JP/content/rest/projects/columns.md b/translations/ja-JP/content/rest/projects/columns.md new file mode 100644 index 0000000000..e3c0985574 --- /dev/null +++ b/translations/ja-JP/content/rest/projects/columns.md @@ -0,0 +1,12 @@ +--- +title: Columns +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/projects/index.md b/translations/ja-JP/content/rest/projects/index.md new file mode 100644 index 0000000000..7afcf086c6 --- /dev/null +++ b/translations/ja-JP/content/rest/projects/index.md @@ -0,0 +1,20 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +redirect_from: + - /v3/projects + - /rest/reference/projects +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /projects + - /cards + - /collaborators + - /columns +--- diff --git a/translations/ja-JP/content/rest/projects/projects.md b/translations/ja-JP/content/rest/projects/projects.md new file mode 100644 index 0000000000..ff85668198 --- /dev/null +++ b/translations/ja-JP/content/rest/projects/projects.md @@ -0,0 +1,12 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/ja-JP/content/rest/pulls/comments.md b/translations/ja-JP/content/rest/pulls/comments.md new file mode 100644 index 0000000000..c18aa3d812 --- /dev/null +++ b/translations/ja-JP/content/rest/pulls/comments.md @@ -0,0 +1,26 @@ +--- +title: Review Comments +intro: 'Pull request review comments are comments on a portion of the unified diff made during a pull request review.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Commit comments and issue comments are different from pull request review comments. You apply commit comments directly to a commit and you apply issue comments without referencing a portion of the unified diff. For more information, see "[Create a commit comment](/rest/reference/commits#create-a-commit-comment)" and "[Create an issue comment](/rest/reference/issues#create-an-issue-comment)." + +### Custom media types for pull request review comments + +These are the supported media types for pull request review comments. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/ja-JP/content/rest/pulls/index.md b/translations/ja-JP/content/rest/pulls/index.md new file mode 100644 index 0000000000..17a7f54a5d --- /dev/null +++ b/translations/ja-JP/content/rest/pulls/index.md @@ -0,0 +1,20 @@ +--- +title: Pulls +intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' +redirect_from: + - /v3/pulls + - /rest/reference/pulls +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /pulls + - /comments + - /review-requests + - /reviews +--- diff --git a/translations/ja-JP/content/rest/pulls/pulls.md b/translations/ja-JP/content/rest/pulls/pulls.md new file mode 100644 index 0000000000..7e094d8d90 --- /dev/null +++ b/translations/ja-JP/content/rest/pulls/pulls.md @@ -0,0 +1,46 @@ +--- +title: Pulls +intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](/rest/reference/issues#comments). + +Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like manipulating assignees, labels and milestones, are provided within [the Issues API](/rest/reference/issues). + +### Custom media types for pull requests + +These are the supported media types for pull requests. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + application/vnd.github.VERSION.diff + application/vnd.github.VERSION.patch + +For more information, see "[Custom media types](/rest/overview/media-types)." + +If a diff is corrupt, contact {% data variables.contact.contact_support %}. Include the repository name and pull request ID in your message. + +### Link Relations + +Pull Requests have these possible link relations: + +Name | Description +-----|-----------| +`self`| The API location of this Pull Request. +`html`| The HTML location of this Pull Request. +`issue`| The API location of this Pull Request's [Issue](/rest/reference/issues). +`comments`| The API location of this Pull Request's [Issue comments](/rest/reference/issues#comments). +`review_comments`| The API location of this Pull Request's [Review comments](/rest/reference/pulls#comments). +`review_comment`| The [URL template](/rest#hypermedia) to construct the API location for a [Review comment](/rest/reference/pulls#comments) in this Pull Request's repository. +`commits`|The API location of this Pull Request's [commits](#list-commits-on-a-pull-request). +`statuses`| The API location of this Pull Request's [commit statuses](/rest/reference/commits#commit-statuses), which are the statuses of its `head` branch. diff --git a/translations/ja-JP/content/rest/pulls/review-requests.md b/translations/ja-JP/content/rest/pulls/review-requests.md new file mode 100644 index 0000000000..dc43b989bb --- /dev/null +++ b/translations/ja-JP/content/rest/pulls/review-requests.md @@ -0,0 +1,14 @@ +--- +title: Review Requests +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/pulls/reviews.md b/translations/ja-JP/content/rest/pulls/reviews.md new file mode 100644 index 0000000000..8912d09ecb --- /dev/null +++ b/translations/ja-JP/content/rest/pulls/reviews.md @@ -0,0 +1,13 @@ +--- +title: Reviews +intro: 'Pull Request Reviews are groups of Pull Request Review Comments on the Pull Request, grouped together with a state and optional body comment.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/translations/ja-JP/content/rest/rate-limit.md b/translations/ja-JP/content/rest/rate-limit.md new file mode 100644 index 0000000000..502ba87c86 --- /dev/null +++ b/translations/ja-JP/content/rest/rate-limit.md @@ -0,0 +1,33 @@ +--- +title: Rate limit +intro: 'With the Rate Limit API, you can check the current rate limit status of various REST APIs.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/rate-limit +--- + +The REST API overview documentation describes the [rate limit rules](/rest/overview/resources-in-the-rest-api#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below. + +### Understanding your rate limit status + +The Search API has a [custom rate limit](/rest/reference/search#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations#rate-limit) that is separate from and calculated differently than rate limits in the REST API. + +For these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four +objects: + +* The `core` object provides your rate limit status for all non-search-related resources in the REST API. + +* The `search` object provides your rate limit status for the [Search API](/rest/reference/search). + +* The `graphql` object provides your rate limit status for the [GraphQL API]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql). + +* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint. + +For more information on the headers and values in the rate limit response, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limit-http-headers)." diff --git a/translations/ja-JP/content/rest/reactions.md b/translations/ja-JP/content/rest/reactions.md new file mode 100644 index 0000000000..6ba29b6b1d --- /dev/null +++ b/translations/ja-JP/content/rest/reactions.md @@ -0,0 +1,20 @@ +--- +title: Reactions +intro: 'The Reactions API enables you to create, list and delete the reactions on comments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/reactions +--- + +### Reaction types + +When creating a reaction, the allowed values for the `content` parameter are as follows (with the corresponding emoji for reference): + +{% data reusables.repositories.reaction_list %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/reference/actions.md b/translations/ja-JP/content/rest/reference/actions.md deleted file mode 100644 index ab1972db6a..0000000000 --- a/translations/ja-JP/content/rest/reference/actions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: アクション -intro: 'Actions APIを使うと、Organizationやリポジトリの{% data variables.product.prodname_actions %}を管理し、制御できます。' -redirect_from: - - /v3/actions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/activity.md b/translations/ja-JP/content/rest/reference/activity.md deleted file mode 100644 index 1a15e000f3..0000000000 --- a/translations/ja-JP/content/rest/reference/activity.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: アクティビティ -intro: Activity APIを使うと、イベントやフィードをリストし、通知、Star、認証されたユーザのWatchを管理できます。 -redirect_from: - - /v3/activity -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/apps.md b/translations/ja-JP/content/rest/reference/apps.md deleted file mode 100644 index b48b8aaa31..0000000000 --- a/translations/ja-JP/content/rest/reference/apps.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: アプリ -intro: GitHub Apps APIを使うと、インストールに関する情報や、GitHub Appに関する特定の情報を取得できます。 -redirect_from: - - /v3/apps -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/billing.md b/translations/ja-JP/content/rest/reference/billing.md deleted file mode 100644 index 457f2323a1..0000000000 --- a/translations/ja-JP/content/rest/reference/billing.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: 支払い -intro: 'Billing APIを使うと、ユーザやOrganizationに対する{% data variables.product.prodname_actions %}や{% data variables.product.prodname_registry %}の確認と使用状況をモニターできます。' -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.4' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/branches.md b/translations/ja-JP/content/rest/reference/branches.md deleted file mode 100644 index e125a0776a..0000000000 --- a/translations/ja-JP/content/rest/reference/branches.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: ブランチ -intro: ブランチAPIを使うと、ブランチとブランチの保護設定を変更できます。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/checks.md b/translations/ja-JP/content/rest/reference/checks.md deleted file mode 100644 index ca2b4dea93..0000000000 --- a/translations/ja-JP/content/rest/reference/checks.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: チェック -intro: 'Checks APIを使用すると、リポジトリでのコード変更に対して強力なチェックを行う{% data variables.product.prodname_github_apps %}を構築できます。' -redirect_from: - - /v3/checks -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/code-scanning.md b/translations/ja-JP/content/rest/reference/code-scanning.md deleted file mode 100644 index 19153ecd79..0000000000 --- a/translations/ja-JP/content/rest/reference/code-scanning.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Code scanning -intro: Code Scanning APIを使うと、リポジトリからCode scanningのアラートと分析を取得し、更新できます。 -redirect_from: - - /v3/code-scanning -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: reference -topics: - - API - - Code scanning - - REST -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/codes-of-conduct.md b/translations/ja-JP/content/rest/reference/codes-of-conduct.md deleted file mode 100644 index 8b9b973f9c..0000000000 --- a/translations/ja-JP/content/rest/reference/codes-of-conduct.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 行動規範 -intro: Codes of Conduct APIを使うと、特定のリポジトリの行動規範に関する情報を取得できます。 -redirect_from: - - /v3/codes_of_conduct - - /v3/codes-of-conduct -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/codespaces.md b/translations/ja-JP/content/rest/reference/codespaces.md deleted file mode 100644 index 5d353aec91..0000000000 --- a/translations/ja-JP/content/rest/reference/codespaces.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Codespaces -intro: '{% data variables.product.prodname_codespaces %} APIを使うと、REST APIを利用してCodespacesを管理できます。' -product: '{% data reusables.gated-features.codespaces %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/collaborators.md b/translations/ja-JP/content/rest/reference/collaborators.md deleted file mode 100644 index 822f6c6c40..0000000000 --- a/translations/ja-JP/content/rest/reference/collaborators.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: コラボレータ -intro: コラボレータAPIを使うと、リポジトリでコラボレータの追加、招待、削除が行えます。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/commits.md b/translations/ja-JP/content/rest/reference/commits.md deleted file mode 100644 index a8022f5ae2..0000000000 --- a/translations/ja-JP/content/rest/reference/commits.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: コミット -intro: コミットAPIを使うと、リポジトリ内のコミットのリスト、表示、比較ができます。 コミットコメントやコミットのステータスの操作もできます。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/dependabot.md b/translations/ja-JP/content/rest/reference/dependabot.md deleted file mode 100644 index d5f9b41693..0000000000 --- a/translations/ja-JP/content/rest/reference/dependabot.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Dependabot -intro: '{% data variables.product.prodname_dependabot %} Secrets APIを使うと、Organizationあるいはリポジトリの{% data variables.product.prodname_dependabot %}sjシークレットを管理し、制御できます。' -versions: - fpt: '*' - ghes: '>=3.4' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/dependency-graph.md b/translations/ja-JP/content/rest/reference/dependency-graph.md deleted file mode 100644 index 5ed5f3592f..0000000000 --- a/translations/ja-JP/content/rest/reference/dependency-graph.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 依存関係グラフ -intro: Dependency Graph APIを使うと、リポジトリにおける依存関係の変更や、その変更のセキュリティへの影響を見ることができます。 -versions: - fpt: '*' - ghes: '>=3.6' - ghec: '*' - ghae: issue-6396 -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/deploy_keys.md b/translations/ja-JP/content/rest/reference/deploy_keys.md deleted file mode 100644 index 08cd4132e1..0000000000 --- a/translations/ja-JP/content/rest/reference/deploy_keys.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: デプロイキー -intro: Deploy Keys APIを使えば、サーバーに保存され、GitHubリポジトリへのアクセスを許可するSSHキーを作成できます。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/deployments.md b/translations/ja-JP/content/rest/reference/deployments.md deleted file mode 100644 index 3763c740b9..0000000000 --- a/translations/ja-JP/content/rest/reference/deployments.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: デプロイメント -intro: デプロイメントAPIを使うと、デプロイメント及びデプロイメント環境の作成と削除ができます。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/emojis.md b/translations/ja-JP/content/rest/reference/emojis.md deleted file mode 100644 index f703abb119..0000000000 --- a/translations/ja-JP/content/rest/reference/emojis.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 絵文字 -intro: 'Emojis APIを使用すると、{% data variables.product.product_name %}で利用できるすべての絵文字のリストと表示ができます。' -redirect_from: - - /v3/emojis - - /v3/misc -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/enterprise-admin.md b/translations/ja-JP/content/rest/reference/enterprise-admin.md deleted file mode 100644 index c68a10d42d..0000000000 --- a/translations/ja-JP/content/rest/reference/enterprise-admin.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: GitHub Enterprise administration -intro: You can use these endpoints to administer your enterprise. -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/enterprise-admin - - /v3/enterprise -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 -shortTitle: Enterprise administration ---- - - diff --git a/translations/ja-JP/content/rest/reference/gists.md b/translations/ja-JP/content/rest/reference/gists.md deleted file mode 100644 index 971cd74e8e..0000000000 --- a/translations/ja-JP/content/rest/reference/gists.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Gist -intro: 'Gists APIを使うと、認可されたユーザは{% data variables.product.product_name %}上のパブリックGistのリスト、作成、、更新、削除ができます。' -redirect_from: - - /v3/gists -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/git.md b/translations/ja-JP/content/rest/reference/git.md deleted file mode 100644 index 973b396afc..0000000000 --- a/translations/ja-JP/content/rest/reference/git.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Git データベース -intro: 'Git Database APIを使うと、{% data variables.product.product_name %}上のGitデータベースに対してRaw形式のGitオブジェクトを読み書きしたり、リファレンス (ブランチheadやタグ) をリストおよび更新したりできます。' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/git -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/gitignore.md b/translations/ja-JP/content/rest/reference/gitignore.md deleted file mode 100644 index 5d243527ed..0000000000 --- a/translations/ja-JP/content/rest/reference/gitignore.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Gitignore -intro: Gitignore APIは、ファイルやディレクトリを無視するために利用できる`.gitignore`テンプレートをフェッチします。 -redirect_from: - - /v3/gitignore -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/index.md b/translations/ja-JP/content/rest/reference/index.md deleted file mode 100644 index 78390442cf..0000000000 --- a/translations/ja-JP/content/rest/reference/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: リファレンス -shortTitle: リファレンス -intro: GitHub RESTのAPIで使用できるリソースについては、リファレンスドキュメントを参照してください。 -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -children: - - /actions - - /activity - - /apps - - /billing - - /branches - - /checks - - /codes-of-conduct - - /code-scanning - - /codespaces - - /collaborators - - /commits - - /dependabot - - /dependency-graph - - /deploy_keys - - /deployments - - /emojis - - /enterprise-admin - - /gists - - /git - - /gitignore - - /interactions - - /issues - - /licenses - - /markdown - - /meta - - /metrics - - /migrations - - /oauth-authorizations - - /orgs - - /packages - - /pages - - /projects - - /pulls - - /rate-limit - - /reactions - - /releases - - /repos - - /scim - - /search - - /secret-scanning - - /teams - - /users - - /webhooks ---- - diff --git a/translations/ja-JP/content/rest/reference/interactions.md b/translations/ja-JP/content/rest/reference/interactions.md deleted file mode 100644 index 497bd4cf1a..0000000000 --- a/translations/ja-JP/content/rest/reference/interactions.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: インタラクション -intro: Interactions APIを使うと、オーナーもしくは管理アクセスを持つ人が、Organizationやリポジトリ内のユーザの操作制限を設定できます。 -redirect_from: - - /v3/interactions -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/issues.md b/translations/ja-JP/content/rest/reference/issues.md deleted file mode 100644 index c7b51db59d..0000000000 --- a/translations/ja-JP/content/rest/reference/issues.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Issue -intro: Issues APIを使うと、Issueにアサインされた人、コメント、ラベル、マイルストーンを含め、Issueの表示と管理ができます。 -redirect_from: - - /v3/issues -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/licenses.md b/translations/ja-JP/content/rest/reference/licenses.md deleted file mode 100644 index b66d570593..0000000000 --- a/translations/ja-JP/content/rest/reference/licenses.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: ライセンス -intro: Licenses API は、広く利用されているオープンソースライセンスと、特定のプロジェクトのライセンスファイルに関する情報を返します。 -redirect_from: - - /v3/licenses -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/markdown.md b/translations/ja-JP/content/rest/reference/markdown.md deleted file mode 100644 index be2b82601d..0000000000 --- a/translations/ja-JP/content/rest/reference/markdown.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Markdown -intro: MarkdownAPIを使うと、MarkdownドキュメントをHTMLページあるいは生のテキストとしてレンダリングできます。 -redirect_from: - - /v3/markdown -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/meta.md b/translations/ja-JP/content/rest/reference/meta.md deleted file mode 100644 index 0a99c13371..0000000000 --- a/translations/ja-JP/content/rest/reference/meta.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: メタ情報 -intro: 'Meta APIは、{% data variables.product.product_name %}サービスのIPアドレスを含む{% data variables.product.product_name %}に関するメタ情報を返します。' -redirect_from: - - /v3/meta -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/metrics.md b/translations/ja-JP/content/rest/reference/metrics.md deleted file mode 100644 index 2c3ff4bade..0000000000 --- a/translations/ja-JP/content/rest/reference/metrics.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: メトリクス -intro: リポジトリメトリクスAPIを使うと、リポジトリのコミュニティプロフィール、統計、トラフィックを取得できます。 -allowTitleToDifferFromFilename: true -redirect_from: - - /rest/reference/repository-metrics -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/migrations.md b/translations/ja-JP/content/rest/reference/migrations.md deleted file mode 100644 index d47a4f8ba4..0000000000 --- a/translations/ja-JP/content/rest/reference/migrations.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 移行 -intro: 'Migration APIを使うと、{% data variables.product.prodname_dotcom_the_website %}から{% data variables.product.prodname_ghe_server %}へ、Organizaitonのリポジトリとユーザを移行できます。' -redirect_from: - - /v3/migrations - - /v3/migration - - /v3/migration/migrations -versions: - fpt: '*' - ghec: '*' - ghes: '>3.3' - ghae: issue-6184 -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/oauth-authorizations.md b/translations/ja-JP/content/rest/reference/oauth-authorizations.md deleted file mode 100644 index a7c00b5837..0000000000 --- a/translations/ja-JP/content/rest/reference/oauth-authorizations.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: OAuth 認証 -redirect_from: - - /v3/oauth_authorizations - - /v3/oauth-authorizations -versions: - ghes: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/orgs.md b/translations/ja-JP/content/rest/reference/orgs.md deleted file mode 100644 index bf9272a069..0000000000 --- a/translations/ja-JP/content/rest/reference/orgs.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Organization -intro: 'Organizations APIを使うと、自分のすべての{% data variables.product.product_name %} Organizationの制御と管理のためのアクセスができます。' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/orgs -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/packages.md b/translations/ja-JP/content/rest/reference/packages.md deleted file mode 100644 index 363c02abd7..0000000000 --- a/translations/ja-JP/content/rest/reference/packages.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: パッケージ -intro: '{% data variables.product.prodname_registry %} APIを使うと、{% data variables.product.prodname_dotcom %}の自分のリポジトリとOrganizationのパッケージの管理ができます。' -product: '{% data reusables.gated-features.packages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/pages.md b/translations/ja-JP/content/rest/reference/pages.md deleted file mode 100644 index 71129a3cbb..0000000000 --- a/translations/ja-JP/content/rest/reference/pages.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Pages -intro: GitHub Pages APIを使うと、GitHub Pagesのサイトとビルド情報の操作ができます。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/projects.md b/translations/ja-JP/content/rest/reference/projects.md deleted file mode 100644 index b27117a274..0000000000 --- a/translations/ja-JP/content/rest/reference/projects.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: プロジェクト -intro: Projects APIを使うと、リポジトリ内のプロジェクトの作成、リスト、更新、削除、カスタマイズができます。 -redirect_from: - - /v3/projects -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/pulls.md b/translations/ja-JP/content/rest/reference/pulls.md deleted file mode 100644 index 04b78d1a8c..0000000000 --- a/translations/ja-JP/content/rest/reference/pulls.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Pulls -intro: Pulls APIを使うと、Pull Requestのリスト、表示、編集、作成、さらにはマージまでも行えます。 -redirect_from: - - /v3/pulls -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/rate-limit.md b/translations/ja-JP/content/rest/reference/rate-limit.md deleted file mode 100644 index fbb5451ea9..0000000000 --- a/translations/ja-JP/content/rest/reference/rate-limit.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: レート制限 -intro: Rate Limit APIを使うと、様々なREST APIの現在のレート制限のステータスをチェックできます。 -redirect_from: - - /v3/rate_limit - - /v3/rate-limit -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/reactions.md b/translations/ja-JP/content/rest/reference/reactions.md deleted file mode 100644 index b9fbe7fa74..0000000000 --- a/translations/ja-JP/content/rest/reference/reactions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: リアクション -intro: Reactions APIを使うと、コメントのリアクションの作成、リスト、削除が行えます。 -redirect_from: - - /v3/reactions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/releases.md b/translations/ja-JP/content/rest/reference/releases.md deleted file mode 100644 index ed64cd2981..0000000000 --- a/translations/ja-JP/content/rest/reference/releases.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: リリース -intro: リリースAPIを使うと、リリースとリリースアセットの作成、変更、削除ができます。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/repos.md b/translations/ja-JP/content/rest/reference/repos.md deleted file mode 100644 index deacf54576..0000000000 --- a/translations/ja-JP/content/rest/reference/repos.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: リポジトリ -intro: 'Repos APIを使うと、パブリック及びプライベートの{% data variables.product.product_name %}リポジトリのワークフローの作成、管理、制御ができます。' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/repos -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/scim.md b/translations/ja-JP/content/rest/reference/scim.md deleted file mode 100644 index 25b12f8844..0000000000 --- a/translations/ja-JP/content/rest/reference/scim.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: SCIM -intro: '{% data variables.product.product_name %} Organizationのメンバーのアクセスを、SCIM APIを使って制御及び管理できます。' -redirect_from: - - /v3/scim -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/search.md b/translations/ja-JP/content/rest/reference/search.md deleted file mode 100644 index 7e1d33f08d..0000000000 --- a/translations/ja-JP/content/rest/reference/search.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 検索 -intro: '{% data variables.product.product_name %} Search APIを使うと、特定のアイテムを効率的に検索できます。' -redirect_from: - - /v3/search -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/secret-scanning.md b/translations/ja-JP/content/rest/reference/secret-scanning.md deleted file mode 100644 index 69a332ba7b..0000000000 --- a/translations/ja-JP/content/rest/reference/secret-scanning.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Secret scanning -intro: Secret scanning APIを使うと、リポジトリのシークレットアラートの取得と更新ができます。 -versions: - fpt: '*' - ghes: '*' - ghec: '*' - ghae: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/teams.md b/translations/ja-JP/content/rest/reference/teams.md deleted file mode 100644 index ffab63efb6..0000000000 --- a/translations/ja-JP/content/rest/reference/teams.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Team -intro: 'Team APIを使うと、{% data variables.product.product_name %} Organization内のTeamの作成や管理ができます。' -redirect_from: - - /v3/teams -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/users.md b/translations/ja-JP/content/rest/reference/users.md deleted file mode 100644 index 73db1fa216..0000000000 --- a/translations/ja-JP/content/rest/reference/users.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: ユーザ -intro: Users APIを使うと、認証を受けたユーザに関するパブリック及びプライベートな情報を取得できます。 -redirect_from: - - /v3/users -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/reference/webhooks.md b/translations/ja-JP/content/rest/reference/webhooks.md deleted file mode 100644 index ef437a17db..0000000000 --- a/translations/ja-JP/content/rest/reference/webhooks.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: webhook -intro: webhooks APIを使うと、リポジトリのwebhookの作成と管理ができます。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/ja-JP/content/rest/releases/assets.md b/translations/ja-JP/content/rest/releases/assets.md new file mode 100644 index 0000000000..44956c13a1 --- /dev/null +++ b/translations/ja-JP/content/rest/releases/assets.md @@ -0,0 +1,13 @@ +--- +title: Release Assets +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/releases/index.md b/translations/ja-JP/content/rest/releases/index.md new file mode 100644 index 0000000000..c3447b9110 --- /dev/null +++ b/translations/ja-JP/content/rest/releases/index.md @@ -0,0 +1,18 @@ +--- +title: Releases +intro: 'The releases API allows you to create, modify, and delete releases and release assets.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /releases + - /assets +redirect_from: + - /rest/reference/releases +--- diff --git a/translations/ja-JP/content/rest/releases/releases.md b/translations/ja-JP/content/rest/releases/releases.md new file mode 100644 index 0000000000..fa1cb398fc --- /dev/null +++ b/translations/ja-JP/content/rest/releases/releases.md @@ -0,0 +1,19 @@ +--- +title: Releases +intro: 'The Releases API allows you to create, modify, and delete releases and release assets. +' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% note %} + +**Note:** The Releases API replaces the Downloads API. You can retrieve the download count and browser download URL from the endpoints in this API that return releases and release assets. + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/repos/autolinks.md b/translations/ja-JP/content/rest/repos/autolinks.md new file mode 100644 index 0000000000..ba9b5afafd --- /dev/null +++ b/translations/ja-JP/content/rest/repos/autolinks.md @@ -0,0 +1,16 @@ +--- +title: Autolinks +intro: 'To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets.' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." + +{% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/repos/contents.md b/translations/ja-JP/content/rest/repos/contents.md new file mode 100644 index 0000000000..a402506eeb --- /dev/null +++ b/translations/ja-JP/content/rest/repos/contents.md @@ -0,0 +1,34 @@ +--- +title: Contents +intro: 'These API endpoints let you create, modify, and delete Base64 encoded content in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +To request the raw format or rendered HTML (when supported), use custom media types for repository contents. + +### Custom media types for repository contents + +[READMEs](/rest/reference/repos#get-a-repository-readme), [files](/rest/reference/repos#get-repository-content), and [symlinks](/rest/reference/repos#get-repository-content) support the following custom media types: + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.html + +Use the `.raw` media type to retrieve the contents of the file. + +For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). + +[All objects](/rest/reference/repos#get-repository-content) support the following custom media type: + + application/vnd.github.VERSION.object + +Use the `object` media type parameter to retrieve the contents in a consistent object format regardless of the content type. For example, instead of an array of objects +for a directory, the response will be an object with an `entries` attribute containing the array of objects. + +You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/translations/ja-JP/content/rest/repos/forks.md b/translations/ja-JP/content/rest/repos/forks.md new file mode 100644 index 0000000000..5a7928f9aa --- /dev/null +++ b/translations/ja-JP/content/rest/repos/forks.md @@ -0,0 +1,12 @@ +--- +title: Forks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/content/rest/reference/repos.md b/translations/ja-JP/content/rest/repos/index.md similarity index 71% rename from content/rest/reference/repos.md rename to translations/ja-JP/content/rest/repos/index.md index 51710d0f0c..7232e7da73 100644 --- a/content/rest/reference/repos.md +++ b/translations/ja-JP/content/rest/repos/index.md @@ -4,6 +4,7 @@ intro: 'The Repos API allows to create, manage and control the workflow of publi allowTitleToDifferFromFilename: true redirect_from: - /v3/repos + - /rest/reference/repos versions: fpt: '*' ghes: '*' @@ -12,8 +13,11 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +children: + - /repos + - /autolinks + - /contents + - /forks + - /lfs + - /tags --- - - \ No newline at end of file diff --git a/translations/ja-JP/content/rest/repos/lfs.md b/translations/ja-JP/content/rest/repos/lfs.md new file mode 100644 index 0000000000..3b11137030 --- /dev/null +++ b/translations/ja-JP/content/rest/repos/lfs.md @@ -0,0 +1,13 @@ +--- +title: Git LFS +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/repos/repos.md b/translations/ja-JP/content/rest/repos/repos.md new file mode 100644 index 0000000000..8941c62602 --- /dev/null +++ b/translations/ja-JP/content/rest/repos/repos.md @@ -0,0 +1,13 @@ +--- +title: Repositories +intro: 'The Repos API allows to create, manage and control the workflow of public and private GitHub Enterprise Server repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/repos/tags.md b/translations/ja-JP/content/rest/repos/tags.md new file mode 100644 index 0000000000..7685300da2 --- /dev/null +++ b/translations/ja-JP/content/rest/repos/tags.md @@ -0,0 +1,10 @@ +--- +title: Tags +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/ja-JP/content/rest/scim.md b/translations/ja-JP/content/rest/scim.md new file mode 100644 index 0000000000..8f63ea1bb9 --- /dev/null +++ b/translations/ja-JP/content/rest/scim.md @@ -0,0 +1,54 @@ +--- +title: SCIM +intro: 'You can control and manage your GitHub organization members access using SCIM API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/scim +--- + +### SCIM Provisioning for Organizations + +The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.product_name %} organization membership. The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). The {% data variables.product.product_name %} SCIM endpoint that an IdP should use is: `{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`. + +{% note %} + +**Notes:** + - The SCIM API is available only to organizations on [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. {% data reusables.scim.enterprise-account-scim %} For more information about SCIM, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." + - The SCIM API cannot be used with {% data variables.product.prodname_emus %}. + +{% endnote %} + +### Authenticating calls to the SCIM API + +You must authenticate as an owner of a {% data variables.product.product_name %} organization to use its SCIM API. The API expects an [OAuth 2.0 Bearer](/developers/apps/authenticating-with-github-apps) token to be included in the `Authorization` header. You may also use a personal access token, but you must first [authorize it for use with your SAML SSO organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). + +### Mapping of SAML and SCIM data + +{% data reusables.scim.nameid-and-username-must-match %} + +### Supported SCIM User attributes + +Name | Type | Description +-----|------|-------------- +`userName`|`string` | The username for the user. +`name.givenName`|`string` | The first name of the user. +`name.familyName`|`string` | The last name of the user. +`emails` | `array` | List of user emails. +`externalId` | `string` | This identifier is generated by the SAML provider, and is used as a unique ID by the SAML provider to match against a GitHub user. You can find the `externalID` for a user either at the SAML provider, or using the [List SCIM provisioned identities](#list-scim-provisioned-identities) endpoint and filtering on other known attributes, such as a user's GitHub username or email address. +`id` | `string` | Identifier generated by the GitHub SCIM endpoint. +`active` | `boolean` | Used to indicate whether the identity is active (true) or should be deprovisioned (false). + +{% note %} + +**Note:** Endpoint URLs for the SCIM API are case sensitive. For example, the first letter in the `Users` endpoint must be capitalized: + +```shell +GET /scim/v2/organizations/{org}/Users/{scim_user_id} +``` + +{% endnote %} diff --git a/translations/ja-JP/content/rest/search.md b/translations/ja-JP/content/rest/search.md new file mode 100644 index 0000000000..a463da9363 --- /dev/null +++ b/translations/ja-JP/content/rest/search.md @@ -0,0 +1,175 @@ +--- +title: Search +intro: 'The GitHub Search API lets you to search for the specific item efficiently.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/search +--- + +The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. + +You can narrow your search using queries. To learn more about the search query syntax, see "[Constructing a search query](/rest/reference/search#constructing-a-search-query)." + +### Ranking search results + +Unless another sort option is provided as a query parameter, results are sorted by best match in descending order. Multiple factors are combined to boost the most relevant item to the top of the result list. + +### Rate limit + +{% data reusables.enterprise.rate_limit %} + +The Search API has a custom rate limit. For requests using [Basic +Authentication](/rest#authentication), [OAuth](/rest#authentication), or [client +ID and secret](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to +30 requests per minute. For unauthenticated requests, the rate limit allows you +to make up to 10 requests per minute. + +See the [rate limit documentation](/rest/reference/rate-limit) for details on +determining your current rate limit status. + +### Constructing a search query + +Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoint in the Search API for an example that includes the endpoint and query parameters. + +A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: + +``` +SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N +``` + +For example, if you wanted to search for all _repositories_ owned by `defunkt` that +contained the word `GitHub` and `Octocat` in the README file, you would use the +following query with the _search repositories_ endpoint: + +``` +GitHub Octocat in:readme user:defunkt +``` + +**Note:** Be sure to use your language's preferred HTML-encoder to construct your query strings. For example: +```javascript +// JavaScript +const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); +``` + +See "[Searching on GitHub](/search-github/searching-on-github)" +for a complete list of available qualifiers, their format, and an example of +how to use them. For information about how to use operators to match specific +quantities, dates, or to exclude results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)." + +### Limitations on query length + +The Search API does not support queries that: +- are longer than 256 characters (not including operators or qualifiers). +- have more than five `AND`, `OR`, or `NOT` operators. + +These search queries will return a "Validation failed" error message. + +### Timeouts and incomplete results + +To keep the Search API fast for everyone, we limit how long any individual query +can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), +the API returns the matches that were already found prior to the timeout, and +the response has the `incomplete_results` property set to `true`. + +Reaching a timeout does not necessarily mean that search results are incomplete. +More results might have been found, but also might not. + +### Access errors or missing search results + +You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a `422 Unprocessable Entry` error with a "Validation Failed" message. For example, your search will fail if your query includes `repo:`, `user:`, or `org:` qualifiers that request resources that you don't have access to when you sign in on {% data variables.product.prodname_dotcom %}. + +When your search query requests multiple resources, the response will only contain the resources that you have access to and will **not** provide an error message listing the resources that were not returned. + +For example, if your search query searches for the `octocat/test` and `codertocat/test` repositories, but you only have access to `octocat/test`, your response will show search results for `octocat/test` and nothing for `codertocat/test`. This behavior mimics how search works on {% data variables.product.prodname_dotcom %}. + +### Text match metadata + +On GitHub, you can use the context provided by code snippets and highlights in search results. The Search API offers additional metadata that allows you to highlight the matching search terms when displaying search results. + +![code-snippet-highlighting](/assets/images/text-match-search-api.png) + +Requests can opt to receive those text fragments in the response, and every fragment is accompanied by numeric offsets identifying the exact location of each matching search term. + +To get this metadata in your search results, specify the `text-match` media type in your `Accept` header. + +```shell +application/vnd.github.v3.text-match+json +``` + +When you provide the `text-match` media type, you will receive an extra key in the JSON payload called `text_matches` that provides information about the position of your search terms within the text and the `property` that includes the search term. Inside the `text_matches` array, each object includes +the following attributes: + +Name | Description +-----|-----------| +`object_url` | The URL for the resource that contains a string property matching one of the search terms. +`object_type` | The name for the type of resource that exists at the given `object_url`. +`property` | The name of a property of the resource that exists at `object_url`. That property is a string that matches one of the search terms. (In the JSON returned from `object_url`, the full content for the `fragment` will be found in the property with this name.) +`fragment` | A subset of the value of `property`. This is the text fragment that matches one or more of the search terms. +`matches` | An array of one or more search terms that are present in `fragment`. The indices (i.e., "offsets") are relative to the fragment. (They are not relative to the _full_ content of `property`.) + +#### Example + +Using cURL, and the [example issue search](#search-issues-and-pull-requests) above, our API +request would look like this: + +``` shell +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ +'{% data variables.product.api_url_pre %}/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' +``` + +The response will include a `text_matches` array for each search result. In the JSON below, we have two objects in the `text_matches` array. + +The first text match occurred in the `body` property of the issue. We see a fragment of text from the issue body. The search term (`windows`) appears twice within that fragment, and we have the indices for each occurrence. + +The second text match occurred in the `body` property of one of the issue's comments. We have the URL for the issue comment. And of course, we see a fragment of text from the comment body. The search term (`windows`) appears once within that fragment. + +```json +{ + "text_matches": [ + { + "object_url": "https://api.github.com/repositories/215335/issues/132", + "object_type": "Issue", + "property": "body", + "fragment": "comprehensive windows font I know of).\n\nIf we can find a commonly distributed windows font that supports them then no problem (we can use html font tags) but otherwise the '(21)' style is probably better.\n", + "matches": [ + { + "text": "windows", + "indices": [ + 14, + 21 + ] + }, + { + "text": "windows", + "indices": [ + 78, + 85 + ] + } + ] + }, + { + "object_url": "https://api.github.com/repositories/215335/issues/comments/25688", + "object_type": "IssueComment", + "property": "body", + "fragment": " right after that are a bit broken IMHO :). I suppose we could have some hack that maxes out at whatever the font does...\n\nI'll check what the state of play is on Windows.\n", + "matches": [ + { + "text": "Windows", + "indices": [ + 163, + 170 + ] + } + ] + } + ] +} +``` diff --git a/translations/ja-JP/content/rest/secret-scanning.md b/translations/ja-JP/content/rest/secret-scanning.md new file mode 100644 index 0000000000..fad846994e --- /dev/null +++ b/translations/ja-JP/content/rest/secret-scanning.md @@ -0,0 +1,23 @@ +--- +title: Secret Scanning +intro: 'Use the Secret Scanning API to retrieve and update secret alerts from a repository.' +versions: + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/secret-scanning +--- + +{% data reusables.secret-scanning.api-beta %} + +The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae %}: + +- Enable or disable {% data variables.product.prodname_secret_scanning %}{% if secret-scanning-push-protection %} and push protection{% endif %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" and expand the "Properties of the `security_and_analysis` object" section in the REST API documentation. +- Retrieve and update {% data variables.product.prodname_secret_scanning_GHAS %} alerts from a repository. For further details, see the sections below. +{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a repository.{% endif %} + +For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." diff --git a/translations/ja-JP/content/rest/teams/discussion-comments.md b/translations/ja-JP/content/rest/teams/discussion-comments.md new file mode 100644 index 0000000000..0dde5647e0 --- /dev/null +++ b/translations/ja-JP/content/rest/teams/discussion-comments.md @@ -0,0 +1,14 @@ +--- +title: Discussion Comments +intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/teams/discussions.md b/translations/ja-JP/content/rest/teams/discussions.md new file mode 100644 index 0000000000..1a6cc51805 --- /dev/null +++ b/translations/ja-JP/content/rest/teams/discussions.md @@ -0,0 +1,14 @@ +--- +title: Discussions +intro: "The Team Discussions API allows you to get, create, edit, and delete discussion posts on a team's page." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/teams/external-groups.md b/translations/ja-JP/content/rest/teams/external-groups.md new file mode 100644 index 0000000000..ab172bd084 --- /dev/null +++ b/translations/ja-JP/content/rest/teams/external-groups.md @@ -0,0 +1,24 @@ +--- +title: External Groups +intro: 'The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.' +versions: + fpt: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. + +{% ifversion ghec %} +{% note %} + +**Notes:** + +- The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." +- If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/teams/index.md b/translations/ja-JP/content/rest/teams/index.md new file mode 100644 index 0000000000..fc2c3a44cb --- /dev/null +++ b/translations/ja-JP/content/rest/teams/index.md @@ -0,0 +1,22 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your {% data variables.product.product_name %} organization.' +redirect_from: + - /v3/teams + - /rest/reference/teams +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /teams + - /discussion-comments + - /discussions + - /external-groups + - /members + - /team-sync +--- diff --git a/translations/ja-JP/content/rest/teams/members.md b/translations/ja-JP/content/rest/teams/members.md new file mode 100644 index 0000000000..fdcee06601 --- /dev/null +++ b/translations/ja-JP/content/rest/teams/members.md @@ -0,0 +1,23 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + +{% ifversion fpt or ghes or ghec %} +{% note %} + +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% endnote %} + +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/teams/team-sync.md b/translations/ja-JP/content/rest/teams/team-sync.md new file mode 100644 index 0000000000..3b6dfa15dd --- /dev/null +++ b/translations/ja-JP/content/rest/teams/team-sync.md @@ -0,0 +1,21 @@ +--- +title: Team Synchronization +intro: 'The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." + +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% note %} + +**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/teams/teams.md b/translations/ja-JP/content/rest/teams/teams.md new file mode 100644 index 0000000000..fa741a215e --- /dev/null +++ b/translations/ja-JP/content/rest/teams/teams.md @@ -0,0 +1,14 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your GitHub organization.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. diff --git a/translations/ja-JP/content/rest/users/blocking.md b/translations/ja-JP/content/rest/users/blocking.md new file mode 100644 index 0000000000..297347554f --- /dev/null +++ b/translations/ja-JP/content/rest/users/blocking.md @@ -0,0 +1,11 @@ +--- +title: Blocking Users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/users/emails.md b/translations/ja-JP/content/rest/users/emails.md new file mode 100644 index 0000000000..1526e6e0a6 --- /dev/null +++ b/translations/ja-JP/content/rest/users/emails.md @@ -0,0 +1,13 @@ +--- +title: Emails +intro: '' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Management of email addresses via the API requires that you authenticate through basic auth, or through OAuth with a correct scope for the endpoint. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/users/followers.md b/translations/ja-JP/content/rest/users/followers.md new file mode 100644 index 0000000000..b93b9303cd --- /dev/null +++ b/translations/ja-JP/content/rest/users/followers.md @@ -0,0 +1,12 @@ +--- +title: Followers +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/ja-JP/content/rest/users/gpg-keys.md b/translations/ja-JP/content/rest/users/gpg-keys.md new file mode 100644 index 0000000000..8cc12ab55d --- /dev/null +++ b/translations/ja-JP/content/rest/users/gpg-keys.md @@ -0,0 +1,14 @@ +--- +title: GPG Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The data returned in the `public_key` response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what is returned by the APIs on this page. This key is not suitable to be used directly by programs like GPG. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/users/index.md b/translations/ja-JP/content/rest/users/index.md new file mode 100644 index 0000000000..22145785f5 --- /dev/null +++ b/translations/ja-JP/content/rest/users/index.md @@ -0,0 +1,22 @@ +--- +title: Users +intro: The Users API allows to get public and private information about the authenticated user. +redirect_from: + - /v3/users + - /rest/reference/users +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /users + - /blocking + - /emails + - /followers + - /gpg-keys + - /keys +--- diff --git a/translations/ja-JP/content/rest/users/keys.md b/translations/ja-JP/content/rest/users/keys.md new file mode 100644 index 0000000000..ac61f9554f --- /dev/null +++ b/translations/ja-JP/content/rest/users/keys.md @@ -0,0 +1,13 @@ +--- +title: Git SSH Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/translations/ja-JP/content/rest/users/users.md b/translations/ja-JP/content/rest/users/users.md new file mode 100644 index 0000000000..e299587e74 --- /dev/null +++ b/translations/ja-JP/content/rest/users/users.md @@ -0,0 +1,14 @@ +--- +title: Users +intro: 'The Users API allows to get public and private information about the authenticated user.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a `{username}` parameter then the response will be for the logged in user (and you must pass [authentication information](/rest/overview/resources-in-the-rest-api#authentication) with your request).{% ifversion fpt or ghes or ghec %} Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the `user` scope.{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/content/rest/webhooks/index.md b/translations/ja-JP/content/rest/webhooks/index.md new file mode 100644 index 0000000000..fb833f3c0b --- /dev/null +++ b/translations/ja-JP/content/rest/webhooks/index.md @@ -0,0 +1,79 @@ +--- +title: Webhooks +intro: The webhooks API allows you to create and manage webhooks for your repositories. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /repo-config + - /repo-deliveries + - /repos +redirect_from: + - /rest/reference/webhooks +--- + +Repository webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in a repository. {% data reusables.webhooks.webhooks-rest-api-links %} + +If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks). + +In addition to the REST API, {% data variables.product.prodname_dotcom %} can also serve as a [PubSubHubbub](#pubsubhubbub) hub for repositories. + +## Receiving Webhooks + +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +### Webhook headers + +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers) for details. + +## PubSubHubbub + +GitHub can also serve as a [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) hub for all repositories. PSHB is a simple publish/subscribe protocol that lets servers register to receive updates when a topic is updated. The updates are sent with an HTTP POST request to a callback URL. +Topic URLs for a GitHub repository's pushes are in this format: + +`https://github.com/{owner}/{repo}/events/{event}` + +The event can be any available webhook event. For more information, see "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads)." + +### Response format + +The default format is what [existing post-receive hooks should expect](/post-receive-hooks/): A JSON body sent as the `payload` parameter in a POST. You can also specify to receive the raw JSON body with either an `Accept` header, or a `.json` extension. + + Accept: application/json + https://github.com/{owner}/{repo}/events/push.json + +### Callback URLs + +Callback URLs can use the `http://` protocol. + + # Send updates to postbin.org + http://postbin.org/123 + +### Subscribing + +The GitHub PubSubHubbub endpoint is: `{% data variables.product.api_url_code %}/hub`. A successful request with curl looks like: + +``` shell +curl -u "user" -i \ + {% data variables.product.api_url_pre %}/hub \ + -F "hub.mode=subscribe" \ + -F "hub.topic=https://github.com/{owner}/{repo}/events/push" \ + -F "hub.callback=http://postbin.org/123" +``` + +PubSubHubbub requests can be sent multiple times. If the hook already exists, it will be modified according to the request. + +#### Parameters + +Name | Type | Description +-----|------|-------------- +``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. +``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. +``hub.callback``|`string` | The URI to receive the updates to the topic. +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 3.0 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. \ No newline at end of file diff --git a/translations/ja-JP/content/rest/webhooks/repo-config.md b/translations/ja-JP/content/rest/webhooks/repo-config.md new file mode 100644 index 0000000000..5653146886 --- /dev/null +++ b/translations/ja-JP/content/rest/webhooks/repo-config.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Configuration +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/webhooks/repo-deliveries.md b/translations/ja-JP/content/rest/webhooks/repo-deliveries.md new file mode 100644 index 0000000000..ee3f49cc36 --- /dev/null +++ b/translations/ja-JP/content/rest/webhooks/repo-deliveries.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Deliveries +intro: '' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/rest/webhooks/repos.md b/translations/ja-JP/content/rest/webhooks/repos.md new file mode 100644 index 0000000000..51d4dd89a8 --- /dev/null +++ b/translations/ja-JP/content/rest/webhooks/repos.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index bc88d591e8..898e65fe0c 100644 --- a/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -35,6 +35,8 @@ You can sponsor an account on behalf of your personal account to invest in proje クレジットカードを使用してアカウントをスポンサーすると、その変更は直ちに有効になります。 {% data reusables.sponsors.prorated-sponsorship %} +We may share certain limited tax information with sponsored accounts. For more information, see "[Tax information](#tax-information)." + {% data reusables.sponsors.manage-updates-for-orgs %} You can choose whether to display your sponsorship publicly. One-time sponsorships remain visible for one month. @@ -51,6 +53,17 @@ You can choose whether to display your sponsorship publicly. One-time sponsorshi {% endnote %} +## Tax information + +As a sponsor, you acknowledge that we may disclose to the owner of each account you sponsor the following limited information about your sponsorship payments to the account, since the inception of the Sponsors Program: + +- Transaction date +- Amount paid +- The country, state, and province from where payment was made +- Whether payment was made by a business or individual + +This information is necessary to enable payment and reporting of any taxes arising from such sponsorship payments. + ## アカウントをスポンサーする アカウントをスポンサーするには、認証済みメールアドレスが必要です。 詳細は「[メールアドレスを検証する](/github/getting-started-with-github/verifying-your-email-address)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/actions/reusable-workflow-calling-syntax.md b/translations/ja-JP/data/reusables/actions/reusable-workflow-calling-syntax.md index 742ca00b7c..8cb4a60349 100644 --- a/translations/ja-JP/data/reusables/actions/reusable-workflow-calling-syntax.md +++ b/translations/ja-JP/data/reusables/actions/reusable-workflow-calling-syntax.md @@ -1,4 +1,4 @@ -* `{owner}/{repo}/{path}/{filename}@{ref}`{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %} for reusable workflows in public {% ifversion ghes or ghec or ghae %}or internal{% endif %} repositories. -* `./{path}/{filename}` for reusable workflows in the same repository.{% endif %} +* `{owner}/{repo}/.github/workflows/{filename}@{ref}`{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %} for reusable workflows in public {% ifversion ghes or ghec or ghae %}or internal{% endif %} repositories. +* `./.github/workflows/{filename}` for reusable workflows in the same repository.{% endif %} `{ref}` can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security. 詳しい情報については「[GitHub Actionsのためのセキュリティ強化](/actions/learn-github-actions/security-hardening-for-github-actions#reusing-third-party-workflows)」を参照してください。 {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %}If you use the second syntax option (without `{owner}/{repo}` and `@{ref}`) the called workflow is from the same commit as the caller workflow.{% endif %} diff --git a/translations/ja-JP/data/reusables/sponsors/sponsorship-details.md b/translations/ja-JP/data/reusables/sponsors/sponsorship-details.md index cd6368f1c4..8106732d62 100644 --- a/translations/ja-JP/data/reusables/sponsors/sponsorship-details.md +++ b/translations/ja-JP/data/reusables/sponsors/sponsorship-details.md @@ -1 +1 @@ -You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your personal account or an organization. スポンサードアカウントが設定した1回あるいは月次の支払い額やメリットを持つ複数のスポンサーシップ層から選択することができます。 スポンサーシップは、既存の支払日、支払い方法、領収書を共有します。 +You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your personal account or an organization. スポンサードアカウントが設定した1回あるいは月次の支払い額やメリットを持つ複数のスポンサーシップ層から選択することができます。 Your sponsorship will share your account’s existing billing date, payment method, and receipt. diff --git a/translations/log/cn-resets.csv b/translations/log/cn-resets.csv index 57e3e5adcd..78bb8b9dc7 100644 --- a/translations/log/cn-resets.csv +++ b/translations/log/cn-resets.csv @@ -45,6 +45,7 @@ translations/zh-CN/content/admin/configuration/configuring-your-enterprise/confi translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-github-pages-for-your-enterprise.md,broken liquid tags translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,broken liquid tags translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-the-referrer-policy-for-your-enterprise.md,broken liquid tags +translations/zh-CN/content/admin/configuration/configuring-your-enterprise/deploying-github-ae.md,broken liquid tags translations/zh-CN/content/admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise.md,broken liquid tags translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md,broken liquid tags translations/zh-CN/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources.md,broken liquid tags @@ -148,6 +149,7 @@ translations/zh-CN/content/code-security/dependabot/dependabot-alerts/about-depe translations/zh-CN/content/code-security/dependabot/dependabot-alerts/browsing-security-vulnerabilities-in-the-github-advisory-database.md,broken liquid tags translations/zh-CN/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md,broken liquid tags translations/zh-CN/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md,broken liquid tags +translations/zh-CN/content/code-security/dependabot/index.md,broken liquid tags translations/zh-CN/content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md,broken liquid tags translations/zh-CN/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md,broken liquid tags translations/zh-CN/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md,broken liquid tags @@ -309,7 +311,7 @@ translations/zh-CN/data/reusables/rest-reference/activity/events.md,broken liqui translations/zh-CN/data/reusables/rest-reference/apps/marketplace.md,broken liquid tags translations/zh-CN/data/reusables/rest-reference/packages/packages.md,broken liquid tags translations/zh-CN/data/reusables/saml/you-must-periodically-authenticate.md,Listed in localization-support#489 -translations/zh-CN/data/reusables/saml/you-must-periodically-authenticate.md,broken liquid tags +translations/zh-CN/data/reusables/saml/you-must-periodically-authenticate.md,rendering error translations/zh-CN/data/reusables/scim/after-you-configure-saml.md,broken liquid tags translations/zh-CN/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md,broken liquid tags translations/zh-CN/data/reusables/sponsors/feedback.md,broken liquid tags diff --git a/translations/pt-BR/content/account-and-profile/index.md b/translations/pt-BR/content/account-and-profile/index.md index c0b9c67ed6..1804f7f0ff 100644 --- a/translations/pt-BR/content/account-and-profile/index.md +++ b/translations/pt-BR/content/account-and-profile/index.md @@ -1,7 +1,7 @@ --- title: Sua conta e seu perfil no GitHub shortTitle: Conta e perfil -intro: 'Make {% data variables.product.product_name %} work best for you by adjusting the settings for your personal account, personalizing your profile page, and managing the notifications you receive for activity on {% data variables.product.prodname_dotcom %}.' +intro: 'Faça {% data variables.product.product_name %} funcionar melhor para você, ajustando as configurações para sua conta pessoal, personalizando a página do seu perfil e gerenciando as notificações que você recebe para atividades em {% data variables.product.prodname_dotcom %}.' introLinks: quickstart: /get-started/onboarding/getting-started-with-your-github-account featuredLinks: diff --git a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md index 79a5e28761..593ee2be40 100644 --- a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md +++ b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md @@ -44,7 +44,7 @@ Em geral, você é automaticamente inscrito em conversas por padrão quando voc - Alteração do estado de uma thread, como por exemplo, fechando um problema ou mesclando uma pull request. - Uma @menção a uma equipe da qual você é integrante -By default, you also automatically watch all repositories that you create and are owned by your personal account. +Por padrão, você também observa automaticamente todos os repositórios que você cria e que são pertencentes à sua conta pessoal. Para cancelar a inscrição de conversas que você se inscreveu automaticamente, você pode alterar suas configurações de notificação ou cancelar diretamente a inscrição ou desmarcar a atividade em {% data variables.product.product_location %}. Para obter mais informações, consulte "[Gerenciando suas assinaturas](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md index 61f431abe3..f2e7408d74 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md @@ -16,9 +16,13 @@ topics: shortTitle: Perfil da organização --- -Opcionalmente, é possível escolher adicionar uma descrição, localização, site e endereço de e-mail da sua organização e fixar repositórios importantes.{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4749 %} Você pode personalizar o perfil da sua organização adicionando um arquivo README.md. Para obter mais informações, consulte "[Personalizando o perfil da sua organização](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %} +You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4749 %} You can customize your organization's public profile by adding a README.md file. Para obter mais informações, consulte "[Personalizando o perfil da sua organização](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %} -{% ifversion fpt or ghec %}Para confirmar a identidade da organização e exibir um selo "Verificado" na página do perfil da organização, você deve verificar os domínios da organização com o {% data variables.product.product_name %}. Para obter mais informações, consulte "[Verificar ou aprovar um domínio para a sua organização](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)".{% endif %} +{% ifversion fpt %} +As organizações que usam o {% data variables.product.prodname_ghe_cloud %} podem confirmar a identidade da sua organização e exibir um selo "Verificado" na página de perfil da organização, verificando os domínios da organização com {% data variables.product.product_name %}. Para obter mais informações, consulte "[verificando ou aprovando um domínio para sua organização](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)" na documentação de {% data variables.product.prodname_ghe_cloud %}. +{% elsif ghec or ghes > 3.1 %} +Para confirmar a identidade da sua organização e exibir um selo "Verificado" na página de perfil da organização, você pode verificar os domínios da sua organização com {% data variables.product.prodname_dotcom %}. Para obter mais informações, consulte "[Verificar ou aprovar um domínio para a sua organização](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)". +{% endif %} {% ifversion fpt or ghes > 3.2 or ghec %} ![Exemplo de página de perfil da organização](/assets/images/help/organizations/org_profile_with_overview.png) diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/index.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/index.md index b20b27e2ca..55f009e2fe 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/index.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/index.md @@ -1,6 +1,6 @@ --- title: Configurar e gerenciar sua conta de usuário do GitHub -intro: 'You can manage settings in your GitHub personal account including email preferences, collaborator access for personal repositories, and organization memberships.' +intro: 'Você pode gerenciar as configurações na sua conta pessoal do GitHub, incluindo preferências de e-mail, acesso de colaborador para repositórios pessoais e associações de organizações.' shortTitle: Contas pessoais redirect_from: - /categories/setting-up-and-managing-your-github-user-account diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md index 5d418f2d50..1a545e7e0e 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md @@ -55,7 +55,7 @@ Se você for integrante de um {% data variables.product.prodname_emu_enterprise ## Leia mais -- "[Permission levels for a personal account repository](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-personal-account)" +- "[Níveis de permissão para o repositório de uma conta pessoal](/articles/permission-levels-for-a-user-account-repository/#collaborator-access-for-a-repository-owned-by-a-personal-account)" - "[Remover um colaborador de um repositório pessoal](/articles/removing-a-collaborator-from-a-personal-repository)" - "[Remover a si mesmo de um repositório de colaborador](/articles/removing-yourself-from-a-collaborator-s-repository)" - "[Organizar integrantes em equipes](/organizations/organizing-members-into-teams)" diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address.md index 4b394e29e2..a81525e47b 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address.md @@ -1,6 +1,6 @@ --- title: Alterar endereço de e-mail principal -intro: You can change the email address associated with your personal account at any time. +intro: Você pode alterar o endereço de e-mail associado à sua conta pessoal a qualquer momento. redirect_from: - /articles/changing-your-primary-email-address - /github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email.md index 91e9a48d19..f2a2eb4c76 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email.md @@ -1,6 +1,6 @@ --- title: Lembrar o nome de usuário ou e-mail do GitHub -intro: 'Faz tempo que você não faz login no {% data variables.product.product_location %}? Se sim, bem-vindo de volta! If you can''t remember the username for your personal account on {% data variables.product.product_name %}, you can try these methods for remembering it.' +intro: 'Faz tempo que você não faz login no {% data variables.product.product_location %}? Se sim, bem-vindo de volta! Se você não consegue lembrar o nome de usuário da sua conta pessoal em {% data variables.product.product_name %}, você pode tentar esses métodos para lembrá-lo.' redirect_from: - /articles/oh-noes-i-ve-forgotten-my-username-email - /articles/oh-noes-i-ve-forgotten-my-username-or-email diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company.md index 1c933d75de..68f868df84 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company.md @@ -1,6 +1,6 @@ --- title: Práticas recomendadas para deixar a empresa -intro: 'If you use your account on {% data variables.product.product_name %} for both personal and work purposes, there are a few things to keep in mind when you leave your company or organization.' +intro: 'Se você usar sua conta em {% data variables.product.product_name %} para fins pessoais e de trabalho, há algumas coisas a levar em consideração ao deixar a sua empresa ou organização.' redirect_from: - /articles/best-practices-for-leaving-your-company - /github/setting-up-and-managing-your-github-user-account/best-practices-for-leaving-your-company @@ -13,7 +13,7 @@ topics: shortTitle: Sair da sua empresa --- -Before you leave your company, make sure you update the following information in your personal account: +Antes de deixar da sua empresa, certifique-se de atualizar as seguintes informações na sua conta pessoal: - Anule a confirmação do endereço de e-mail da sua empresa [excluindo-o nas configurações do e-mail](/articles/changing-your-primary-email-address). Você pode adicioná-lo novamente sem verificação para manter os commits associados vinculados à sua conta. - [Altere o seu endereço de e-mail principal](/articles/changing-your-primary-email-address) do e-mail da empresa para seu e-mail pessoal. @@ -28,7 +28,7 @@ Se você esteve trabalhando com repositórios que pertencem a uma organização, ## Remover associações profissionais a repositórios pessoais -If you've been collaborating professionally with another person on repositories that belong to their personal account, you'll want to [remove yourself as a collaborator](/articles/removing-yourself-from-a-collaborator-s-repository) from those repositories. +Se você tiver colaborado profissionalmente com outra pessoa em repositórios que pertencem à sua conta pessoal, você deverá [remover-se como colaborador](/articles/removing-yourself-from-a-collaborator-s-repository) desses repositórios. - [Pare de inspecionar repositórios](https://github.com/watching) relacionados ao seu trabalho. Você não desejará mais receber essas notificações! - [Transfira repositórios que possui](/articles/how-to-transfer-a-repository) e que outras pessoas podem precisar para continuar trabalhando após a sua saída. diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md index 1bf8ed9e37..5f057d5df3 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization.md @@ -6,7 +6,7 @@ redirect_from: - /articles/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization -intro: You can convert your personal account into an organization. Isso permite permissões mais granulares para repositórios que pertencem à organização. +intro: Você pode converter a sua conta pessoal em uma organização. Isso permite permissões mais granulares para repositórios que pertencem à organização. versions: fpt: '*' ghes: '*' @@ -20,29 +20,29 @@ shortTitle: Usuário em uma organização **Aviso**: antes de converter um usuário em uma organização, lembre-se destes pontos: - - You will **no longer** be able to sign into the converted personal account. - - You will **no longer** be able to create or modify gists owned by the converted personal account. + - Você **não poderá mais** efetura login na conta pessoal convertida. + - Você **não poderá mais** criar ou modificar gists pertencentes à conta pessoal convertida. - Uma organização **não pode** ser convertida de volta em um usuário. - - As chaves SSH, os tokens do OAuth, o perfil de trabalho, as reações e as informações do usuário associadas, **não** serão transferidos para a organização. This is only true for the personal account that's being converted, not any of the personal account's collaborators. - - Any commits made with the converted personal account **will no longer be linked** to that account. Os commits em si **permanecerão** intactos. - - Any forks of private repositories made with the converted personal account will be deleted. + - As chaves SSH, os tokens do OAuth, o perfil de trabalho, as reações e as informações do usuário associadas, **não** serão transferidos para a organização. Isso é válido apenas para a conta pessoal que está sendo convertida, não para os colaboradores da conta pessoal. + - Todos os commits criados com a conta pessoal convertida **não serão mais vinculados** a essa conta. Os commits em si **permanecerão** intactos. + - Todas as bifurcações de repositórios privados criadas com a conta pessoal convertida serão excluídas. {% endwarning %} -## Keep your personal account and create a new organization manually +## Mantenha sua conta pessoal e crie uma nova organização manualmente -If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your personal account into an organization. +Se quiser que sua organização tenha o mesmo nome que está usando atualmente na sua conta pessoal ou se quiser manter as informações da sua conta pessoal intactas, você deverá criar uma nova organização e transferir seus repositórios para ela em vez de converter sua conta pessoal em uma organização. -1. To retain your current personal account name for your personal use, [change the name of your personal account](/articles/changing-your-github-username) to something new and wonderful. -2. [Create a new organization](/articles/creating-a-new-organization-from-scratch) with the original name of your personal account. +1. Para manter o seu nome de conta pessoal atual para o seu uso pessoal, [altere o nome da sua conta pessoal](/articles/changing-your-github-username) para algo novo e maravilhoso. +2. [Crie uma nova organização](/articles/creating-a-new-organization-from-scratch) com o nome original da sua conta pessoal. 3. [Transfira os repositórios](/articles/transferring-a-repository) para sua nova conta de organização. ## Converter sua conta pessoal em uma organização automaticamente -You can also convert your personal account directly into an organization. A conversão da conta: +Você também pode converter sua conta pessoal diretamente em uma organização. A conversão da conta: - Preserva os repositórios como estão sem a necessidade de transferi-los para outra conta manualmente - Convida automaticamente colaboradores para equipes com permissões equivalentes às que tinham antes - {% ifversion fpt or ghec %}- For personal accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time{% endif %} + {% ifversion fpt or ghec %}- Para contas pessoais no {% data variables.product.prodname_pro %}, faz a transição da cobrança automaticamente para o [{% data variables.product.prodname_team %} pago](/articles/about-billing-for-github-accounts) sem a necessidade de inserir novamente as informações de pagamento, ajustar o ciclo de cobrança ou pagar em dobro{% endif %} 1. Crie uma conta pessoal, que você usará para entrar no GitHub e acessar a organização e seus repositórios após conversão. 2. [Leave any organizations](/articles/removing-yourself-from-an-organization) the personal account you're converting has joined. @@ -53,11 +53,11 @@ You can also convert your personal account directly into an organization. A conv 7. Na página "Transform your user into an organization" (Transformar usuário em uma organização), em "Choose an organization owner" (Escolher um proprietário da organização), escolha a conta pessoal secundária que você criou na seção anterior ou outro usuário em que confia para gerenciar a organização. ![Página Add organization owner (Adicionar proprietário da organização)](/assets/images/help/organizations/organization-add-owner.png) 8. Escolha a assinatura da nova organização e insira as informações de cobrança se solicitado. 9. Clique em **Create Organization** (Criar organização). -10. Sign in to the new personal account you created in step one, then use the context switcher to access your new organization. +10. Efetue o login na nova conta pessoal que você criou na primeira etapa e, em seguida, use o alternador de contexto para acessar sua nova organização. {% tip %} -**Tip**: When you convert a personal account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as *outside collaborators*. Você pode então convidar *colaboradores externos* para se tornarem integrantes da nova organização, se desejar. Para obter mais informações, consulte "[Funções em uma organização](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)". +**Dica**: quando você converte uma conta pessoal em uma organização, os colaboradores nos repositórios que pertencem à conta são adicionados à nova organização como *colaboradores externos*. Você pode então convidar *colaboradores externos* para se tornarem integrantes da nova organização, se desejar. Para obter mais informações, consulte "[Funções em uma organização](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)". {% endtip %} diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md index de6a79a311..93218c1700 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account.md @@ -1,6 +1,6 @@ --- title: Excluir sua conta de usuário -intro: 'You can delete your personal account on {% data variables.product.product_name %} at any time.' +intro: 'Você pode excluir sua conta pessoal em {% data variables.product.product_name %} a qualquer momento.' redirect_from: - /articles/deleting-a-user-account - /articles/deleting-your-user-account @@ -12,14 +12,14 @@ versions: ghec: '*' topics: - Accounts -shortTitle: Delete your personal account +shortTitle: Excluir sua conta pessoal --- -Deleting your personal account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %} Os problemas e as pull requests que você criou e os comentários que você fez nos repositórios pertencentes a outros usuários não serão excluídos. Em vez disso, eles serão associados ao nosso [usuário fantasma](https://github.com/ghost).{% else %}Os problemas e as pull requests que você criou e os comentários que você fez nos repositórios pertencentes a outros usuários não serão excluídos.{% endif %} +A exclusão da sua conta pessoal irá remover todos os repositórios, bifurcações de repositórios privados, wikis, problemas, pull requests e páginas pertencentes à sua conta. {% ifversion fpt or ghec %} Os problemas e as pull requests que você criou e os comentários que você fez nos repositórios pertencentes a outros usuários não serão excluídos. Em vez disso, eles serão associados ao nosso [usuário fantasma](https://github.com/ghost).{% else %}Os problemas e as pull requests que você criou e os comentários que você fez nos repositórios pertencentes a outros usuários não serão excluídos.{% endif %} {% ifversion fpt or ghec %} Ao excluir a sua conta, nós paramos de cobrar você. O endereço de e-mail associado à conta fica disponível para uso com uma conta diferente no {% data variables.product.product_location %}. Após 90 dias, o nome da conta também fica disponível para qualquer pessoa usar em uma nova conta. {% endif %} -If you’re the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your personal account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your personal account. +Se você é o único proprietário de uma organização, você deverá transferir a propriedade para outra pessoa ou excluir a organização antes de excluir a sua conta pessoal. Se houver outros proprietários na organização, você deverá remover-se da organização antes de excluir sua conta pessoal. Para obter mais informações, consulte: - "[Transferir a propriedade da organização](/articles/transferring-organization-ownership)" @@ -28,19 +28,19 @@ Para obter mais informações, consulte: ## Fazer backup dos dados da conta -Before you delete your personal account, make a copy of all repositories, private forks, wikis, issues, and pull requests owned by your account. +Antes de excluir sua conta pessoal, faça uma cópia de todos os repositórios, bifurcações privadas, wikis, problemas e pull requests pertencentes à sua conta. {% warning %} -**Warning:** Once your personal account has been deleted, GitHub cannot restore your content. +**Aviso:** Uma vez que excluída a sua conta pessoal, o GitHub não poderá restaurar seu conteúdo. {% endwarning %} -## Delete your personal account +## Excluir sua conta pessoal {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.account_settings %} -3. Na parte inferior da página Account Settings (Configurações da conta), em "Delete account" (Excluir conta), clique em **Delete your account** (Excluir sua conta). Before you can delete your personal account: +3. Na parte inferior da página Account Settings (Configurações da conta), em "Delete account" (Excluir conta), clique em **Delete your account** (Excluir sua conta). Antes de poder excluir sua conta pessoal: - Se você for o único proprietário da organização, transfira a propriedade para outra pessoa ou exclua sua organização. - Caso haja outros proprietários na organização, remova a si mesmo da organização. ![Botão Account deletion (Exclusão de conta)](/assets/images/help/settings/settings-account-delete.png) 4. Na caixa de diálogo "Make sure you want to do this" (Certifique-se de que você quer fazer isso), conclua as etapas descritas para confirmar que está ciente do que acontecerá quando sua conta for excluída: ![Caixa de diálogo de confirmação Delete account (Excluir conta)](/assets/images/help/settings/settings-account-deleteconfirm.png) diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md index 91b104621e..1815a2918e 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/index.md @@ -30,6 +30,6 @@ children: - /integrating-jira-with-your-personal-projects - /best-practices-for-leaving-your-company - /what-does-the-available-for-hire-checkbox-do -shortTitle: Personal account settings +shortTitle: Configurações de conta pessoal --- diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects.md index 98569db1ab..654780a195 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects.md @@ -1,6 +1,6 @@ --- title: Integrar o Jira com seus projetos pessoais -intro: 'You can integrate Jira Cloud with your personal account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues.' +intro: 'Você pode integrar o Jira Cloud à sua conta pessoal para digitalizar os commits e pull requests, criando metadados relevantes e hiperlinks em qualquer problema mencionado do Jira.' redirect_from: - /articles/integrating-jira-with-your-personal-projects - /github/setting-up-and-managing-your-github-user-account/integrating-jira-with-your-personal-projects diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md index f2bc9ddcf5..4134b3b9c2 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-security-and-analysis-settings-for-your-user-account.md @@ -19,7 +19,7 @@ O {% data variables.product.prodname_dotcom %} pode ajudar a proteger seus repos Você ainda pode gerenciar os recursos de segurança e análise para repositórios individuais. Para obter mais informações, consulte "[Gerenciar configurações de segurança e análise do seu repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)". -You can also review the security log for all activity on your personal account. Para obter mais informações, consulte "[Revisar o log de segurança](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)." +Você também pode rever o registro de segurança de todas as atividades da sua conta pessoal. Para obter mais informações, consulte "[Revisar o log de segurança](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log)." {% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %} diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md index ae2cda06df..3d01382e2c 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference.md @@ -1,6 +1,6 @@ --- title: Gerenciar a preferência de interpretação do tamanho da aba -intro: You can manage the number of spaces a tab is equal to for your personal account. +intro: Você pode gerenciar o número de espaços aos quais uma aba equivale para sua conta pessoal. versions: fpt: '*' ghae: issue-5083 diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md index d304f9523b..b199b20b96 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts.md @@ -12,18 +12,18 @@ versions: ghec: '*' topics: - Accounts -shortTitle: Merge multiple personal accounts +shortTitle: Fazer merge de várias contas pessoais --- {% tip %} {% ifversion ghec %} -**Tip:** {% data variables.product.prodname_emus %} allow an enterprise to provision unique personal accounts for its members through an identity provider (IdP). Para obter mais informações, consulte[Sobre usuários gerenciados pela empresa](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users)". For other use cases, we recommend using only one personal account to manage both personal and professional repositories. +**Dica:** {% data variables.product.prodname_emus %} permite que uma empresa forneça contas pessoais únicas para seus integrantes por meio de um provedor de identidade (IdP). Para obter mais informações, consulte[Sobre usuários gerenciados pela empresa](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users)". Para outros casos de uso, recomendamos usar apenas uma conta pessoal para gerenciar repositórios pessoais e profissionais. {% else %} -**Tip:** We recommend using only one personal account to manage both personal and professional repositories. +**Dica:** Recomendamos usar apenas uma conta pessoal para gerenciar repositórios pessoais e profissionais. {% endif %} diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md index 9ec46c9979..15583bc6b2 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository.md @@ -1,6 +1,6 @@ --- title: Níveis de permissão para um repositório de conta de usuário -intro: 'A repository owned by a personal account has two permission levels: the repository owner and collaborators.' +intro: 'Um repositório pertencente a uma conta pessoal tem dois níveis de permissão: o proprietário e os colaboradores do repositório.' redirect_from: - /articles/permission-levels-for-a-user-account-repository - /github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository @@ -15,19 +15,19 @@ topics: shortTitle: Repositórios de usuário de permissão --- -## About permissions levels for a personal account repository +## Sobre níveis de permissão para o repositório de uma conta pessoal -Repositories owned by personal accounts have one owner. Ownership permissions can't be shared with another personal account. +Os repositórios pertencentes a contas pessoais têm um proprietário. As permissões de propriedade não podem ser compartilhadas com outra conta pessoal. Você também pode {% ifversion fpt or ghec %}convidar{% else %}add{% endif %} usuários em {% data variables.product.product_name %} para o seu repositório como colaboradores. Para obter mais informações, consulte "[Convidar colaboradores para um repositório pessoal](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)". {% tip %} -**Tip:** If you require more granular access to a repository owned by your personal account, consider transferring the repository to an organization. Para obter mais informações, consulte "[Transferir um repositório](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-personal-account)". +**Dica:** Se você precisar de mais acesso granular a um repositório pertencente à sua conta pessoal, considere transferir o repositório para uma organização. Para obter mais informações, consulte "[Transferir um repositório](/github/administering-a-repository/transferring-a-repository#transferring-a-repository-owned-by-your-personal-account)". {% endtip %} -## Owner access for a repository owned by a personal account +## Acesso do proprietário de um repositório pertencente a uma conta pessoal O proprietário do repositório tem controle total do repositório. Além das ações que qualquer colaborador pode executar, o proprietário do repositório pode executar as ações a seguir. @@ -58,13 +58,13 @@ O proprietário do repositório tem controle total do repositório. Além das a {% endif %} | Permitir ou negar merge automático para pull requests | "[Gerenciar merge automático para pull requests no seu repositório](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | -## Collaborator access for a repository owned by a personal account +## Acesso do colaborador a um repositório pertencente a uma conta pessoal Os colaboradores em um repositório pessoal podem extrair (ler) os conteúdos do repositório e fazer push (gravação) das alterações no repositório. {% note %} -**Observação:** Em um repositório privado, proprietários de repositórios podem conceder somente acesso de gravação aos colaboradores. Collaborators can't have read-only access to repositories owned by a personal account. +**Observação:** Em um repositório privado, proprietários de repositórios podem conceder somente acesso de gravação aos colaboradores. Os colaboradores não podem ter acesso somente-leitura a repositórios pertencentes a uma conta pessoal. {% endnote %} diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards.md index d30db93378..35a70e775a 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards.md @@ -1,6 +1,6 @@ --- title: Níveis de permissão em quadros de projeto pertencentes a usuários -intro: 'A project board owned by a personal account has two permission levels: the project board owner and collaborators.' +intro: 'Um quadro de projeto pertencente a uma conta pessoal tem dois níveis de permissão: o proprietário e colaboradores do quadro do projeto.' redirect_from: - /articles/permission-levels-for-user-owned-project-boards - /github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards @@ -17,7 +17,7 @@ shortTitle: Permissão de seções de projetos do usuário ## Visão geral das permissões -There is only one owner of a user-owned project board; this permission cannot be shared with another personal account. Além do proprietário, outras pessoas podem colaborar em quadros de projeto. +Há apenas um proprietário de um quadro de projeto pertencente a um usuário; esta permissão não pode ser compartilhada com outra conta pessoal. Além do proprietário, outras pessoas podem colaborar em quadros de projeto. Existem três níveis de permissões para colaboradores de quadro de projeto: @@ -61,4 +61,4 @@ Você pode alterar a visibilidade do painel do projeto de privado para {% ifvers ## Leia mais - - "[Managing access to your personal account's project boards](/articles/managing-access-to-your-user-account-s-project-boards)" + - "[Gerenciando o acesso aos quadros de projetos da sua conta pessoal](/articles/managing-access-to-your-user-account-s-project-boards)" diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization.md index 1a6b2f7ddc..5087d5022f 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization.md @@ -1,6 +1,6 @@ --- title: Acessar uma organização -intro: 'To access an organization that you''re a member of, you must sign in to your personal account.' +intro: 'Para acessar uma organização da qual você é integrante, você deve entrar na sua conta pessoal.' redirect_from: - /articles/error-cannot-log-in-that-account-is-an-organization - /articles/cannot-log-in-that-account-is-an-organization diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md index cd44acc915..e3d85c86b6 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md @@ -22,7 +22,7 @@ Você pode definir lembretes agendados para solicitações de revisão no nível {% data reusables.reminders.scheduled-reminders-limitations %} -## Creating scheduled reminders for your personal account +## Criando lembretes agendados para sua conta pessoal {% data reusables.user-settings.access_settings %} {% data reusables.reminders.scheduled-reminders %} @@ -37,14 +37,14 @@ Você pode definir lembretes agendados para solicitações de revisão no nível ![Caixa de seleção para habilitar alertas em tempo real](/assets/images/help/settings/scheduled-reminders-real-time-alerts-personal.png) {% data reusables.reminders.create-reminder %} -## Managing scheduled reminders for your personal account +## Gerenciando lembretes agendados para sua conta pessoal {% data reusables.user-settings.access_settings %} {% data reusables.reminders.scheduled-reminders %} 1. Ao lado da organização para a qual você deseja editar lembretes agendados, clique em **Editar**. ![Botão editar lembretes agendados](/assets/images/help/settings/scheduled-reminders-org-choice.png) {% data reusables.reminders.edit-page %} {% data reusables.reminders.update-buttons %} -## Deleting scheduled reminders for your personal account +## Excluindo lembretes agendados para sua conta pessoal {% data reusables.user-settings.access_settings %} {% data reusables.reminders.scheduled-reminders %} 1. Ao lado da organização para a qual você gostaria de excluir lembretes, clique em **Editar**. ![Botão editar lembretes agendados](/assets/images/help/settings/scheduled-reminders-org-choice.png) diff --git a/translations/pt-BR/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md b/translations/pt-BR/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md index 6c711124dd..8ab0e7862a 100644 --- a/translations/pt-BR/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md +++ b/translations/pt-BR/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md @@ -65,7 +65,7 @@ jobs: java-version: '11' distribution: 'adopt' - name: Build with Maven - run: mvn --batch-mode --update-snapshots verify + run: mvn --batch-mode --update-snapshots package ``` Este fluxo de trabalho executa os seguintes passos: diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index f022dd6b30..9e0c0ea0d1 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -114,7 +114,7 @@ O token também inclui reivindicações personalizadas fornecidas por {% data va | Reivindicação | Descrição | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `actor` | The personal account that initiated the workflow run. | +| `actor` | A conta pessoal que iniciou a execução do fluxo de trabalho. | | `base_ref` | O branch de destino do pull request na execução de um fluxo de trabalho. | | `ambiente` | O nome do ambiente usado pelo trabalho. | | `event_name` | Nome do evento que acionou a execução do fluxo de trabalho. | diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 9426b2ff4b..c1e1ea2515 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -28,6 +28,14 @@ You can add self-hosted runners at various levels in the management hierarchy: {% data reusables.actions.self-hosted-runner-architecture %} {% data reusables.actions.runner-app-open-source %} When a new version is released, the runner application automatically updates itself when a job is assigned to the runner, or within a week of release if the runner hasn't been assigned any jobs. +{% ifversion ghes %} +{% note %} + +**Note:** {% data reusables.actions.upgrade-runners-before-upgrade-ghes %} + +{% endnote %} +{% endif %} + {% data reusables.actions.self-hosted-runner-auto-removal %} For more information about installing and using self-hosted runners, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." @@ -45,7 +53,7 @@ For more information about installing and using self-hosted runners, see "[Addin - Use free minutes on your {% data variables.product.prodname_dotcom %} plan, with per-minute rates applied after surpassing the free minutes. **Self-hosted runners:**{% endif %} -- Receive automatic updates for the self-hosted runner application only{% ifversion fpt or ghec or ghes > 3.2 %}, though you may disable automatic updates of the runner. For more information about controlling runner software updates on self-hosted runners, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)."{% else %}.{% endif %} You are responsible for updating the operating system and all other software. +- Receive automatic updates for the self-hosted runner application only{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6143 %}, though you may disable automatic updates of the runner. For more information about controlling runner software updates on self-hosted runners, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)."{% else %}.{% endif %} You are responsible for updating the operating system and all other software. - Can use cloud services or local machines that you already pay for. - Are customizable to your hardware, operating system, software, and security requirements. - Don't need to have a clean instance for every job execution. diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index 6b29bd176f..3c50f77346 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -54,6 +54,8 @@ O serviço {% data variables.product.prodname_actions %} irá cancelar o resgist {% endnote %} +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6143 %} + ## Controlando atualizações de software dos executores em executores auto-hospedados Por padrão, os executores auto-hospedados realizarão automaticamente uma atualização de software sempre que uma nova versão do executor estiver disponível. Se você usar executoresefêmeros em contêineres, isso pode gerar a atualizações de software repetidas quando uma nova versão do executor for lançada. A desabilitação das atualizações automáticas permite que você atualize a versão do executor na imagem do contêiner diretamente no seu próprio agendamento. @@ -76,6 +78,8 @@ Para obter instruções sobre como instalar a versão mais recente do executor, {% endnote %} +{% endif %} + ## Usando webhooks para dimensionamento automático Você pode criar seu próprio ambiente de dimensionamento automático usando cargas recebidas do webhook [`workflow_job`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job). Este webhook está disponível no repositório, organização e níveis corporativos e a carga deste evento contém uma chave de `ação` que corresponde aos estágios do ciclo de vida do trabalho de um fluxo de trabalho. Por exemplo, quando as tarefas estão `queued`, `in_progress` e `completed`. Você deverá criar a sua própria automação de dimensionamento em resposta a estas cargas de webhook. diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md index 6c596084ba..8bc1ed42f1 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -258,3 +258,11 @@ User=runner-user ``` {% endlinux %} + +{% ifversion ghes %} +## Resolving runners that are offline after an upgrade of {% data variables.product.product_location %} + +{% data reusables.actions.upgrade-runners-before-upgrade-ghes %} + +If your runners are offline for this reason, manually update the runners. For more information, see the installation instructions for [the latest release](https://github.com/actions/runner/releases/latest) in the actions/runner repository. +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/running-scripts-before-or-after-a-job.md b/translations/pt-BR/content/actions/hosting-your-own-runners/running-scripts-before-or-after-a-job.md index 3ea17cb8e0..e45a1ef9bc 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/running-scripts-before-or-after-a-job.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/running-scripts-before-or-after-a-job.md @@ -22,8 +22,8 @@ Os scripts personalizados são automaticamente acionados quando uma variável de As linguagens de script a seguir são compatíveis: -- **Bash**: Uses `bash` and can fallback to `sh`. É executado, executando `-e {pathtofile}`. -- **PowerShell**: Uses `pwsh` and can fallback to `powershell`. Executes by running `-command \". '{pathtofile}'\"`. +- **Bash**: Usa `bash` e pode retornar para `sh`. É executado, executando `-e {pathtofile}`. +- **PowerShell**: Usa `pwsh` e pode retornar para `powershell`. Executa `-command \". '{pathtofile}'\"`. ## Escrevendo os scripts diff --git a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md index c205858f4e..a19b168efd 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md @@ -111,7 +111,7 @@ Você pode criar um exemplo de fluxo de trabalho no repositório que aciona auto ``` 1. Faça commit dessas alterações e faça push para o seu repositório do {% data variables.product.prodname_dotcom %}. -Seu novo arquivo de fluxo de trabalho de {% data variables.product.prodname_actions %} agora está instalado no seu repositório e será executado automaticamente toda vez que alguém fizer push de uma alteração no repositório. For details about a workflow's execution history, see "[Viewing the workflow's activity](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-workflows-activity)." +Seu novo arquivo de fluxo de trabalho de {% data variables.product.prodname_actions %} agora está instalado no seu repositório e será executado automaticamente toda vez que alguém fizer push de uma alteração no repositório. Para obter detalhes sobre o histórico de execução de um fluxo de trabalho, consulte "[Visualizando a atividade do fluxo de trabalho](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-workflows-activity)". ## Entender o arquivo de fluxo de trabalho @@ -192,7 +192,7 @@ Define uma tarefa chamada check-bats-version. As chaves secundaári ``` -The uses keyword specifies that this step will run v3 of the actions/checkout action. Esta é uma ação que faz o check-out do seu repositório para o executor, permitindo que você execute scripts ou outras ações com base no seu código (como ferramentas de compilação e teste). Você deve usar a ação de checkout sempre que o fluxo de trabalho for executado no código do repositório. +A palavra-chave usa especifica que esta etapa irá executar v3 da ação actions/checkout. Esta é uma ação que faz o check-out do seu repositório para o executor, permitindo que você execute scripts ou outras ações com base no seu código (como ferramentas de compilação e teste). Você deve usar a ação de checkout sempre que o fluxo de trabalho for executado no código do repositório. diff --git a/translations/pt-BR/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md b/translations/pt-BR/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md index ba5aa85f20..05b66eafea 100644 --- a/translations/pt-BR/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md +++ b/translations/pt-BR/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md @@ -63,7 +63,7 @@ No tutorial, primeiro você vai criar um arquivo de fluxo de trabalho que usa a Sempre que um problema no seu repositório for atribuído, o problema será transferido para a coluna do quadro de projeto especificado. Se o problema não estiver já no quadro de projeto, ele será adicionado ao quadro de projeto. -If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or personal account that have the specified project name and column. Da mesma forma, se o repositório pertencer a uma organização, a ação atuará sobre todos os projetos do seu repositório ou organização que têm o nome e a coluna especificados. +Se o repositório pertencer a um usuário, a ação `alex-page/github-project-automation-plus` atuará em todos os projetos no seu repositório ou conta pessoal que têm o nome e a coluna especificados. Da mesma forma, se o repositório pertencer a uma organização, a ação atuará sobre todos os projetos do seu repositório ou organização que têm o nome e a coluna especificados. Teste seu fluxo de trabalho atribuindo um problema no seu repositório. diff --git a/translations/pt-BR/content/actions/security-guides/security-hardening-for-github-actions.md b/translations/pt-BR/content/actions/security-guides/security-hardening-for-github-actions.md index b02ecbd0a3..a83e79ba93 100644 --- a/translations/pt-BR/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/translations/pt-BR/content/actions/security-guides/security-hardening-for-github-actions.md @@ -256,10 +256,10 @@ Esta lista descreve as abordagens recomendadas para acessar os dados do reposit 3. **Tokens de {% data variables.product.prodname_github_app %}** - {% data variables.product.prodname_github_apps %} podem ser instalados em repositórios selecionados e até mesmo ter permissões granulares nos recursos dentro deles. É possível criar um {% data variables.product.prodname_github_app %} interno na sua organização, instalá-lo nos repositórios os quais você precisa acessar dentro do seu fluxo de trabalho, e autenticar como instalação dentro de seu fluxo de trabalho para acessar esses repositórios. 4. **Tokens de acesso pessoal** - - Você nunca deve usar tokens de acesso pessoais da sua própria conta. These tokens grant access to all repositories within the organizations that you have access to, as well as all personal repositories in your personal account. Isto concede indiretamente amplo acesso a todos os usuários com acesso de gravação do repositório no qual se encontra o fluxo de trabalho. Além disso, se você deixar uma organização mais adiante, os fluxos de trabalho que usam este token falharão imediatamente e a depuração deste problema pode ser difícil. + - Você nunca deve usar tokens de acesso pessoais da sua própria conta. Estes tokens concedem acesso a todos os repositórios nas organizações às quais você tem acesso, bem como a todos os repositórios pessoais na sua conta pessoal. Isto concede indiretamente amplo acesso a todos os usuários com acesso de gravação do repositório no qual se encontra o fluxo de trabalho. Além disso, se você deixar uma organização mais adiante, os fluxos de trabalho que usam este token falharão imediatamente e a depuração deste problema pode ser difícil. - Se um token de acesso pessoal for usado, ele deverá ser gerado para uma nova conta que só tenha acesso aos repositórios específicos necessários para o fluxo de trabalho. Observe que esta abordagem não é escalável e deve ser evitada em detrimento de alternativas, como as chaves de implantação. -5. **SSH keys on a personal account** - - Workflows should never use the SSH keys on a personal account. Semelhante aos tokens de acesso pessoais, eles concedem permissões de leitura/gravação a todos os seus repositórios pessoais, bem como a todos os repositórios aos quais você tem acesso por meio da associação à organização. Isto concede indiretamente amplo acesso a todos os usuários com acesso de gravação do repositório no qual se encontra o fluxo de trabalho. Se você pretende usar uma chave SSH porque você só precisa executar clones ou push do repositório, e não precisar interagir com APIs públicas, você deverá usar chaves de implantação individuais. +5. **Chaves SSH em uma conta pessoal** + - Os fluxos de trabalho nunca devem usar as chaves SSH em uma conta pessoal. Semelhante aos tokens de acesso pessoais, eles concedem permissões de leitura/gravação a todos os seus repositórios pessoais, bem como a todos os repositórios aos quais você tem acesso por meio da associação à organização. Isto concede indiretamente amplo acesso a todos os usuários com acesso de gravação do repositório no qual se encontra o fluxo de trabalho. Se você pretende usar uma chave SSH porque você só precisa executar clones ou push do repositório, e não precisar interagir com APIs públicas, você deverá usar chaves de implantação individuais. ## Fortalecimento para executores auto-hospedados @@ -300,7 +300,7 @@ Se você está usando {% data variables.product.prodname_actions %} para implant ## Auditar eventos de {% data variables.product.prodname_actions %} -Você pode usar o log de auditoria para monitorar tarefas administrativas em uma organização. The audit log records the type of action, when it was run, and which personal account performed the action. +Você pode usar o log de auditoria para monitorar tarefas administrativas em uma organização. O log de auditoria registra o tipo de ação, momento da execução e qual conta pessoal executou a ação. Por exemplo, você pode usar o log de auditoria para acompanhar o evento `org.update_actions_secret`, que controla as alterações nos segredos da organização: ![Entradas do log de auditoria](/assets/images/help/repository/audit-log-entries.png) diff --git a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 95326574a6..a877b5c6af 100644 --- a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -50,7 +50,7 @@ Setting secondary rate limits protects the overall level of service on {% data v 3. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits. {% data reusables.enterprise_management_console.save-settings %} -## Enabling Git rate limits +## Enabling rate limits for Git You can apply Git rate limits per repository network or per user ID. Git rate limits are expressed in concurrent operations per minute, and are adaptive based on the current CPU load. @@ -61,3 +61,44 @@ You can apply Git rate limits per repository network or per user ID. Git rate li 3. Type limits for each repository network or user ID. ![Fields for repository network and user ID limits](/assets/images/enterprise/management-console/example-git-rate-limits.png) {% data reusables.enterprise_management_console.save-settings %} + +{% ifversion ghes > 3.4 %} + +## Configuring rate limits for {% data variables.product.prodname_actions %} + +You can apply a rate limit to {% data variables.product.prodname_actions %} workflow runs. For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %} for enterprises](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)." + +### About rate limits for {% data variables.product.prodname_actions %} + +Your {% data variables.product.product_name %} instance assigns each {% data variables.product.prodname_actions %} workflow job to a runner. If your instance cannot immediately assign a job to an available runner, the job will wait in a queue until a runner is available. If {% data variables.product.prodname_actions %} experiences sustained high load, the queue can back up, and the performance of {% data variables.product.product_location %} may degrade. + +To avoid this performance degradation, you can configure a rate limit for {% data variables.product.prodname_actions %}. This rate limit is expressed in job runs per minute. {% data variables.product.product_name %} calculates and applies the rate limit for the sum total of all job runs on the instance. If runs exceed the rate limit, additional runs will fail instead of entering the queue. The following error will appear in the run's annotations. + +> You've exceeded the rate limit for workflow run requests. Please wait before retrying the run. + +An appropriate rate limit protects {% data variables.product.product_location %} from abnormal usage of {% data variables.product.prodname_actions %} without interfering with day-to-day operations. The exact threshold depends on your instance's available resources and overall load profile. For more information about the hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-requirements)." + +By default, the rate limit for {% data variables.product.prodname_actions %} is disabled. Because {% data variables.product.product_name %} can handle temporary spikes in usage without performance degradation, this rate limit is intended to protect against sustained high load. We recommend leaving the rate limit disabled unless you are experiencing performance problems. In some cases, {% data variables.contact.github_support %} may recommend that you enable a rate limit for {% data variables.product.prodname_actions %}. + +### Enabling or disabling rate limits for {% data variables.product.prodname_actions %} + +{% data reusables.enterprise_installation.ssh-into-instance %} +1. To enable and configure the rate limit, run the following two commands, replacing **RUNS-PER-MINUTE** with the value of your choice. + + ```shell + ghe-config actions-rate-limiting.enabled true + ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE + ``` +1. To disable the rate limit after it's been enabled, run the following command. + + ``` + ghe-config actions-rate-limiting.enabled false + ``` +1. To apply the configuration, run the following command. + + ``` + ghe-config-apply + ``` +1. Wait for the configuration run to complete. + +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index 7027803b07..555945ae10 100644 --- a/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -28,12 +28,13 @@ shortTitle: Atualizando GHES ## Preparar para a atualização 1. Determine uma estratégia de atualização e escolha uma versão para atualizar. Para obter mais informações, consulte "[Requisitos de atualização](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrade-requirements/)" e consulte o [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) para encontrar o caminho de atualização da sua versão atual. -3. Crie um backup da instância primária usando o {% data variables.product.prodname_enterprise_backup_utilities %}. Para obter mais informações, consulte o [Arquivo README.md do {% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils#readme). -4. Se você estiver atualizando com um pacote de atualização, programe um período de manutenção para os usuários finais do {% data variables.product.prodname_ghe_server %}. Se estiver usando um hotpatch, não será necessário recorrer ao modo de manutenção. +1. Crie um backup da instância primária usando o {% data variables.product.prodname_enterprise_backup_utilities %}. Para obter mais informações, consulte o [Arquivo README.md do {% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils#readme). +1. If {% data variables.product.product_location %} uses ephemeral self-hosted runners for {% data variables.product.prodname_actions %} and you've disabled automatic updates, upgrade your runners to the version of the runner application that your upgraded instance will run. +1. Se você estiver atualizando com um pacote de atualização, programe um período de manutenção para os usuários finais do {% data variables.product.prodname_ghe_server %}. Se estiver usando um hotpatch, não será necessário recorrer ao modo de manutenção. {% note %} - **Observação:** o período de manutenção depende do tipo de atualização a ser feita. Atualizações com hotpatch normalmente não exigem período de manutenção. É preciso reinicializar a instância em alguns casos, mas o processo pode ser feito em outro momento. Seguindo o esquema de versões do MAJOR.FEATURE.PATCH, as versões de patch que usam pacote de atualização costumam gerar menos de cinco minutos de tempo de inatividade. Versões de recursos que incluem migrações de dados levam mais tempo, dependendo do desempenho do armazenamento e da quantidade de dados migrados. Para obter mais informações, consulte "[Habilitar e programar o modo de manutenção](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)". + **Observação:** o período de manutenção depende do tipo de atualização a ser feita. Atualizações com hotpatch costumam não exigir período de manutenção. É preciso reinicializar a instância em alguns casos, mas o processo pode ser feito em outro momento. Seguindo o esquema de versões do MAJOR.FEATURE.PATCH, as versões de patch que usam pacote de atualização costumam gerar menos de cinco minutos de tempo de inatividade. Versões de recursos que incluem migrações de dados levam mais tempo, dependendo do desempenho do armazenamento e da quantidade de dados migrados. Para obter mais informações, consulte "[Habilitar e programar o modo de manutenção](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)". {% endnote %} diff --git a/translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md b/translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md index f8bbbb7922..7e7d8a72aa 100644 --- a/translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server.md @@ -95,6 +95,12 @@ Para obter mais informações sobre os requisitos mínimos de hardware para {% d {% data reusables.enterprise_installation.about-adjusting-resources %} +{% ifversion ghes > 3.4 %} + +Optionally, you can limit resource consumption on {% data variables.product.product_location %} by configuring a rate limit for {% data variables.product.prodname_actions %}. Para obter mais informações, consulte "[Configurar limites de taxa](/admin/configuration/configuring-your-enterprise/configuring-rate-limits#configuring-rate-limits-for-github-actions)". + +{% endif %} + ## Requisitos de armazenamento externo Para habilitar o {% data variables.product.prodname_actions %} em {% data variables.product.prodname_ghe_server %}, você deve ter acesso ao armazenamento externo do blob. diff --git a/translations/pt-BR/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md b/translations/pt-BR/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md index c58199d918..2eb2f101fe 100644 --- a/translations/pt-BR/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md +++ b/translations/pt-BR/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md @@ -30,7 +30,7 @@ shortTitle: Instalar no Hyper-V {% data reusables.enterprise_installation.download-license %} {% data reusables.enterprise_installation.download-appliance %} -4. Under "{% data variables.product.prodname_dotcom %} On-premises", select the "Select your hypervisor" dropdown menu and click **Hyper-V (VHD)**. +4. Em "{% data variables.product.prodname_dotcom %} no local", selecione o menu suspenso "Selecione seu hipervisor" e clique em **Hyper-V (VHD)**. 5. Clique em **Download for Hyper-V** (Baixar para Hyper-V). ## Criar a instância do {% data variables.product.prodname_ghe_server %} diff --git a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md index 2c8a4e192b..cc1509b751 100644 --- a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md +++ b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @@ -105,16 +105,16 @@ topics: {%- endif %} | `business.members_can_update_protected_branches.clear` | Um proprietário de uma empresa{% ifversion ghes %} ou administrador de site{% endif %} cancelou a política de os integrantes de uma empresa poderem atualizar branches protegidos nos repositórios para organizações individuais. Os administradores da organização podem escolher se permitem a atualização das configurações dos branches protegidos. | `business.members_can_update_protected_branches.disable` | A capacidade para os integrantes corporativos de atualizar as regras de proteção do branch foi desabilitada. Apenas os proprietários corporativos podem atualizar branches protegidos. | `business.members_can_update_protected_branches.enable` | A capaccidade de os integrantes da empresa de atualizar as regras de proteção de brenches foi habilitada. Os proprietários e integrantes da empresa podem atualizar branches protegidos. | `business.remove_admin` | O proprietário de uma empresa{% ifversion ghes %} ou administrador de site{% endif %} foi removido de uma empresa. {%- ifversion ghes > 3.1 %} -| `business.referrer_override_enable` | O proprietário de uma empresa ou administrador de site habilitou a substituição da política de indicador. Para obter mais informações, consulte "[Configurando a política de indicação para sua empresa](/admin/configuration/configuring-your-enterprise/configuring-the-referrer-policy-for-your-enterprise)". | `business.referrer_override_disable` | An enterprise owner or site administrator disabled the referrer policy override. Para obter mais informações, consulte "[Configurando a política de indicação para sua empresa](/admin/configuration/configuring-your-enterprise/configuring-the-referrer-policy-for-your-enterprise)". +| `business.referrer_override_enable` | O proprietário de uma empresa ou administrador de site habilitou a substituição da política de indicador. Para obter mais informações, consulte "[Configurando a política de indicação para sua empresa](/admin/configuration/configuring-your-enterprise/configuring-the-referrer-policy-for-your-enterprise)". | `business.referrer_override_disable` | O proprietário de uma empresa ou administrador de site desabilitou a substituição da política de indicação. Para obter mais informações, consulte "[Configurando a política de indicação para sua empresa](/admin/configuration/configuring-your-enterprise/configuring-the-referrer-policy-for-your-enterprise)". {%- endif %} {%- ifversion ghec %} -| `business.remove_billing_manager` | A billing manager was removed from an enterprise. | `business.remove_member` | A member was removed from an enterprise. +| `business.remove_billing_manager` | Um gerente de cobrança foi removido de uma empresa. | `business.remove_member` | Um integrante foi removido de uma empresa. {%- endif %} | `business.remove_organization` | Uma organização foi removida de uma empresa. {%- ifversion ghec %} | `business.remove_support_entitlee` | O direito de um suporte foi removido do integrante de uma empresa. Para obter mais informações, consulte "[Gerenciar direitos de suporte para a sua empresa](/admin/user-management/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise)". {%- endif %} -| `business.rename_slug` | The slug for the enterprise URL was renamed. +| `business.rename_slug` | O slug do URL da empresa foi renomeado. {%- ifversion ghec %} | `business.revoke_external_identity` | A identidade externa de um membro de uma empresa foi revogada. | `business.revoke_sso_session` | A sessão do logon único SAML para o membro de uma empresa foi revogada. {%- endif %} @@ -126,66 +126,66 @@ topics: | `business.set_fork_pr_workflows_policy` | A política para os fluxos de trabalho nas bifurcações de repositórios privados foi alterada. Para obter mais informações, consulte "{% ifversion ghec %}[Aplicando políticas para {% data variables.product.prodname_actions %} em uma empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-private-repositories){% else ifversion ghes > 2.22 %}[Habilitando fluxos de trabalho para bifurcações do repositório privado](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enforcing-github-actions-policies-for-your-enterprise#enabling-workflows-for-private-repository-forks){% endif %}". {%- endif %} {%- ifversion ghes %} -| `business.update_actions_settings` | An enterprise owner or site administrator updated {% data variables.product.prodname_actions %} policy settings for an enterprise. Para obter mais informações, consulte "[Aplicando as políticas para o GitHub Actions na sua empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)". +| `business.update_actions_settings` | O proprietário de uma empresa ou administrador de site atualizou as configurações da política de {% data variables.product.prodname_actions %} para uma empresa. Para obter mais informações, consulte "[Aplicando as políticas para o GitHub Actions na sua empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)". {%- endif %} -| `business.update_default_repository_permission` | The base repository permission setting was updated for all organizations in an enterprise. Para obter mais informações, consulte "[Aplicando uma política para as permissões do repositório base](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-base-repository-permissions)". | `business.update_member_repository_creation_permission` | The repository creation setting was updated for an enterprise. For more information, see "[Enforcing a policy for repository creation](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-creation)." | `business.update_member_repository_invitation_permission` | The policy setting for enterprise members inviting outside collaborators to repositories was updated. For more information, see "[Enforcing a policy for inviting outside collaborators to repositories](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." +| `business.update_default_repository_permission` | A configuração de permissão do repositório de base foi atualizada para todas as organizações em uma empresa. Para obter mais informações, consulte "[Aplicando uma política para as permissões do repositório base](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-base-repository-permissions)". | `business.update_member_repository_creation_permission` | A configuração da criação do repositório foi atualizada para uma empresa. Para obter mais informações, consulte "[Aplicando uma política para a criação de repositório](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-repository-creation)". | `business.update_member_repository_invitation_permission` | A configuração da política para os integrantes da empresa que convidam colaboradores externos foi atualizada. Para obter mais informações, consulte "[Aplicando uma política para convidar colaboradores externos para os repositórios](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)". {%- ifversion ghec %} -| `business.update_saml_provider_settings` | The SAML single sign-on provider settings for an enterprise were updated. +| `business.update_saml_provider_settings` | As configurações do fornecedor do logon único SAML de uma empresa foram alteradas. {%- endif %} {%- if secret-scanning-audit-log-custom-patterns %} -### `business_secret_scanning_custom_pattern` category actions +### Categoria de ações `business_secret_scanning_custom_pattern` -| Ação | Descrição | -| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| | `business_secret_scanning_custom_pattern.create` | An enterprise-level custom pattern is published for secret scanning. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account)." | -| | `business_secret_scanning_custom_pattern.delete` | An enterprise-level custom pattern is removed from secret scanning. | -| | `business_secret_scanning_custom_pattern.update` | Changes to an enterprise-level custom pattern are saved for secret scanning. | +| Ação | Descrição | +| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| | `business_secret_scanning_custom_pattern.create` | Um padrão personalizado no nível de uma empresa foi publicado para digitalização de segredo. Para obter mais informações, consulte "[Definindo padrões personalizados para digitalização de segredo](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-enterprise-account). " | +| | `business_secret_scanning_custom_pattern.delete` | Um padrão personalizado no nível da empresa foi removido da digitalização de segredo. | +| | `business_secret_scanning_custom_pattern.update` | As alterações no padrão personalizado no nível da empresa foram salvas para a digitalização de segredo. | {%- endif %} -### `checks` category actions +### Ações da categoria `checks` -| Ação | Descrição | -| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `checks.auto_trigger_disabled` | Automatic creation of check suites was disabled on a repository in the organization or enterprise. For more information, see "[Update repository preferences for check suites](/rest/reference/checks#update-repository-preferences-for-check-suites)." | -| `checks.auto_trigger_enabled` | Automatic creation of check suites was enabled on a repository in the organization or enterprise. For more information, see "[Update repository preferences for check suites](/rest/reference/checks#update-repository-preferences-for-check-suites)." | +| Ação | Descrição | +| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `checks.auto_trigger_disabled` | A criação automática de conjuntos de verificação foi desabilitada em um repositório na organização ou empresa. Para obter mais informações, consulte "[Atualize as preferências do repositóriopara verificar os itens](/rest/reference/checks#update-repository-preferences-for-check-suites)". | +| `checks.auto_trigger_enabled` | A criação automática de conjuntos de verificação foi habilitada em um repositório na organização ou empresa. Para obter mais informações, consulte "[Atualize as preferências do repositóriopara verificar os itens](/rest/reference/checks#update-repository-preferences-for-check-suites)". | {%- ifversion fpt or ghec %} -| `checks.delete_logs` | Logs in a check suite were deleted. +| `checks.delete_logs` | Os registros em um conjunto de verificação foram excluídos. {%- endif %} {%- ifversion fpt or ghec %} ### ações da categoria `codespaces` -| Ação | Descrição | -| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `codespaces.connect` | A codespace was started. | -| `codespaces.create` | A user [created a codespace](/github/developing-online-with-codespaces/creating-a-codespace). | -| `codespaces.destroy` | A user [deleted a codespace](/github/developing-online-with-codespaces/deleting-a-codespace). | -| `codespaces.allow_permissions` | A codespace using custom permissions from its `devcontainer.json` file was launched. | -| `codespaces.attempted_to_create_from_prebuild` | An attempt to create a codespace from a prebuild was made. | -| `codespaces.create_an_org_secret` | A user created an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces) | -| `codespaces.update_an_org_secret` | A user updated an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces). | -| `codespaces.remove_an_org_secret` | A user removed an organization-level [secret for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces). | -| `codespaces.manage_access_and_security` | A user updated [which repositories a codespace can access](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | +| Ação | Descrição | +| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `codespaces.connect` | Um codespace foi iniciado. | +| `codespaces.create` | Um usuário [criou um codespace](/github/developing-online-with-codespaces/creating-a-codespace). | +| `codespaces.destroy` | Um usuário [excluiu um codespace](/github/developing-online-with-codespaces/deleting-a-codespace). | +| `codespaces.allow_permissions` | Um codespace que usa permissões personalizadas do seu arquivo `devcontainer.json` foi iniciado. | +| `codespaces.attempted_to_create_from_prebuild` | Foi realizada uma tentativa de criar um codespace a partir de uma pré-criação. | +| `codespaces.create_an_org_secret` | Um usuário criou um [segredo no nível da organização para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces) | +| `codespaces.update_an_org_secret` | Um usuário atualizou um [segredo no nível da organização para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces). | +| `codespaces.remove_an_org_secret` | Um usuário removeu um [segredo do nível da organização para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces#about-encrypted-secrets-for-codespaces). | +| `codespaces.manage_access_and_security` | Um usuário atualizou [quais repositórios um codespace pode acessar](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | {%- endif %} {%- ifversion fpt or ghec %} -### `commit_comment` category actions +### Ações da categoria `commit_comment` -| Ação | Descrição | -| ------------------------ | ----------------------------- | -| `commit_comment.destroy` | A commit comment was deleted. | -| `commit_comment.update` | A commit comment was updated. | +| Ação | Descrição | +| ------------------------ | --------------------------------------- | +| `commit_comment.destroy` | Um comentário de commit foi excluído. | +| `commit_comment.update` | Um comentário de commit foi atualizado. | {%- endif %} {%- ifversion ghes %} -### `config_entry` category actions +### Ações da categoria `config_entry` -| Ação | Descrição | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `config_entry.create` | A configuration setting was created. These events are only visible in the site admin audit log. The type of events recorded relate to:
    - Enterprise settings and policies
    - Organization and repository permissions and settings
    - Git, Git LFS, {% data variables.product.prodname_github_connect %}, {% data variables.product.prodname_registry %}, project, and code security settings. | -| `config_entry.destroy` | A configuration setting was deleted. These events are only visible in the site admin audit log. The type of events recorded relate to:
    - Enterprise settings and policies
    - Organization and repository permissions and settings
    - Git, Git LFS, {% data variables.product.prodname_github_connect %}, {% data variables.product.prodname_registry %}, project, and code security settings. | -| `config_entry.update` | A configuration setting was edited. These events are only visible in the site admin audit log. The type of events recorded relate to:
    - Enterprise settings and policies
    - Organization and repository permissions and settings
    - Git, Git LFS, {% data variables.product.prodname_github_connect %}, {% data variables.product.prodname_registry %}, project, and code security settings. | +| Ação | Descrição | +| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `config_entry.create` | A definição de uma configuração foi criada. Esses eventos só são visíveis no log de auditoria do administrador do site. O tipo de eventos registrados relaciona-se a:
    - Configurações e políticas corporativas
    - Permissões da organização e do repositório
    - Git, LFS do Git, {% data variables.product.prodname_github_connect %}, {% data variables.product.prodname_registry %}, projeto, e configurações de segurança do código. | +| `config_entry.destroy` | A definição de uma configuração foi excluída. Esses eventos só são visíveis no log de auditoria do administrador do site. O tipo de eventos registrados relaciona-se a:
    - Configurações e políticas corporativas
    - Permissões da organização e do repositório
    - Git, LFS do Git, {% data variables.product.prodname_github_connect %}, {% data variables.product.prodname_registry %}, projeto, e configurações de segurança do código. | +| `config_entry.update` | A definição de uma configuração foi editada. Esses eventos só são visíveis no log de auditoria do administrador do site. O tipo de eventos registrados relaciona-se a:
    - Configurações e políticas corporativas
    - Permissões da organização e do repositório
    - Git, LFS do Git, {% data variables.product.prodname_github_connect %}, {% data variables.product.prodname_registry %}, projeto, e configurações de segurança do código. | {%- endif %} {%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4864 %} @@ -274,73 +274,73 @@ topics: {%- ifversion ghec or ghes %} ### `dotcom_connection` category actions -| Ação | Descrição | -| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dotcom_connection.create` | A {% data variables.product.prodname_github_connect %} connection to {% data variables.product.prodname_dotcom_the_website %} was created. | -| `dotcom_connection.destroy` | A {% data variables.product.prodname_github_connect %} connection to {% data variables.product.prodname_dotcom_the_website %} was deleted. | -| `dotcom_connection.token_updated` | The {% data variables.product.prodname_github_connect %} connection token for {% data variables.product.prodname_dotcom_the_website %} was updated. | -| `dotcom_connection.upload_license_usage` | {% data variables.product.prodname_ghe_server %} license usage was manually uploaded to {% data variables.product.prodname_ghe_cloud %}. | -| `dotcom_connection.upload_usage_metrics` | {% data variables.product.prodname_ghe_server %} usage metrics were uploaded to {% data variables.product.prodname_dotcom_the_website %}. | +| Ação | Descrição | +| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `dotcom_connection.create` | A {% data variables.product.prodname_github_connect %} connection to {% data variables.product.prodname_dotcom_the_website %} was created. | +| `dotcom_connection.destroy` | A {% data variables.product.prodname_github_connect %} connection to {% data variables.product.prodname_dotcom_the_website %} was deleted. | +| `dotcom_connection.token_updated` | O token de conexão de {% data variables.product.prodname_github_connect %} para {% data variables.product.prodname_dotcom_the_website %} foi atualizado. | +| `dotcom_connection.upload_license_usage` | O uso da licença de {% data variables.product.prodname_ghe_server %} foi enviado manualmente para {% data variables.product.prodname_ghe_cloud %}. | +| `dotcom_connection.upload_usage_metrics` | As mpetrica de uso de {% data variables.product.prodname_ghe_server %} foram enviadas para {% data variables.product.prodname_dotcom_the_website %}. | {%- endif %} ### Ações da categoria `empresa` -| Ação | Descrição | -| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enterprise.config.disable_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} disabled anonymous Git read access for repositories in the enterprise. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.enable_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} enabled anonymous Git read access for repositories in the enterprise. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.lock_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} locked anonymous Git read access to prevent repository admins from changing existing anonymous Git read access settings for repositories in the enterprise. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.unlock_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} unlocked anonymous Git read access to allow repository admins to change existing anonymous Git read access settings for repositories in the enterprise. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.register_self_hosted_runner` | A new {% data variables.product.prodname_actions %} self-hosted runner was registered. Para obter mais informações, consulte "[Adicionar um executor auto-hospedado a um repositório](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository). ". | -| `enterprise.remove_self_hosted_runner` | A {% data variables.product.prodname_actions %} self-hosted runner was removed. Para obter mais informações, consulte "[Remover um executor de um repositório](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)". | -| `enterprise.runner_group_created` | A {% data variables.product.prodname_actions %} self-hosted runner group was created. Para obter mais informações, consulte "[Criar um grupo de executores auto-hospedados para uma organização](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)". | -| `enterprise.runner_group_removed` | A {% data variables.product.prodname_actions %} self-hosted runner group was removed. Para obter mais informações, consulte "[Remover um grupo de executores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)". | -| `enterprise.runner_group_renamed` | A {% data variables.product.prodname_actions %} self-hosted runner group was renamed. Para obter mais informações, consulte "[Alterar a política de acesso de um grupo de executores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | -| `enterprise.runner_group_updated` | The configuration of a {% data variables.product.prodname_actions %} self-hosted runner group was changed. Para obter mais informações, consulte "[Alterar a política de acesso de um grupo de executores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | -| `enterprise.runner_group_runner_removed` | The REST API was used to remove a {% data variables.product.prodname_actions %} self-hosted runner from a group. Para obter mais informações, consulte "[Remover um executor auto-hospedado de um grupo para uma organização](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)". | -| `enterprise.runner_group_runners_added` | A {% data variables.product.prodname_actions %} self-hosted runner was added to a group. Para obter mais informações, consulte [Transferir um executor auto-hospedado para um grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). | -| `enterprise.runner_group_runners_updated` | A {% data variables.product.prodname_actions %} runner group's list of members was updated. Para obter mais informações, consulte "[Definir executores auto-hospedados em um grupo para uma organização](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". | +| Ação | Descrição | +| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `enterprise.config.disable_anonymous_git_access` | Um proprietário corporativo {% ifversion ghes %} ou administrador do site{% endif %} desabilitou acesso de leitura anônimo do Git para repositórios na empresa. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.enable_anonymous_git_access` | Um proprietário corporativo {% ifversion ghes %} ou administrador do site{% endif %} habilitou o acesso de leitura anônimo do Git para repositórios na empresa. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.lock_anonymous_git_access` | Um proprietário corporativo{% ifversion ghes %} ou administrador do site{% endif %} bloqueou acesso de leitura anônimo do Git para impedir que os administradores do repositório alterem as configurações de acesso de leitura anónimas do Git existentes nos repositórios da empresa. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.unlock_anonymous_git_access` | Um proprietário corporativo{% ifversion ghes %} ou administrador do site{% endif %} desbloqueou acesso de leitura anônimo do Git para permitir que os administradores do repositório alterem as configurações de acesso de leitura anónimas do Git existentes nos repositórios da empresa. Para obter mais informações, consulte "[Aplicar políticas de gerenciamento do repositório na sua empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.register_self_hosted_runner` | Um novo executor auto-hospedado em {% data variables.product.prodname_actions %} foi registrado. Para obter mais informações, consulte "[Adicionar um executor auto-hospedado a um repositório](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository). ". | +| `enterprise.remove_self_hosted_runner` | Um executor auto-hospedado em{% data variables.product.prodname_actions %} foi removido. Para obter mais informações, consulte "[Remover um executor de um repositório](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)". | +| `enterprise.runner_group_created` | Um grupo de executor auto-hospedado em{% data variables.product.prodname_actions %} foi criado. Para obter mais informações, consulte "[Criar um grupo de executores auto-hospedados para uma organização](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)". | +| `enterprise.runner_group_removed` | Um grupo de executor auto-hospedado em{% data variables.product.prodname_actions %} foi removido. Para obter mais informações, consulte "[Remover um grupo de executores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)". | +| `enterprise.runner_group_renamed` | Um grupo de executor auto-hospedado em{% data variables.product.prodname_actions %} foi renomeado. Para obter mais informações, consulte "[Alterar a política de acesso de um grupo de executores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | +| `enterprise.runner_group_updated` | A configuração de um grupo de executores auto-hospedados de {% data variables.product.prodname_actions %} foi alterada. Para obter mais informações, consulte "[Alterar a política de acesso de um grupo de executores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | +| `enterprise.runner_group_runner_removed` | A API REST foi usada para remover executor auto-hospedado de {% data variables.product.prodname_actions %} de um grupo. Para obter mais informações, consulte "[Remover um executor auto-hospedado de um grupo para uma organização](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)". | +| `enterprise.runner_group_runners_added` | Um executor auto-hospedado em {% data variables.product.prodname_actions %} foi adicionado a um grupo. Para obter mais informações, consulte [Transferir um executor auto-hospedado para um grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). | +| `enterprise.runner_group_runners_updated` | Uma lista de integrantes de um grupo do executor de {% data variables.product.prodname_actions %} foi atualizada. Para obter mais informações, consulte "[Definir executores auto-hospedados em um grupo para uma organização](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". | {%- ifversion ghec %} -| `enterprise.runner_group_visiblity_updated` | The visibility of a {% data variables.product.prodname_actions %} self-hosted runner group was updated via the REST API. For more information, see "[Update a self-hosted runner group for an organization](/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization)." +| `enterprise.runner_group_visiblity_updated` | A visibilidade de um grupo de executores auto-hospedados de {% data variables.product.prodname_actions %} foi atualizada por meio da API REST. Para obter mais informações, consulte "[Atualize um grupo de executores auto-hospedados para uma organização](/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization)". {%- endif %} {%- ifversion ghec or ghes > 3.1 or ghae %} -| `enterprise.self_hosted_runner_online` | The {% data variables.product.prodname_actions %} runner application was started. Só pode ser visto usando a API REST. Não é visível na interface do usuário ou na exportação do JSON/CSV. Para obter mais informações, consulte "[Verificar o status de um executor auto-hospedado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)". | `enterprise.self_hosted_runner_offline` | The {% data variables.product.prodname_actions %} runner application was stopped. Só pode ser visto usando a API REST. Não é visível na interface do usuário ou na exportação do JSON/CSV. Para obter mais informações, consulte "[Verificar o status de um executor auto-hospedado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)". +| `enterprise.self_hosted_runner_online` | O aplicativo do executor de {% data variables.product.prodname_actions %} foi iniciado. Só pode ser visto usando a API REST. Não é visível na interface do usuário ou na exportação do JSON/CSV. Para obter mais informações, consulte "[Verificar o status de um executor auto-hospedado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)". | `enterprise.self_hosted_runner_offline` | O aplicativo do executor de {% data variables.product.prodname_actions %} foi interrompido. Só pode ser visto usando a API REST. Não é visível na interface do usuário ou na exportação do JSON/CSV. Para obter mais informações, consulte "[Verificar o status de um executor auto-hospedado](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)". {%- endif %} {%- ifversion ghec or ghes %} -| `enterprise.self_hosted_runner_updated` | The {% data variables.product.prodname_actions %} runner application was updated. Pode ser visto usando a API REST e a interface do usuário; não visível na exportação de JSON/CSV. Para obter mais informações, consulte "[Sobre os executores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." +| `enterprise.self_hosted_runner_updated` | O aplicativo do executor de {% data variables.product.prodname_actions %} foi atualizado. Pode ser visto usando a API REST e a interface do usuário; não visível na exportação de JSON/CSV. Para obter mais informações, consulte "[Sobre os executores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." {%- endif %} {%- ifversion ghec %} -### `enterprise_domain` category actions +### Ações da categoria `enterprise_domain` -| Ação | Descrição | -| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enterprise_domain.approve` | An enterprise domain was approved for an enterprise. For more information, see "[Approving a domain for your enterprise account](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#approving-a-domain-for-your-enterprise-account)." | -| `enterprise_domain.create` | An enterprise domain was added to an enterprise. For more information, see "[Verifying a domain for your enterprise account](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#verifying-a-domain-for-your-enterprise-account)." | -| `enterprise_domain.destroy` | An enterprise domain was removed from an enterprise. For more information, see "[Removing an approved or verified domain](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#removing-an-approved-or-verified-domain)." | -| `enterprise_domain.verify` | An enterprise domain was verified for an enterprise. For more information, see "[Verifying a domain for your enterprise account](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#verifying-a-domain-for-your-enterprise-account)." | +| Ação | Descrição | +| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `enterprise_domain.approve` | Um domínio corporativo foi aprovado para uma empresa. Para obter mais informações, consulte "[Aprovando um domínio para a sua conta corporativa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#approving-a-domain-for-your-enterprise-account)". | +| `enterprise_domain.create` | Um domínio corporativo foi adicionado a uma empresa. Para obter mais informações, consulte "[Verificando um domínio para a sua conta corporativa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#verifying-a-domain-for-your-enterprise-account)". | +| `enterprise_domain.destroy` | Um domínio corporativo foi removido de uma empresa. Para obter mais informações, consulte "[Removendo um domínio aprovado ou verificado](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#removing-an-approved-or-verified-domain). " | +| `enterprise_domain.verify` | Um domínio corporativo foi verificado para uma empresa. Para obter mais informações, consulte "[Verificando um domínio para a sua conta corporativa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise#verifying-a-domain-for-your-enterprise-account)". | -### `enterprise_installation` category actions +### Ações da categoria `enterprise_installation` | Ação | Descrição | | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enterprise_installation.create` | The {% data variables.product.prodname_github_app %} associated with an {% data variables.product.prodname_github_connect %} enterprise connection was created. | -| `enterprise_installation.destroy` | The {% data variables.product.prodname_github_app %} associated with an {% data variables.product.prodname_github_connect %} enterprise connection was deleted. | -| `enterprise_installation.token_updated` | The token belonging to {% data variables.product.prodname_github_app %} associated with an {% data variables.product.prodname_github_connect %} enterprise connection was updated. | +| `enterprise_installation.create` | O {% data variables.product.prodname_github_app %} associado com uma conexão corporativa de {% data variables.product.prodname_github_connect %} foi criado. | +| `enterprise_installation.destroy` | O {% data variables.product.prodname_github_app %} associado com uma conexão corporativa de {% data variables.product.prodname_github_connect %} foi excluído. | +| `enterprise_installation.token_updated` | O token pertencente a {% data variables.product.prodname_github_app %} associado a uma conexão corporativa de {% data variables.product.prodname_github_connect %} foi atualizado. | {%- endif %} {%- ifversion fpt or ghec %} ### ações da categoria `ambiente` -| Ação | Descrição | -| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `environment.add_protection_rule` | A {% data variables.product.prodname_actions %} environment protection rule was created via the API. For more information, see "[Environment protection rules](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." | -| `environment.create_actions_secret` | A secret was created for a {% data variables.product.prodname_actions %} environment via the API. For more information, see "[Environment secrets](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets)." | -| `environment.delete` | An environment was deleted via the API. For more information, see "[Deleting an environment](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deleting-an-environment)." | -| `environment.remove_actions_secret` | A secret was deleted for a {% data variables.product.prodname_actions %} environment via the API. For more information, see "[Environment secrets](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets)." | -| `environment.remove_protection_rule` | A {% data variables.product.prodname_actions %} environment protection rule was deleted via the API. For more information, see "[Environment protection rules](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." | -| `environment.update_actions_secret` | A secret was updated for a {% data variables.product.prodname_actions %} environment via the API. For more information, see "[Environment secrets](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets)." | -| `environment.update_protection_rule` | A {% data variables.product.prodname_actions %} environment protection rule was updated via the API. For more information, see "[Environment protection rules](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." | +| Ação | Descrição | +| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `environment.add_protection_rule` | Uma regra de proteção de ambiente de {% data variables.product.prodname_actions %} foi criada através da API. Para obter mais informações, consulte "[Regras de proteção de ambiente](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)". | +| `environment.create_actions_secret` | Um segredo foi criado para um ambiente de {% data variables.product.prodname_actions %} através da API. Para obter mais informações, consulte "[Segredos do ambiente](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets)". | +| `environment.delete` | Um ambiente foi excluído pela API. For more information, see "[Deleting an environment](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deleting-an-environment)." | +| `environment.remove_actions_secret` | A secret was deleted for a {% data variables.product.prodname_actions %} environment via the API. Para obter mais informações, consulte "[Segredos do ambiente](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets)". | +| `environment.remove_protection_rule` | A {% data variables.product.prodname_actions %} environment protection rule was deleted via the API. Para obter mais informações, consulte "[Regras de proteção de ambiente](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)". | +| `environment.update_actions_secret` | A secret was updated for a {% data variables.product.prodname_actions %} environment via the API. Para obter mais informações, consulte "[Segredos do ambiente](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets)". | +| `environment.update_protection_rule` | A {% data variables.product.prodname_actions %} environment protection rule was updated via the API. Para obter mais informações, consulte "[Regras de proteção de ambiente](/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)". | {%- endif %} {%- ifversion ghae %} @@ -403,24 +403,24 @@ topics: ### `integration_installation`category actions -| Ação | Descrição | -| ------------------------------------------------ | ----------------------------------------------- | -| `integration_installation.contact_email_changed` | A contact email for an integration was changed. | -| `integration_installation.create` | An integration was installed. | -| `integration_installation.destroy` | An integration was uninstalled. | -| `integration_installation.repositories_added` | Repositories were added to an integration. | -| `integration_installation.repositories_removed` | Repositories were removed from an integration. | +| Ação | Descrição | +| ------------------------------------------------ | ------------------------------------------------------ | +| `integration_installation.contact_email_changed` | Um e-mail de contato para uma integração foi alterado. | +| `integration_installation.create` | Uma integração foi instalada. | +| `integration_installation.destroy` | Uma integração foi desinstalada. | +| `integration_installation.repositories_added` | Os repositórios foram adicionados a uma integração. | +| `integration_installation.repositories_removed` | Os repositórios foram removidos de uma integração. | {%- ifversion fpt or ghec %} -| `integration_installation.suspend` | An integration was suspended. | `integration_installation.unsuspend` | An integration was unsuspended. +| `integration_installation.suspend` | Uma integração foi suspensa. | `integration_installation.unsuspend` | A suspensão de uma integração foi cancelada. {%- endif %} -| `integration_installation.version_updated` | Permissions for an integration were updated. +| `integration_installation.version_updated` | As permissões para uma integração foram atualizadas. ### ações de categoria de `integration_installation_request` -| Ação | Descrição | -| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `integration_installation_request.create` | An member requested that an owner install an integration for use in an enterprise or organization. | -| `integration_installation_request.close` | A request to install an integration for use in an enterprise or organization was either approved or denied by an owner, or canceled by the member who opened the request. | +| Ação | Descrição | +| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `integration_installation_request.create` | Um integrante solicitou que um proprietário instale uma integração para uso em uma empresa ou organização. | +| `integration_installation_request.close` | Uma solicitação para instalar uma integração para uso em uma empresa ou organização foi ou aprovada ou negada por um proprietário ou cancelada pelo integrante que abriu a solicitação. | {%- ifversion ghec or ghae %} ### Ações da categoria `ip_allow_list` @@ -443,47 +443,47 @@ topics: ### ações de categoria de `problema` -| Ação | Descrição | -| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `issue.destroy` | Um problema foi excluído do repositório. Para obter mais informações, consulte "[Excluir uma problema](/issues/tracking-your-work-with-issues/deleting-an-issue)". | -| `issue.pinned` | An issue was pinned to a repository. Para obter mais informações, consulte "[Fixar um problema no seu repositório](/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)". | -| `issue.transfer` | An issue was transferred to another repository. Para obter mais informações, consulte "[Transferir um problema para outro repositório](/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)". | -| `issue.unpinned` | An issue was unpinned from a repository. Para obter mais informações, consulte "[Fixar um problema no seu repositório](/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)". | +| Ação | Descrição | +| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `issue.destroy` | Um problema foi excluído do repositório. Para obter mais informações, consulte "[Excluir uma problema](/issues/tracking-your-work-with-issues/deleting-an-issue)". | +| `issue.pinned` | Um problema foi fixado em um repositório. Para obter mais informações, consulte "[Fixar um problema no seu repositório](/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)". | +| `issue.transfer` | Um problema foi transferido para outro repositório. Para obter mais informações, consulte "[Transferir um problema para outro repositório](/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)". | +| `issue.unpinned` | Um problema foi desfixado de um repositório. Para obter mais informações, consulte "[Fixar um problema no seu repositório](/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)". | -### `issue_comment` category actions +### Ações da categoria `issue_comment` | Ação | Descrição | | ------------------------ | ------------------------------------------------------------------- | -| `issue_comment.destroy` | A comment on an issue was deleted from the repository. | -| `issue_comment.pinned` | A comment on an issue was pinned to a repository. | -| `issue_comment.unpinned` | A comment on an issue was unpinned from a repository. | +| `issue_comment.destroy` | Um comentário sobre um problema foi excluído do repositório. | +| `issue_comment.pinned` | Um comentário sobre um problema foi fixado em um repositório. | +| `issue_comment.unpinned` | Um comentário sobre um problema foi desafixado de um repositório. | | `issue_comment.update` | Um comentário em um problema (que não seja o inicial) foi alterado. | -### `issues` category actions +### Ações da categoria `problemas` -| Ação | Descrição | -| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `issues.deletes_disabled` | The ability for enterprise members to delete issues was disabled. Members cannot delete issues in any organizations in an enterprise. For more information, see "[Enforcing a policy for deleting issues](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues)." | -| `issues.deletes_enabled` | The ability for enterprise members to delete issues was enabled. Members can delete issues in any organizations in an enterprise. For more information, see "[Enforcing a policy for deleting issues](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues)." | -| `issues.deletes_policy_cleared` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} cleared the policy setting for allowing members to delete issues in an enterprise. For more information, see "[Enforcing a policy for deleting issues](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues)." | +| Ação | Descrição | +| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `issues.deletes_disabled` | A capacidade de os integrantes da empresa de excluir problemas foi desabilitada. Os membros não podem excluir problemas de nenhuma organização em uma empresa. Para obter mais informações, consulte "[Aplicando uma política para excluir problemas](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues)". | +| `issues.deletes_enabled` | A capacidade de os integrantes da empresa de excluir problemas foi habilitada. Os membros podem excluir problemas de nenhuma organização em uma empresa. Para obter mais informações, consulte "[Aplicando uma política para excluir problemas](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues)". | +| `issues.deletes_policy_cleared` | Um proprietário corporativo{% ifversion ghes %} ou administrador do site{% endif %} limpou a configuração da política para permitir que os integrantes excluam problemas em uma empresa. Para obter mais informações, consulte "[Aplicando uma política para excluir problemas](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-deleting-issues)". | {%- ifversion fpt or ghec %} ### ações de categoria de `marketplace_agreement_signature` -| Ação | Descrição | -| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `marketplace_agreement_signature.create` | A user signed the {% data variables.product.prodname_marketplace %} Developer Agreement on behalf of an organization. | +| Ação | Descrição | +| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `marketplace_agreement_signature.create` | Um usuário assinou o Acordo de Desenvolvedor de {% data variables.product.prodname_marketplace %} em nome de uma organização. | ### ações de categoria de `marketplace_listing` -| Ação | Descrição | -| ------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `marketplace_listing.approve` | A listing was approved for inclusion in {% data variables.product.prodname_marketplace %}. | -| `marketplace_listing.change_category` | A category for a listing for an app in {% data variables.product.prodname_marketplace %} was changed. | -| `marketplace_listing.create` | A listing for an app in {% data variables.product.prodname_marketplace %} was created. | -| `marketplace_listing.delist` | A listing was removed from {% data variables.product.prodname_marketplace %}. | -| `marketplace_listing.redraft` | A listing was sent back to draft state. | -| `marketplace_listing.reject` | A listing was not accepted for inclusion in {% data variables.product.prodname_marketplace %}. | +| Ação | Descrição | +| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `marketplace_listing.approve` | Um anúncio foi aprovado para inclusão em {% data variables.product.prodname_marketplace %}. | +| `marketplace_listing.change_category` | Uma categoria para um anúncio de um aplicativo em {% data variables.product.prodname_marketplace %} foi alterada. | +| `marketplace_listing.create` | Um anúncio para um aplicativo em {% data variables.product.prodname_marketplace %} foi criado. | +| `marketplace_listing.delist` | Um anúncio foi removido de {% data variables.product.prodname_marketplace %}. | +| `marketplace_listing.redraft` | A listing was sent back to draft state. | +| `marketplace_listing.reject` | A listing was not accepted for inclusion in {% data variables.product.prodname_marketplace %}. | {%- endif %} ### ações de categoria de `members_can_create_pages` @@ -526,11 +526,11 @@ topics: ### `migration` category actions -| Ação | Descrição | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `migration.create` | A migration file was created for transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance. | -| `migration.destroy_file` | A migration file for transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance was deleted. | -| `migration.download` | A migration file for transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance was downloaded. | +| Ação | Descrição | +| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `migration.create` | A migration file was created for transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance. | +| `migration.destroy_file` | A migration file for transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance was deleted. | +| `migration.download` | Um arquivo de migração para transferência de dados da localidade *fonte* (como uma organização de {% data variables.product.prodname_dotcom_the_website %} ou uma instância de {% data variables.product.prodname_ghe_server %}) para um *destino* da instância de{% data variables.product.prodname_ghe_server %} instância foi baixado. | {%- endif %} ### ações de categoria`Oauth_access` @@ -540,16 +540,16 @@ topics: | | | -`oauth_access.create` | An [OAuth access token][] was generated for a user account. Para obter mais informações, consulte "[Criando um token de acesso pessoal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." `oauth_access.destroy` | An [OAuth access token][] was deleted from a user account. +`oauth_access.create` | Um [token de acesso do OAuth][] foi gerado para a conta de um usuário. Para obter mais informações, consulte "[Criando um token de acesso pessoal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." `oauth_access.destroy` | Um [token de acesso do OAuth][] foi excluído da conta de um usuário. ### ações da categoria `oauth_application` -| Ação | Descrição | -| --------------------------- | ---------------------------------------------------------------------------- | -| `oauth_application.create` | An [OAuth application][] was created for a user or organization account. | -| `oauth_application.destroy` | Um [aplicativo OAuth][] foi excluído de uma organização ou conta de usuário. | +| Ação | Descrição | +| --------------------------- | ------------------------------------------------------------------------------- | +| `oauth_application.create` | Um aplicativo do [OAuth][] foi criado para uma conta de usuário ou organização. | +| `oauth_application.destroy` | Um [aplicativo OAuth][] foi excluído de uma organização ou conta de usuário. | {%- ifversion fpt or ghec %} -| `oauth_application.generate_client_secret` | An [OAuth application][]'s secret key was generated. | `oauth_application.remove_client_secret` | An [OAuth application][]'s secret key was deleted. +| `oauth_application.generate_client_secret` | A chave do segredo de um [aplicativo do OAuth ][] foi gerada. | `oauth_application.remove_client_secret` | A chave do segredo de um [aplicativo OAuth application][]foi excluída. {%- endif %} | `oauth_application.reset_secret` | An [OAuth application][]'s secret key was reset. {%- ifversion fpt or ghec %} @@ -563,24 +563,24 @@ topics: {%- ifversion fpt or ghec %} ### Ações da categoria `oauth_authorization` -| Ação | Descrição | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `oauth_authorization.create` | An authorization for an OAuth application was created. Para obter mais informações, consulte "[Autorizar aplicativos OAuth](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)". | -| `oauth_authorization.destroy` | An authorization for an OAuth application was deleted. Para obter mais informações, consulte "[Autorizar aplicativos OAuth](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)". | -| `oauth_authorization.update` | An authorization for an OAuth application was updated. Para obter mais informações, consulte "[Autorizar aplicativos OAuth](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)". | +| Ação | Descrição | +| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `oauth_authorization.create` | Uma autorização para um aplicativo OAuth foi criada. Para obter mais informações, consulte "[Autorizar aplicativos OAuth](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)". | +| `oauth_authorization.destroy` | Uma autorização para um aplicativo OAuth foi excluída. Para obter mais informações, consulte "[Autorizar aplicativos OAuth](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)". | +| `oauth_authorization.update` | Uma autorização para um aplicativo OAuth foi atualizada. Para obter mais informações, consulte "[Autorizar aplicativos OAuth](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)". | {%- endif %} ### ações de categoria de `org` -| Ação | Descrição | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `org.accept_business_invitation` | An invitation sent to an organization to join an enterprise was accepted. | -| {% ifversion ghec %}For more information, see "[Inviting an organization to join your enterprise account](/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account)."{% endif %} | | -| `org.add_billing_manager` | A billing manager was added to an organization. | -| {% ifversion fpt or ghec %}For more information, see "[Adding a billing manager to your organization](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)."{% endif %} | | -| `org.add_member` | A user joined an organization. | +| Ação | Descrição | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `org.accept_business_invitation` | Um convite enviado para uma organização para participar de uma empresa foi aceito. | +| {% ifversion ghec %}Para obter mais informações, consulte "[Convidar uma organização para participar da sua conta corporativa](/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise#inviting-an-organization-to-join-your-enterprise-account)".{% endif %} | | +| `org.add_billing_manager` | Um gerente de cobrança foi adicionado a uma organização. | +| {% ifversion fpt or ghec %}Para obter mais informações, consulte "[Adicionando um gerente de cobrança à sua organização](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)".{% endif %} | | +| `org.add_member` | Um usuário entrou em uma organização. | {%- ifversion ghes > 3.0 or ghae or ghec %} -| `org.advanced_security_disabled_for_new_repos` | {% data variables.product.prodname_GH_advanced_security %} was disabled for new repositories in an organization. | `org.advanced_security_disabled_on_all_repos` | {% data variables.product.prodname_GH_advanced_security %} was disabled for all repositories in an organization. | `org.advanced_security_enabled_for_new_repos` | {% data variables.product.prodname_GH_advanced_security %} was enabled for new repositories in an organization. | `org.advanced_security_enabled_on_all_repos` | {% data variables.product.prodname_GH_advanced_security %} was enabled for all repositories in an organization. | `org.advanced_security_policy_selected_member_disabled` | An enterprise owner prevented {% data variables.product.prodname_GH_advanced_security %} features from being enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %} | `org.advanced_security_policy_selected_member_enabled` | An enterprise owner allowed {% data variables.product.prodname_GH_advanced_security %} features to be enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %} | `org.advanced_security_policy_update` | An organization owner updated polices for {% data variables.product.prodname_GH_advanced_security %} in an enterprise. {% data reusables.advanced-security.more-information-about-enforcement-policy %} +| `org.advanced_security_disabled_for_new_repos` | {% data variables.product.prodname_GH_advanced_security %} foi desabilitado para novos repositórios em uma organização. | `org.advanced_security_disabled_on_all_repos` | {% data variables.product.prodname_GH_advanced_security %} foi desabilitado para todos os repositórios em uma organização. | `org.advanced_security_enabled_for_new_repos` | {% data variables.product.prodname_GH_advanced_security %} foi habilitado para novos repositórios em uma organização. | `org.advanced_security_enabled_on_all_repos` | {% data variables.product.prodname_GH_advanced_security %} foi habilitado para todos os repositórios em uma organização. | `org.advanced_security_policy_selected_member_disabled` | O proprietário de uma empresa evitou que as funcionalidades de {% data variables.product.prodname_GH_advanced_security %} fossem habilitadas para os repositórios pertencentes à organização. {% data reusables.advanced-security.more-information-about-enforcement-policy %} | `org.advanced_security_policy_selected_member_enabled` | An enterprise owner allowed {% data variables.product.prodname_GH_advanced_security %} features to be enabled for repositories owned by the organization. {% data reusables.advanced-security.more-information-about-enforcement-policy %} | `org.advanced_security_policy_update` | An organization owner updated polices for {% data variables.product.prodname_GH_advanced_security %} in an enterprise. {% data reusables.advanced-security.more-information-about-enforcement-policy %} {%- endif %} | `org.async_delete` | A user initiated a background job to delete an organization. {%- ifversion ghec %} @@ -628,7 +628,7 @@ topics: {%- endif %} | `org.runner_group_updated` | The configuration of a self-hosted runner group was changed. Para obter mais informações, consulte "[Alterar a política de acesso de um grupo de executores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | `org.runner_group_runner_removed` | The REST API was used to remove a self-hosted runner from a group. Para obter mais informações, consulte "[Remover um executor auto-hospedado de um grupo para uma organização](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)". | `org.runner_group_runners_added` | A self-hosted runner was added to a group. Para obter mais informações, consulte [Transferir um executor auto-hospedado para um grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). | `org.runner_group_runners_updated`| A runner group's list of members was updated. Para obter mais informações, consulte "[Definir executores auto-hospedados em um grupo para uma organização](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". {%- ifversion fpt or ghec %} -| `org.runner_group_visiblity_updated` | The visibility of a self-hosted runner group was updated via the REST API. For more information, see "[Update a self-hosted runner group for an organization](/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization)." +| `org.runner_group_visiblity_updated` | The visibility of a self-hosted runner group was updated via the REST API. Para obter mais informações, consulte "[Atualize um grupo de executores auto-hospedados para uma organização](/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization)". {%- endif %} {%- if secret-scanning-audit-log-custom-patterns %} | `org.secret_scanning_push_protection_disable` | An organization owner or administrator disabled push protection for secret scanning. For more information, see "[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." | `org.secret_scanning_push_protection_enable` | An organization owner or administrator enabled push protection for secret scanning. @@ -1237,12 +1237,18 @@ topics: {% data reusables.audit_log.audit-log-events-workflows %} {%- endif %} - [OAuth access token]: /developers/apps/building-oauth-apps/authorizing-oauth-apps + [token de acesso do OAuth]: /developers/apps/building-oauth-apps/authorizing-oauth-apps - [OAuth application]: /guides/basics-of-authentication/#registering-your-app + [OAuth]: /guides/basics-of-authentication/#registering-your-app [aplicativo OAuth]: /guides/basics-of-authentication/#registering-your-app + [aplicativo do OAuth ]: /guides/basics-of-authentication/#registering-your-app + + [aplicativo OAuth application]: /guides/basics-of-authentication/#registering-your-app + + [OAuth application]: /guides/basics-of-authentication/#registering-your-app + [add key]: /authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account [deploy key]: /developers/overview/managing-deploy-keys#deploy-keys diff --git a/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise.md b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise.md index 080f92c03f..e8dd198057 100644 --- a/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise.md +++ b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise.md @@ -46,7 +46,7 @@ Se sua empresa usa {% data variables.product.prodname_emus %}, os proprietários {% ifversion ghec %}Depois de convidar alguém para juntar-se à conta corporativa, a pessoa deverá aceitar o convite por e-mail antes que possa acessar a conta corporativa. Convites pendentes vencem após 7 dias.{% endif %} {% if enterprise-membership-view-improvements %} -You can see all pending invitations to become an administrator of your enterprise account. Para obter mais informações, consulte "[Visualizar pessoas na sua empresa](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-pending-invitations)". +É possível ver todos os convites pendentes para se tornar um administrador da sua conta corporativa. Para obter mais informações, consulte "[Visualizar pessoas na sua empresa](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-pending-invitations)". {% endif %} {% data reusables.enterprise-accounts.access-enterprise %} @@ -68,13 +68,13 @@ You can see all pending invitations to become an administrator of your enterpris Somente proprietários corporativos podem remover outros administradores corporativos da conta corporativa. {% ifversion ghec %} -If the administrator you want to remove is a member of any organizations owned by the enterprise, you can choose **Convert to member**, which will remove their administrative role but retain their organization memberships, or **Remove from enterprise**, which will remove both their administrative role and organization memberships. +Se o administrador que você deseja remover for integrante de quaisquer organizações pertencentes à empresa, você poderá escolher **Converter em integrante**, que eliminará a sua função administrativa, mas manterá os integrantes da sua organização ou **Remover da empresa**, o que removerá suas funções administrativas e associações à organização. {% endif %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -1. Next to the username of the person you'd like to remove, click {% octicon "gear" aria-label="The Settings gear" %}, then click {% ifversion ghes %}**Remove owner**{% elsif ghec %}**Convert to member** or **Remove from enterprise**.{% endif %}. +1. Ao lado do nome de usuário da pessoa que você deseja remover, clique em {% octicon "gear" aria-label="The Settings gear" %}, em seguida, clique em {% ifversion ghes %}**Remover dono**{% elsif ghec %}**Converter em integrante** ou **Remover da empresa**.{% endif %}. {% ifversion ghec %} ![Ajuste de configurações com menu option (opções) para remover um administrador corporativo](/assets/images/help/business-accounts/remove-admin.png) {% elsif ghes %} diff --git a/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md index dae65a62f7..546916b9fc 100644 --- a/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md +++ b/translations/pt-BR/content/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md @@ -15,72 +15,72 @@ topics: shortTitle: Visualizar as pessoas na sua empresa --- -## About the list of people in your enterprise +## Sobre a lista de pessoas da sua empresa -To audit access to your enterprise's resources and manage license usage, you can see a list of all the people who have access to your enterprise. +Para controlar o acesso aos recursos da sua empresa e gerenciar o uso da licença, você pode ver uma lista de todas as pessoas que têm acesso à sua empresa. -You can see all current enterprise members and enterprise administrators{% ifversion ghec %}, as well as pending invitations to become members and administrators{% endif %}. To make it easier to consume this information, you can search and filter the lists. +Você pode ver todos os integrantes atuais da empresa e administradores da empresa{% ifversion ghec %}, bem como convites pendentes para se tornarem integrantes e administradores{% endif %}. Para facilitar o consumo destas informações, você pode pesquisar e filtrar as listas. -## Viewing enterprise administrators +## Visualizando os administradores corporativos -You can view all the current enterprise owners{% ifversion ghec %} and billing managers{% endif %} for your enterprise.{% if enterprise-membership-view-improvements %} You can see useful information about each administrator{% ifversion ghec %} and filter the list by role{% endif %}.{% endif %} You can find a specific person by searching for their username or display name. +Você pode visualizar todos os atuais proprietários da empresa{% ifversion ghec %} e gerentes de cobrança{% endif %} para a sua empresa.{% if enterprise-membership-view-improvements %} Você pode ver informações úteis sobre cada administrador{% ifversion ghec %} e filtrar a lista por função{% endif %}.{% endif %} Você pode encontrar uma pessoa específica pesquisando o nome de usuário ou nome de exibição. {% ifversion not ghae %} -You can also remove an administrator. For more information. see "[Inviting people to manage your enterprise](/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise#removing-an-enterprise-administrator-from-your-enterprise-account)." +Você também pode remover um administrador. For more information. consulte "[convidando pessoas para gerenciar sua empresa](/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise#removing-an-enterprise-administrator-from-your-enterprise-account)". {% endif %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} {% data reusables.enterprise-accounts.administrators-tab %} -## Viewing members {% if enterprise-membership-view-improvements %}{% else %}and outside collaborators{% endif %} +## Visualizando integrantes {% if enterprise-membership-view-improvements %}{% else %}e colaboradores externos{% endif %} -You can see all the current members {% if enterprise-membership-view-improvements %}{% else %}or outside collaborators{% endif %} for your enterprise. You can see useful information about each account and filter the list in useful ways, such as by role. Ou localizar uma determinada pessoa procurando pelo nome de usuário ou o nome de exibição dela. +Você pode visualizar todos os integrantes atuais {% if enterprise-membership-view-improvements %}{% else %}ou colaboradores externos{% endif %} para a sua empresa. Você pode visualizar as informações úteis sobre cada conta e filtrar a lista de formas úteis, como por função. Ou localizar uma determinada pessoa procurando pelo nome de usuário ou o nome de exibição dela. -You can view more information about the person's access to your enterprise, such as the organizations the person belongs to, by clicking on the person's name. +Você pode ver mais informações sobre o acesso da pessoa à sua empresa como, por exemplo, as organizações às quais a pessoa pertence, clicando no nome da pessoa. {% if remove-enterprise-members %} -You can also remove any enterprise member from all organizations owned by the enterprise. For more information, see "[Removing a member from your enterprise](/admin/user-management/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise)." +Você também pode remover qualquer integrante da empresa de todas as organizações pertencentes à empresa. Para obter mais informações, consulte "[Removendo um integrante da sua empresa](/admin/user-management/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise)." {% endif %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %}{% if enterprise-membership-view-improvements %}{% else %} 1. Como alternativa, clique em **Outside collaborators** (Colaboradores externos) para exibir uma lista deles em vez de uma lista de integrantes. - ![Outside collaborators tab on the enterprise members page](/assets/images/help/business-accounts/outside-collaborators-tab.png){% endif %} + ![Guia de colaboradores externos na página de integrantes da empresa](/assets/images/help/business-accounts/outside-collaborators-tab.png){% endif %} {% if enterprise-membership-view-improvements %} -## Viewing outside collaborators +## Visualizando colaboradores externos -You can see all the current outside collaborators for your enterprise. You can see useful information about each collaborator and filter the list in useful ways, such as by organization. You can find a specific collaborator by searching for their username or display name. +Você pode ver todos os colaboradores externos atuais da sua empresa. Você pode ver informações úteis sobre cada colaborador e filtrar a lista de formas úteis, por exemplo, por organização. Você pode encontrar um colaborador específico pesquisando o nome de usuário ou nome de exibição. -You can view more information about the person's access to your enterprise, such as a list of all the repositories the collaborator has access to, by clicking on the person's name. +Você pode ver mais informações sobre o acesso da pessoa à sua empresa como, por exemplo, uma lista de todos os repositórios aos quais o colaborador tem acesso, clicando no nome da pessoa. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} -1. Under "People", click **Outside collaborators**. +1. Em "Pessoas", clique em **Colaboradores externos**. - ![Outside collaborators tab in the enterprise settings sidebar]{% ifversion ghec%}(/assets/images/help/business-accounts/outside-collaborators-tab-sidebar-dotcom.png){% else %}(/assets/images/help/business-accounts/outside-collaborators-tab-sidebar-dotcom.png){% endif %} + ![Aba de colaboradores na barra lateral de configurações da empresa]{% ifversion ghec%}(/assets/images/help/business-accounts/outside-collaborators-tab-sidebar-dotcom.png){% else %}(/assets/images/help/business-accounts/outside-collaborators-tab-sidebar-dotcom.png){% endif %} {% endif %} {% ifversion ghec %} -## Viewing pending invitations +## Visualizando convites pendentes -You can see all the pending invitations to become administrators, members, or outside collaborators in your enterprise. You can filter the list in useful ways, such as by organization. Ou localizar uma determinada pessoa procurando pelo nome de usuário ou o nome de exibição dela. +Você pode ver todos os convites pendentes para se tornar administradores, integrantes ou colaboradores externos em sua empresa. É possível filtrar a lista de forma útil, por exemplo, por organização. Ou localizar uma determinada pessoa procurando pelo nome de usuário ou o nome de exibição dela. -If you use {% data variables.product.prodname_vss_ghe %}, the list of pending invitations includes all {% data variables.product.prodname_vs %} subscribers that haven't joined any of your organizations on {% data variables.product.prodname_dotcom %}, even if the subscriber does not have a pending invitation to join an organization. For more information about how to get {% data variables.product.prodname_vs %} subscribers access to {% data variables.product.prodname_enterprise %}, see "[Setting up {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)." +Se você usar {% data variables.product.prodname_vss_ghe %}, a lista de convites pendentes incluirá todos os assinantes de {% data variables.product.prodname_vs %} que não fizeram parte de nenhuma das suas organizações em {% data variables.product.prodname_dotcom %}, mesmo que o assinante não tenha um convite pendente para participar de uma organização. Para obter mais informações sobre como fazer com que os assinantes de {% data variables.product.prodname_vs %} acessem {% data variables.product.prodname_enterprise %}, consulte "[Configurando {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)" {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.people-tab %} -1. Under "People", click **Pending invitations**. +1. Em "Pessoas", clique em **Convites pendentes.**. - ![Screenshot of the "Pending invitations" tab in the sidebar](/assets/images/help/enterprises/pending-invitations-tab.png) + ![Captura de tela da aba "Convites pendentes" na barra lateral](/assets/images/help/enterprises/pending-invitations-tab.png) -1. Optionally, to view pending invitations for enterprise administrators or outside collaborators, under "Pending members", click **Administrators** or **Outside collaborators**. +1. Opcionalmente, para visualizar os convites pendentes para administradores corporativos ou colaboradores externos, em "Integrantes pendentes", clique em **Administradores** ou **Colaboradores externos**. - ![Screenshot of the "Members", "Administrators", and "Outside collaborators" tabs](/assets/images/help/enterprises/pending-invitations-type-tabs.png) + ![Captura de tela das abas "Membros", "Administradores", e "Colaboradores externos"](/assets/images/help/enterprises/pending-invitations-type-tabs.png) ## Visualizando integrantes suspensos em um {% data variables.product.prodname_emu_enterprise %} diff --git a/translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md b/translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md index be1b24d404..f1b63e8d6f 100644 --- a/translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md +++ b/translations/pt-BR/content/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on.md @@ -27,7 +27,7 @@ Se você não puder acessar {% data variables.product.product_name %}, entre em {% ifversion fpt or ghec %} -{% data reusables.saml.dotcom-saml-explanation %} Organization owners can invite your personal account on {% data variables.product.prodname_dotcom %} to join their organization that uses SAML SSO, which allows you to contribute to the organization and retain your existing identity and contributions on {% data variables.product.prodname_dotcom %}. +{% data reusables.saml.dotcom-saml-explanation %} Os proprietários da organização podem convidar sua conta pessoal em {% data variables.product.prodname_dotcom %} para participar da organização que usa o SSO SAML, o que permite que você contribua com a organização e mantenha sua identidade e contribuições existentes em {% data variables.product.prodname_dotcom %}. Se você for integrante de um {% data variables.product.prodname_emu_enterprise %}, você usará uma nova conta que lhe será fornecida. {% data reusables.enterprise-accounts.emu-more-info-account %} diff --git a/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/about-ssh.md index d3ed66e944..7c006ef316 100644 --- a/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -27,9 +27,9 @@ Se você ficou sem usar a chave SSH por um ano, o {% data variables.product.prod {% endif %} {% ifversion fpt %} -Organizations that use {% data variables.product.prodname_ghe_cloud %} can provide SSH certificates, which members can use to access that organization's repositories without adding the certificate to their account on {% data variables.product.product_name %}. If you're using an SSH certificate, you cannot use the certificate to access forks of the organization's repositories, if the fork is owned by your personal account. For more information, see "[About SSH certificate authorities](/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)" in the {% data variables.product.prodname_ghe_cloud %} documentation. +As organizações que usam {% data variables.product.prodname_ghe_cloud %} podem fornecer certificados SSH, que os integrantes podem usar para acessar os repositórios da organização sem adicionar o certificado à sua conta em {% data variables.product.product_name %}. Se você estiver usando um certificado SSH, você não poderá usar o certificado para acessar as bifurcações dos repositórios da organização, se a bifurcação pertencer à sua conta pessoal. Para obter mais informações, consulte "[Sobre as autoridades de certificado SSH](/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)" na documentação de {% data variables.product.prodname_ghe_cloud %}. {% else ghec or ghes or ghae %} -Se você for integrante de uma organização que fornece certificados SSH, você poderá usar seu certificado para acessar os repositórios da organização sem adicionar o certificado à sua conta em {% data variables.product.product_name %}. You cannot use your certificate to access forks of the organization's repositories, if the forks is owned by your personal account. Para obter mais informações, consulte "[Sobre autoridades certificadas de SSH](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)". +Se você for integrante de uma organização que fornece certificados SSH, você poderá usar seu certificado para acessar os repositórios da organização sem adicionar o certificado à sua conta em {% data variables.product.product_name %}. Você não pode usar seu certificado para acessar as bifurcações dos repositórios da organização, se as bifurcações pertencerem à sua conta pessoal. Para obter mais informações, consulte "[Sobre autoridades certificadas de SSH](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)". {% endif %} ## Leia mais diff --git a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md index cb5e740b55..2a26c1f93c 100644 --- a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md +++ b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md @@ -34,7 +34,7 @@ Você pode efetuar a autenticação no {% data variables.product.product_name %} {% endif %} - **Apenas nome de usuário e senha** - - You'll create a password when you create your personal account on {% data variables.product.product_name %}. Recomendamos que você use um gerenciador de senhas para gerar uma senha aleatória e única. Para obter mais informações, consulte "[Criar uma senha forte](/github/authenticating-to-github/creating-a-strong-password)". + - Você irá definir uma senha ao criar sua conta pessoal em {% data variables.product.product_name %}. Recomendamos que você use um gerenciador de senhas para gerar uma senha aleatória e única. Para obter mais informações, consulte "[Criar uma senha forte](/github/authenticating-to-github/creating-a-strong-password)". - **Autenticação de dois fatores (2FA)** (recomendado) - Se você habilitar a 2FA, também iremos solicitar que você forneça um código gerado por um aplicativo no seu dispositivo móvel ou enviado como uma mensagem de texto (SMS) depois que você digitar seu nome de usuário e senha com sucesso. Para obter mais informações, consulte "[Acessar o {% data variables.product.prodname_dotcom %} usando a autenticação de dois fatores](/github/authenticating-to-github/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website)". - Além de autenticação com um aplicativo para celular ou uma mensagem de texto. você pode, opcionalmente, adicionar um método secundário de autenticação com uma chave de segurança usando o WebAuthn. Para obter mais informações, consulte "[Configurar a autenticação de dois fatores usando uma chave de segurança](/github/authenticating-to-github/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)". diff --git a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md index 64bef4203e..a2897494ab 100644 --- a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md +++ b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps.md @@ -78,7 +78,7 @@ Quando {% data variables.product.prodname_oauth_apps %} solicitar novas permiss ## {% data variables.product.prodname_oauth_apps %} e organizações -When you authorize an {% data variables.product.prodname_oauth_app %} for your personal account, you'll also see how the authorization will affect each organization you're a member of. +Ao autorizar um {% data variables.product.prodname_oauth_app %} para sua conta pessoal, você também verá como a autorização vai afetar cada organização da qual você faz parte. - **Para organizações *com* restrições de acesso do {% data variables.product.prodname_oauth_app %}, você poderá solicitar que os administradores da organização aprovem o aplicativo para uso nessa organização.** Se a organização não aprovar o aplicativo, o aplicativo só poderá acessar os recursos públicos da organização. Se você for administrador de uma organização, você mesmo poderá [aprovar o aplicativo](/articles/approving-oauth-apps-for-your-organization). diff --git a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md index 4c5b390fa6..856086e39f 100644 --- a/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md +++ b/translations/pt-BR/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md @@ -1,6 +1,6 @@ --- title: Revisar seus logs de segurança -intro: You can review the security log for your personal account to better understand actions you've performed and actions others have performed that involve you. +intro: Você pode revisar o log de segurança da sua conta pessoal para entender melhor as ações que você realizou e ações realizadas por outras pessoas que envolvem você. miniTocMaxHeadingLevel: 3 redirect_from: - /articles/reviewing-your-security-log @@ -81,13 +81,13 @@ Uma visão geral de algumas das ações mais comuns que são registradas como ev ### ações da categoria `codespaces` -| Ação | Descrição | -| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `create` | Acionada ao [criar codespace](/github/developing-online-with-codespaces/creating-a-codespace). | -| `resume` | Acionada ao retomar um codespace suspenso. | -| `delete` | Acionada quando você [exclui um codespace](/github/developing-online-with-codespaces/deleting-a-codespace). | -| `manage_access_and_security` | Acionada quando você atualiza [os repositórios aos quais um codespace tem acesso](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | -| `trusted_repositories_access_update` | Triggered when you change your personal account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | +| Ação | Descrição | +| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `create` | Acionada ao [criar codespace](/github/developing-online-with-codespaces/creating-a-codespace). | +| `resume` | Acionada ao retomar um codespace suspenso. | +| `delete` | Acionada quando você [exclui um codespace](/github/developing-online-with-codespaces/deleting-a-codespace). | +| `manage_access_and_security` | Acionada quando você atualiza [os repositórios aos quais um codespace tem acesso](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | +| `trusted_repositories_access_update` | Acionada quando você altera o [acesso e as configurações de segurança da sua conta pessoal para {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | ### ações de categoria de `marketplace_agreement_signature` @@ -177,37 +177,37 @@ Uma visão geral de algumas das ações mais comuns que são registradas como ev {% ifversion fpt or ghec %} ### ações de categoria de `patrocinadores` -| Ação | Descrição | -| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `custom_amount_settings_change` | Acionada quando você habilita ou desabilita os valores personalizados ou quando altera os valores sugeridos (consulte "[Gerenciar as suas camadas de patrocínio](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | -| `repo_funding_links_file_action` | Acionada quando você altera o arquivo FUNDING no repositório (consulte "[Exibir botão de patrocinador no repositório](/articles/displaying-a-sponsor-button-in-your-repository)") | -| `sponsor_sponsorship_cancel` | Acionada quando você cancela um patrocínio (consulte "[Fazer downgrade de um patrocínio](/articles/downgrading-a-sponsorship)") | -| `sponsor_sponsorship_create` | Acionada quando você patrocina uma conta (consulte "[Patrocinar um contribuidor de código aberto](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") | -| `sponsor_sponsorship_payment_complete` | Acionada depois que você patrocinar uma conta e seu pagamento ser processado (consulte [Patrocinando um colaborador de código aberto](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") | -| `sponsor_sponsorship_preference_change` | Acionada quando você altera o recebimento de atualizações de e-mail de um desenvolvedor patrocinado (consulte "[Gerenciar o patrocínio](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") | -| `sponsor_sponsorship_tier_change` | Acionada quando você faz upgrade ou downgrade do patrocínio (consulte "[Atualizar um patrocínio](/articles/upgrading-a-sponsorship)" e "[Fazer downgrade de um patrocínio](/articles/downgrading-a-sponsorship)") | -| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | -| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | -| `sponsored_developer_disable` | Acionada quando sua conta {% data variables.product.prodname_sponsors %} está desabilitado | -| `sponsored_developer_redraft` | Acionada quando sua conta de {% data variables.product.prodname_sponsors %} é retornada ao estado de rascunho a partir do estado aprovado | -| `sponsored_developer_profile_update` | Acionada quando você edita seu perfil de desenvolvedor patrocinado (consulte "[Editar informações de perfil para {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") | -| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | -| `sponsored_developer_tier_description_update` | Acionada quando você altera a descrição de uma camada de patrocínio (consulte "[Gerenciar suas camadas de patrocínio](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") | -| `sponsored_developer_update_newsletter_send` | Acionada quando você envia uma atualização por e-mail aos patrocinadores (consulte "[Entrar em contato com os patrocinadores](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") | -| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | -| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your personal account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | +| Ação | Descrição | +| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `custom_amount_settings_change` | Acionada quando você habilita ou desabilita os valores personalizados ou quando altera os valores sugeridos (consulte "[Gerenciar as suas camadas de patrocínio](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | +| `repo_funding_links_file_action` | Acionada quando você altera o arquivo FUNDING no repositório (consulte "[Exibir botão de patrocinador no repositório](/articles/displaying-a-sponsor-button-in-your-repository)") | +| `sponsor_sponsorship_cancel` | Acionada quando você cancela um patrocínio (consulte "[Fazer downgrade de um patrocínio](/articles/downgrading-a-sponsorship)") | +| `sponsor_sponsorship_create` | Acionada quando você patrocina uma conta (consulte "[Patrocinar um contribuidor de código aberto](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") | +| `sponsor_sponsorship_payment_complete` | Acionada depois que você patrocinar uma conta e seu pagamento ser processado (consulte [Patrocinando um colaborador de código aberto](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") | +| `sponsor_sponsorship_preference_change` | Acionada quando você altera o recebimento de atualizações de e-mail de um desenvolvedor patrocinado (consulte "[Gerenciar o patrocínio](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") | +| `sponsor_sponsorship_tier_change` | Acionada quando você faz upgrade ou downgrade do patrocínio (consulte "[Atualizar um patrocínio](/articles/upgrading-a-sponsorship)" e "[Fazer downgrade de um patrocínio](/articles/downgrading-a-sponsorship)") | +| `sponsored_developer_approve` | Acionada quando sua conta do {% data variables.product.prodname_sponsors %} é aprovada (consulte "[Configuração de {% data variables.product.prodname_sponsors %} para sua conta pessoal](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | +| `sponsored_developer_create` | Acionada quando sua conta de {% data variables.product.prodname_sponsors %} é criada (consulte "[Configurar {% data variables.product.prodname_sponsors %} para sua conta pessoal](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | +| `sponsored_developer_disable` | Acionada quando sua conta {% data variables.product.prodname_sponsors %} está desabilitado | +| `sponsored_developer_redraft` | Acionada quando sua conta de {% data variables.product.prodname_sponsors %} é retornada ao estado de rascunho a partir do estado aprovado | +| `sponsored_developer_profile_update` | Acionada quando você edita seu perfil de desenvolvedor patrocinado (consulte "[Editar informações de perfil para {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") | +| `sponsored_developer_request_approval` | Acionada quando você enviar seu aplicativo para {% data variables.product.prodname_sponsors %} para aprovação (consulte "[Configurar {% data variables.product.prodname_sponsors %} para sua conta pessoal](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | +| `sponsored_developer_tier_description_update` | Acionada quando você altera a descrição de uma camada de patrocínio (consulte "[Gerenciar suas camadas de patrocínio](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") | +| `sponsored_developer_update_newsletter_send` | Acionada quando você envia uma atualização por e-mail aos patrocinadores (consulte "[Entrar em contato com os patrocinadores](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") | +| `waitlist_invite_sponsored_developer` | Acionada quando você é convidado a juntar-se a {% data variables.product.prodname_sponsors %} a partir da lista de espera (consulte "[Configurar {% data variables.product.prodname_sponsors %} para sua conta pessoal](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | +| `waitlist_join` | Acionada quando você se junta à lista de espera para tornar-se um desenvolvedor patrocinado (consulte "[Configurar {% data variables.product.prodname_sponsors %} para sua conta pessoal](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | {% endif %} {% ifversion fpt or ghec %} ### ações de categoria `successor_invitation` -| Ação | Descrição | -| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aceitar` | Triggered when you accept a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | -| `cancelar` | Triggered when you cancel a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | -| `create` | Triggered when you create a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | -| `recusar` | Triggered when you decline a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | -| `revogar` | Triggered when you revoke a succession invitation (see "[Maintaining ownership continuity of your personal account's repositories](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | +| Ação | Descrição | +| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `aceitar` | Acionada quando você aceita um convite de sucessão (consulte "[Manter a continuidade da propriedade dos repositórios da conta pessoal](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | +| `cancelar` | Acionada quando você cancela um convite de sucessão (consulte "[Manter a continuidade da propriedade dos repositórios da conta pessoal](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | +| `create` | Acionada quando você cancela um convite de sucessão (consulte "[Manter a continuidade da propriedade dos repositórios da conta pessoal](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | +| `recusar` | Acionado quando você recusa um convite de sucessão (consulte "[Manter a continuidade da propriedade dos repositórios da sua conta pessoal](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | +| `revogar` | Acionada quando você revoga um convite de sucessão (consulte "[Manter a continuidade da propriedade dos repositórios da conta pessoal](/github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories)") | {% endif %} {% ifversion ghes or ghae %} @@ -236,16 +236,16 @@ Uma visão geral de algumas das ações mais comuns que são registradas como ev ### ações de categoria `user` -| Ação | Descrição | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `add_email` | Acionada quando você | -| {% ifversion not ghae %}[adiciona um novo endereço de e-mail](/articles/changing-your-primary-email-address){% else %}adiciona um novo endereço de e-mail{% endif %}.{% ifversion fpt or ghec %} | | -| `codespaces_trusted_repo_access_granted` | Triggered when you [allow the codespaces you create for a repository to access other repositories owned by your personal account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | -| `codespaces_trusted_repo_access_revoked` | Triggered when you [disallow the codespaces you create for a repository to access other repositories owned by your personal account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). |{% endif %} -| `create` | Triggered when you create a new personal account.{% ifversion not ghae %} -| `change_password` | Acionada quando você altera a senha. | +| Ação | Descrição | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `add_email` | Acionada quando você | +| {% ifversion not ghae %}[adiciona um novo endereço de e-mail](/articles/changing-your-primary-email-address){% else %}adiciona um novo endereço de e-mail{% endif %}.{% ifversion fpt or ghec %} | | +| `codespaces_trusted_repo_access_granted` | Acionada quando você [permite codespaces criados para um repositório acessar outros repositórios pertencentes à sua conta pessoal](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). | +| `codespaces_trusted_repo_access_revoked` | Acionada quando você [cancela a permissão de codespaces criados para um repositório acessar outros repositórios pertencentes à sua conta pessoal](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). |{% endif %} +| `create` | Acionada quando você cria uma nova conta pessoal.{% ifversion not ghae %} +| `change_password` | Acionada quando você altera a senha. | | `forgot_password` | Acionada quando você solicita [a redefinição da senha](/articles/how-can-i-reset-my-password).{% endif %} -| `hide_private_contributions_count` | Acionada quando você [oculta as contribuições privadas no seu perfil](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile). | +| `hide_private_contributions_count` | Acionada quando você [oculta as contribuições privadas no seu perfil](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile). | | `login` | Acionada quando você efetua o login em {% data variables.product.product_location %}.{% ifversion ghes or ghae %} diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md index 3e1585ebc6..9d8de4f6d8 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md @@ -20,7 +20,7 @@ Antes de adicionar uma nova chave GPG à sua conta em {% ifversion ghae %}{% dat - [Verificado a existência de chaves GPG](/articles/checking-for-existing-gpg-keys) - [Gerado e copiado uma nova chave GPG](/articles/generating-a-new-gpg-key) -You can add multiple public keys to your GitHub account. Commits signed by any of the corresponding private keys will show as verified. If you remove a public key, any commits signed by the corresponding private key will no longer show as verified. +Você pode adicionar várias chaves públicas à sua conta do GitHub. Os commits assinados por qualquer uma das chaves privadas correspondentes serão exibidos como verificado. Se você remover uma chave pública, todos os commits assinados pela chave privada correspondente não serão mais mostrados como verificados. {% data reusables.gpg.supported-gpg-key-algorithms %} diff --git a/translations/pt-BR/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md b/translations/pt-BR/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md index 74076354e7..71b506d073 100644 --- a/translations/pt-BR/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md +++ b/translations/pt-BR/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md @@ -16,6 +16,6 @@ topics: shortTitle: Permissão negada por outro repositório --- -To fix this, remove the deploy key from the repository, and [add the key to your personal account](/articles/adding-a-new-ssh-key-to-your-github-account) instead. +Para corrigir isso, remova a chave de implantação do repositório, e [adicione a chave à sua conta pessoal](/articles/adding-a-new-ssh-key-to-your-github-account). Caso a chave deva ser utilizada como uma chave de implantação, consulte [o guia de chaves de implantação](/guides/managing-deploy-keys) para mais informações. diff --git a/translations/pt-BR/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md b/translations/pt-BR/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md index 948b054f8e..fec09ab851 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md +++ b/translations/pt-BR/content/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions.md @@ -33,9 +33,9 @@ Assim que você definir um limite de gastos diferente de $ 0, você será respon Como você não habilitou os excedentes, a sua próxima tentativa de criar um artefato de fluxo de trabalho falhará. Você não receberá uma fatura pelo excesso de 0.1GB naquele mês. No entanto, se você habilitar os excedentes, a sua primeira conta incluirá o 0,1 GB do excedente existente para o ciclo de cobrança atual, bem como qualquer superação adicional que você acumular. -## Managing the spending limit for {% data variables.product.prodname_actions %} for your personal account +## Gerenciando o limite de gastos de {% data variables.product.prodname_actions %} para a sua conta pessoal -Anyone can manage the spending limit for {% data variables.product.prodname_actions %} for their own personal account. +Qualquer pessoa pode gerenciar o limite de gastos de {% data variables.product.prodname_actions %} para sua própria conta pessoal. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/translations/pt-BR/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md b/translations/pt-BR/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md index 7e2a01db1f..49c6faaee1 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md +++ b/translations/pt-BR/content/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage.md @@ -18,9 +18,9 @@ shortTitle: Visualizar o uso das suas ações Você também pode visualizar os minutos de execução do trabalho faturáveis para uma execução de fluxo de trabalho individual. Para obter mais informações, consulte "[Visualizar o tempo de execução do trabalho](/actions/managing-workflow-runs/viewing-job-execution-time)". -## Viewing {% data variables.product.prodname_actions %} usage for your personal account +## Visualizando o uso de {% data variables.product.prodname_actions %} para a sua conta pessoal -Anyone can view {% data variables.product.prodname_actions %} usage for their own personal account. +Qualquer um pode ver o uso de {% data variables.product.prodname_actions %} para sua própria conta pessoal. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/translations/pt-BR/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md b/translations/pt-BR/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md index 0a3804357f..d088a890da 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md +++ b/translations/pt-BR/content/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security.md @@ -25,7 +25,7 @@ shortTitle: Cobrança da segurança avançada Se você quiser usar as funcionalidades do {% data variables.product.prodname_GH_advanced_security %} em qualquer repositório, além de um repositório público em {% data variables.product.prodname_dotcom_the_website %}, você precisará de uma licença de {% data variables.product.prodname_GH_advanced_security %}, disponível com {% data variables.product.prodname_ghe_cloud %} ou {% data variables.product.prodname_ghe_server %}. Para obter mais informações sobre {% data variables.product.prodname_GH_advanced_security %}, consulte "[Sobre {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)." -For more information about billing for {% data variables.product.prodname_GH_advanced_security %}, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security). +Para obter mais informações sobre cobrança para {% data variables.product.prodname_GH_advanced_security %}, consulte a [documentação de {% data variables.product.prodname_ghe_cloud %}](/enterprise-cloud@latest/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security). {% elsif ghec %} diff --git a/translations/pt-BR/content/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces.md b/translations/pt-BR/content/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces.md index c9cf5b88ea..257b0505ea 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces.md +++ b/translations/pt-BR/content/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces.md @@ -56,9 +56,9 @@ Para obter informações sobre como gerenciar e alterar o limite de gastos da su ## Limitando a escolha dos tipos de máquina -By default the machine type with the lowest valid resources is used when a codespace is created. However, users may be able to choose a machine type with more resources. They can do this either when they create a codespace, or they can change the machine type of an existing codespace. For more information, see "[Creating a codespace"](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)" and "[Changing the machine type for your codespace](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace)." +Por padrão, usa-se o tipo de máquina com os recursos mais baixos válidos quando um código é criado. No entanto, os usuários podem escolher um tipo de máquina com mais recursos. Eles podem fazê-lo ao criar um codespace ou podem alterar o tipo de máquina de um codespace existente. Para obter mais informações, consulte "[Criando um codespace"](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)" e "[Alterando o tipo de máquina para o seu codespace](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace)". -If a machine type that has more resources is chosen, this will affect the per-minute charge for that codespace, as shown above. +Se um tipo de máquina com mais recursos for escolhido, isso afetará a carga por minuto desse codespace, como mostrado acima. Os proprietários da organização podem criar uma política para restringir os tipos de máquina disponíveis para os usuários. Para obter mais informações, consulte "[Restringindo o acesso aos tipos de máquina](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)." diff --git a/translations/pt-BR/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md b/translations/pt-BR/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md index 34b11dc895..f94efde8dc 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md +++ b/translations/pt-BR/content/billing/managing-billing-for-github-packages/managing-your-spending-limit-for-github-packages.md @@ -34,9 +34,9 @@ Assim que você definir um limite de gastos diferente de $ 0, você será respon Como você não ativou os excessos, sua próxima tentativa de publicar uma versão do pacote irá falhar. Você não receberá uma fatura pelo excesso de 0.1GB naquele mês. No entanto, se você habilitar os excedentes, a sua primeira conta incluirá o 0,1 GB do excedente existente para o ciclo de cobrança atual, bem como qualquer superação adicional que você acumular. -## Managing the spending limit for {% data variables.product.prodname_registry %} for your personal account +## Gerenciando o limite de gastos de {% data variables.product.prodname_registry %} para a sua conta pessoal -Anyone can manage the spending limit for {% data variables.product.prodname_registry %} for their own personal account. +Qualquer pessoa pode gerenciar o limite de gastos de {% data variables.product.prodname_registry %} para sua própria conta pessoal. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/translations/pt-BR/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md b/translations/pt-BR/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md index a71eaac523..0e6dceafe3 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md +++ b/translations/pt-BR/content/billing/managing-billing-for-github-packages/viewing-your-github-packages-usage.md @@ -17,9 +17,9 @@ topics: shortTitle: Visualizar o seu uso --- -## Viewing {% data variables.product.prodname_registry %} usage for your personal account +## Visualizando o uso de {% data variables.product.prodname_registry %} para a sua conta pessoal -Anyone can view {% data variables.product.prodname_registry %} usage for their own personal account. +Qualquer pessoa pode ver o uso de {% data variables.product.prodname_registry %} para sua própria conta pessoal. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/translations/pt-BR/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md b/translations/pt-BR/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md index 2204b9982a..7aa9d96ca2 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md +++ b/translations/pt-BR/content/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription.md @@ -31,16 +31,16 @@ shortTitle: Downgrade da assinatura ## Rebaixando sua assinatura {% data variables.product.product_name %} -When you downgrade your personal account or organization's subscription, pricing and account feature changes take effect on your next billing date. Changes to your paid personal account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features. Para obter mais informações, consulte "[Como a atualização ou o downgrade afeta o processo de cobrança?](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process)." +Quando você faz o downgrade a assinatura da sua conta pessoal ou organização, as alterações de preços e recursos da conta fazem efeito a partir da próxima data de faturamento. Alterações em sua conta pessoal paga ou assinatura de organização não afetam assinaturas ou pagamentos para outras funcionalidades pagas {% data variables.product.prodname_dotcom %}. Para obter mais informações, consulte "[Como a atualização ou o downgrade afeta o processo de cobrança?](/articles/how-does-upgrading-or-downgrading-affect-the-billing-process)." -## Downgrading your personal account's subscription +## Fazendo o downgrade da assinatura da sua conta pessoal -If you downgrade your personal account from {% data variables.product.prodname_pro %} to {% data variables.product.prodname_free_user %}, the account will lose access to advanced code review tools on private repositories. {% data reusables.gated-features.more-info %} +Se você fizer o downgrade da sua conta pessoal de {% data variables.product.prodname_pro %} para {% data variables.product.prodname_free_user %}, a conta perderá o acesso a ferramentas avançadas de revisão de código em repositórios privados. {% data reusables.gated-features.more-info %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} 1. Em "Plano atual", use o menu suspenso **Editar** e clique em **Fazer downgrade para grátis**. ![Botão Downgrade to free (Fazer downgrade para o Free)](/assets/images/help/billing/downgrade-to-free.png) -5. Read the information about the features your personal account will no longer have access to on your next billing date, then click **I understand. Continue com o downgrade**. ![Continuar com o botão de downgrade](/assets/images/help/billing/continue-with-downgrade.png) +5. Leia as informações sobre as funcionalidades às quais a sua conta pessoal não terá mais acesso na sua próxima data de cobrança e, em seguida, clique em **Eu entendo. Continue com o downgrade**. ![Continuar com o botão de downgrade](/assets/images/help/billing/continue-with-downgrade.png) Se você tiver publicado um site do {% data variables.product.prodname_pages %} em um repositório privado e adicionado um domínio personalizado, remova ou atualize seus registros DNS antes de fazer downgrade do {% data variables.product.prodname_pro %} para {% data variables.product.prodname_free_user %}, a fim de evitar o risco de uma aquisição de domínio. Para obter mais informações, consulte "[Gerenciar um domínio personalizado para seu site do {% data variables.product.prodname_pages %}](/articles/managing-a-custom-domain-for-your-github-pages-site)". diff --git a/translations/pt-BR/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md b/translations/pt-BR/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md index 184a948d27..40487089e6 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md +++ b/translations/pt-BR/content/billing/managing-billing-for-your-github-account/how-does-upgrading-or-downgrading-affect-the-billing-process.md @@ -17,7 +17,7 @@ topics: shortTitle: Processo de cobrança --- -Changes to your paid personal account or organization subscription does not affect subscriptions or payments for other paid {% data variables.product.prodname_dotcom %} features, such as {% data variables.large_files.product_name_long %} or paid apps purchased in {% data variables.product.prodname_marketplace %}. +As alterações na sua conta pessoal paga ou assinatura da organização não afetam as assinaturas ou pagamentos para outras funcionalidades pagas de {% data variables.product.prodname_dotcom %}, como {% data variables.large_files.product_name_long %} ou aplicativos pagos comprados em {% data variables.product.prodname_marketplace %}. Para obter mais informações, consulte "produtos do [{% data variables.product.prodname_dotcom %}](/articles/github-s-products)" e "[Sobre cobrança em {% data variables.product.prodname_dotcom %}](/articles/about-billing-on-github)". diff --git a/translations/pt-BR/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md b/translations/pt-BR/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md index 441145db8d..3e2d17bd03 100644 --- a/translations/pt-BR/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md +++ b/translations/pt-BR/content/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription.md @@ -40,7 +40,7 @@ Ao atualizar a assinatura de uma conta, a atualização altera as funcionalidade ## Atualizar a assinatura da sua conta pessoal -You can upgrade your personal account from {% data variables.product.prodname_free_user %} to {% data variables.product.prodname_pro %} to get advanced code review tools on private repositories owned by your personal account. A atualização de sua conta pessoal não afeta nenhuma organização que você possa gerenciar ou repositórios pertencentes a essas organizações. {% data reusables.gated-features.more-info %} +Você pode atualizar sua conta pessoal de {% data variables.product.prodname_free_user %} para {% data variables.product.prodname_pro %} para ter ferramentas avançadas de revisão de código em repositórios privados pertencentes à sua conta pessoal. A atualização de sua conta pessoal não afeta nenhuma organização que você possa gerenciar ou repositórios pertencentes a essas organizações. {% data reusables.gated-features.more-info %} {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.billing_plans %} diff --git a/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md b/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md index 5f847c6872..e99d02299a 100644 --- a/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md +++ b/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/about-visual-studio-subscriptions-with-github-enterprise.md @@ -23,15 +23,15 @@ shortTitle: Sobre {% data reusables.enterprise-accounts.vss-ghe-description %} {% data variables.product.prodname_vss_ghe %} está disponível na Microsoft nos termos do Contrato corporativo da Microsoft. Para obter mais informações, consulte [{% data variables.product.prodname_vss_ghe %}](https://visualstudio.microsoft.com/subscriptions/visual-studio-github/) no site {% data variables.product.prodname_vs %} -To use the {% data variables.product.prodname_enterprise %} portion of the license, each subscriber's personal account on {% data variables.product.prodname_dotcom_the_website %} must be or become a member of an organization owned by your enterprise on {% data variables.product.prodname_dotcom_the_website %}. Para isso, os proprietários da organização podem convidar novos integrantes para uma organização por e-mail. The subscriber can accept the invitation with an existing personal account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. +Para usar a parte da licença de {% data variables.product.prodname_enterprise %}, a conta pessoal de cada usuário assinante no {% data variables.product.prodname_dotcom_the_website %} deve ser ou tornar-se integrante de uma organização de propriedade da sua empresa em {% data variables.product.prodname_dotcom_the_website %}. Para isso, os proprietários da organização podem convidar novos integrantes para uma organização por e-mail. O assinante pode aceitar o convite com uma conta pessoal existente em {% data variables.product.prodname_dotcom_the_website %} ou criar uma nova conta. Para obter mais informações sobre a configuração de {% data variables.product.prodname_vss_ghe %}, consulte "[Configurando o {% data variables.product.prodname_vss_ghe %}](/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise)". ## Sobre as licenças para {% data variables.product.prodname_vss_ghe %} -After you assign a license for {% data variables.product.prodname_vss_ghe %} to a subscriber, the subscriber will use the {% data variables.product.prodname_enterprise %} portion of the license by joining an organization in your enterprise with a personal account on {% data variables.product.prodname_dotcom_the_website %}. If the email address for the personal account of an enterprise member on {% data variables.product.prodname_dotcom_the_website %} matches the User Primary Name (UPN) for a subscriber to your {% data variables.product.prodname_vs %} account, the {% data variables.product.prodname_vs %} subscriber will automatically consume one license for {% data variables.product.prodname_vss_ghe %}. +Depois de atribuir uma licença de {% data variables.product.prodname_vss_ghe %} a um assinante, o integrante usará a parte {% data variables.product.prodname_enterprise %} da licença, juntando-se a uma organização na sua empresa com uma conta pessoal no {% data variables.product.prodname_dotcom_the_website %}. Se o endereço de e-mail para a conta pessoal de um integrante corporativo em {% data variables.product.prodname_dotcom_the_website %} corresponde ao Nome Principal do Usuário (UPN) de um assinante da sua conta {% data variables.product.prodname_vs %} o {% data variables.product.prodname_vs %} assinante consumirá automaticamente uma licença para {% data variables.product.prodname_vss_ghe %}. -A quantidade total de suas licenças para a sua empresa em {% data variables.product.prodname_dotcom %} é a soma de qualquer licença padrão de {% data variables.product.prodname_enterprise %} e o número de licenças de assinatura {% data variables.product.prodname_vs %} que incluem acesso a {% data variables.product.prodname_dotcom %}. If the personal account for an enterprise member does not correspond with the email address for a {% data variables.product.prodname_vs %} subscriber, the license that the personal account consumes is unavailable for a {% data variables.product.prodname_vs %} subscriber. +A quantidade total de suas licenças para a sua empresa em {% data variables.product.prodname_dotcom %} é a soma de qualquer licença padrão de {% data variables.product.prodname_enterprise %} e o número de licenças de assinatura {% data variables.product.prodname_vs %} que incluem acesso a {% data variables.product.prodname_dotcom %}. Se a conta pessoal de um integrante corporativo não corresponde ao endereço de e-mail de um assinante de {% data variables.product.prodname_vs %}, a licença que a conta pessoal consome não estará disponível para um assinante de {% data variables.product.prodname_vs %}. Para obter mais informações sobre o {% data variables.product.prodname_enterprise %}, consulte "[Produtos do {% data variables.product.company_short %}](/github/getting-started-with-github/githubs-products#github-enterprise)". Para obter mais informações sobre contas em {% data variables.product.prodname_dotcom_the_website %}, consulte "[Tipos de contas de {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/types-of-github-accounts)". diff --git a/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md b/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md index 5a8661a327..d926a547bc 100644 --- a/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md +++ b/translations/pt-BR/content/billing/managing-licenses-for-visual-studio-subscriptions-with-github-enterprise/setting-up-visual-studio-subscriptions-with-github-enterprise.md @@ -22,13 +22,13 @@ Se você preferir vídeo, você pode assistir [Configurando suas licenças de {% Antes de configurar {% data variables.product.prodname_vss_ghe %}, é importante entender as funções para esta oferta combinada. -| Função | Serviço | Descrição | Mais informações | -|:-------------------------------- |:------------------------------------------------------ |:----------------------------------------------------------------------------------------------------------------------------------------------- |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Administrador de assinaturas** | Assinatura de {% data variables.product.prodname_vs %} | Pessoa que atribui licenças para a assinatura de {% data variables.product.prodname_vs %} | [Visão geral das responsabilidades do administrador](https://docs.microsoft.com/en-us/visualstudio/subscriptions/admin-responsibilities) na documentação da Microsoft | -| **Assinante** | Assinatura de {% data variables.product.prodname_vs %} | Pessoa que usa uma licença para assinatura de {% data variables.product.prodname_vs %} | [Assinaturas do Visual Studio](https://docs.microsoft.com/en-us/visualstudio/subscriptions/) na documentação da Microsoft | -| **Proprietário corporativo** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's an administrator of an enterprise on {% data variables.product.product_location %} | "[Funções em uma empresa](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)" | -| **Proprietário da organização** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's an owner of an organization in your team's enterprise on {% data variables.product.product_location %} | "[Funções em uma organização](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)" | -| **Integrante da empresa** | {% data variables.product.prodname_dotcom %} | Person who has a personal account that's a member of an enterprise on {% data variables.product.product_location %} | "[Funções em uma empresa](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-members)" | +| Função | Serviço | Descrição | Mais informações | +|:-------------------------------- |:------------------------------------------------------ |:------------------------------------------------------------------------------------------------------------------------------------------------ |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Administrador de assinaturas** | Assinatura de {% data variables.product.prodname_vs %} | Pessoa que atribui licenças para a assinatura de {% data variables.product.prodname_vs %} | [Visão geral das responsabilidades do administrador](https://docs.microsoft.com/en-us/visualstudio/subscriptions/admin-responsibilities) na documentação da Microsoft | +| **Assinante** | Assinatura de {% data variables.product.prodname_vs %} | Pessoa que usa uma licença para assinatura de {% data variables.product.prodname_vs %} | [Assinaturas do Visual Studio](https://docs.microsoft.com/en-us/visualstudio/subscriptions/) na documentação da Microsoft | +| **Proprietário corporativo** | {% data variables.product.prodname_dotcom %} | Pessoa que tem uma conta pessoal que é administrador de uma empresa em {% data variables.product.product_location %} | "[Funções em uma empresa](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)" | +| **Proprietário da organização** | {% data variables.product.prodname_dotcom %} | Pessoa que tem uma conta pessoal que é proprietário de uma organização na empresa da sua equipe em {% data variables.product.product_location %} | "[Funções em uma organização](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#organization-owners)" | +| **Integrante da empresa** | {% data variables.product.prodname_dotcom %} | Pessoa que tem uma conta pessoal que é integrante de uma empresa em {% data variables.product.product_location %} | "[Funções em uma empresa](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-members)" | ## Pré-requisitos @@ -50,14 +50,14 @@ Uma pessoa pode ser capaz de concluir as tarefas porque a pessoa tem todas as fu 1. Se o administrador da assinatura não tiver desabilitado as notificações por e-mail, o assinante receberá dois e-mails de confirmação. Para obter mais informações, consulte [Assinaturas de {% data variables.product.prodname_vs %} com {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/en-us/visualstudio/subscriptions/access-github#what-is-the-visual-studio-subscription-with-github-enterprise-setup-process) na documentação da Microsoft. -1. O proprietário de uma organização deve convidar o integrante para a organização no {% data variables.product.product_location %} a partir da etapa 1. The subscriber can accept the invitation with an existing personal account on {% data variables.product.prodname_dotcom_the_website %} or create a new account. Depois que o assinante aderir à organização, o assinante torna-se um integrante da empresa. Para obter mais informações, consulte "[Convidar usuários para participar da sua organização](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)". +1. O proprietário de uma organização deve convidar o integrante para a organização no {% data variables.product.product_location %} a partir da etapa 1. O assinante pode aceitar o convite com uma conta pessoal existente em {% data variables.product.prodname_dotcom_the_website %} ou criar uma nova conta. Depois que o assinante aderir à organização, o assinante torna-se um integrante da empresa. Para obter mais informações, consulte "[Convidar usuários para participar da sua organização](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)". {% tip %} **Dicas**: - Embora não seja necessário, recomendamos que o proprietário da organização envie um convite para o mesmo endereço de e-mail usado para o nome primário do usuário do assinante (UPN). Quando o endereço de e-mail em {% data variables.product.product_location %} corresponder ao UPN do assinante, você poderá garantir que outra empresa não reivindique a licença do assinante. - - If the subscriber accepts the invitation to the organization with an existing personal account on {% data variables.product.product_location %}, we recommend that the subscriber add the email address they use for {% data variables.product.prodname_vs %} to their personal account on {% data variables.product.product_location %}. Para obter mais informações, consulte "[Adicionar um endereço de e-mail à sua conta de {% data variables.product.prodname_dotcom %}](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account)". + - Se o assinante aceitar o convite para a organização com uma conta pessoal existente em {% data variables.product.product_location %}, recomendamos que o assinante adicione o endereço de e-mail que ele usa para {% data variables.product.prodname_vs %} à sua conta pessoal em {% data variables.product.product_location %}. Para obter mais informações, consulte "[Adicionar um endereço de e-mail à sua conta de {% data variables.product.prodname_dotcom %}](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account)". - Se o proprietário da organização tiver de convidar um grande número de assinantes, um script poderá agilizar o processo. Para obter mais informações, consulte [a amostra de script do PowerShell](https://github.com/github/platform-samples/blob/master/api/powershell/invite_members_to_org.ps1) no repositório `github/platform-samples`. {% endtip %} diff --git a/translations/pt-BR/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md b/translations/pt-BR/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md index c407624240..eca7fc1397 100644 --- a/translations/pt-BR/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md +++ b/translations/pt-BR/content/billing/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md @@ -15,7 +15,7 @@ topics: shortTitle: Sobre organizações --- -To access an organization, each member must sign into their own personal account. +Para acessar uma organização, cada integrante deve efetuar o login em sua própria conta pessoal. Os integrantes da organização podem ter diferentes funções, como *proprietário* ou *gerente de cobrança*: diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 3b0a31c77f..8e17b6479c 100644 --- a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -82,14 +82,14 @@ Os proprietários da empresa, administradores de organização e repositórios p {% ifversion fpt %} -You can set up {% data variables.product.prodname_code_scanning %} in any public repository where you have write access. +Você pode configurar {% data variables.product.prodname_code_scanning %} em qualquer repositório público onde tenha acesso de gravação. {% endif %} {% data reusables.code-scanning.billing %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -1. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**.{% ifversion ghec or ghes or ghae %} If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}.{% endif %} For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." ![Botão "Configurar {% data variables.product.prodname_code_scanning %}" à direita de "{% data variables.product.prodname_code_scanning_capc %}" na Visão Geral de Segurança](/assets/images/help/security/overview-set-up-code-scanning.png) +1. À direita dos alertas de "{% data variables.product.prodname_code_scanning_capc %} ", clique em **Configurar {% data variables.product.prodname_code_scanning %}**.{% ifversion ghec or ghes or ghae %} Se faltar {% data variables.product.prodname_code_scanning %}, você deverá pedir a um proprietário ou administrador da organização que havilite o {% data variables.product.prodname_GH_advanced_security %}.{% endif %} Para obter mais informações, consulte "[Gerenciando as configurações de segurança e análise da sua organização](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" ou "[gerenciando configurações de segurança e análise do seu repositório](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)". ![Botão "Configurar {% data variables.product.prodname_code_scanning %}" à direita de "{% data variables.product.prodname_code_scanning_capc %}" na Visão Geral de Segurança](/assets/images/help/security/overview-set-up-code-scanning.png) 4. Em "Começar com {% data variables.product.prodname_code_scanning %}", clique em **Configurar este fluxo de trabalho** no {% data variables.product.prodname_codeql_workflow %} ou em um fluxo de trabalho de terceiros. !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png)Os fluxos de trabalho são exibidos apenas se forem relevantes para as linguagens de programação detectadas no repositório. O {% data variables.product.prodname_codeql_workflow %} é sempre exibido, mas o botão "Configurar este fluxo de trabalho" só é habilitado se a análise de {% data variables.product.prodname_codeql %} for compatível com as linguagens presentes no repositório. 5. Para personalizar como {% data variables.product.prodname_code_scanning %} faz a varredura do seu código, edite o fluxo de trabalho. @@ -147,7 +147,7 @@ Os nomes das verificações de análise de {% data variables.product.prodname_co ![Verificações de pull request de {% data variables.product.prodname_code_scanning %}](/assets/images/help/repository/code-scanning-pr-checks.png) -Quando os trabalhos de {% data variables.product.prodname_code_scanning %} forem concluídos, {% data variables.product.prodname_dotcom %} calcula se quaisquer alertas foram adicionados pelo pull request e adiciona a entrada "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" à lista de verificações. Depois de {% data variables.product.prodname_code_scanning %} ser executado pelo menos uma vez, você poderá clicar em **Detalhes** para visualizar os resultados da análise. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +Quando os trabalhos de {% data variables.product.prodname_code_scanning %} forem concluídos, {% data variables.product.prodname_dotcom %} calcula se quaisquer alertas foram adicionados pelo pull request e adiciona a entrada "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" à lista de verificações. Depois de {% data variables.product.prodname_code_scanning %} ser executado pelo menos uma vez, você poderá clicar em **Detalhes** para visualizar os resultados da análise. Se você usou um pull request para adicionar {% data variables.product.prodname_code_scanning %} ao repositório, inicialmente você verá uma mensagem de {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %} "Análise não encontrada"{% else %}"Análise ausente"{% endif %} ao clicar em **Detalhes** na verificação de "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %} ![Análise não encontrada para mensagem de commit](/assets/images/help/repository/code-scanning-analysis-not-found.png) @@ -165,7 +165,7 @@ Por exemplo, na captura de tela acima, {% data variables.product.prodname_code_s ### Motivos para a mensagem "Análise ausente" {% endif %} -Depois que {% data variables.product.prodname_code_scanning %} analisou o código em um pull request, ele precisa comparar a análise do branch de tópico (o branch que você usou para criar o pull request) com a análise do branch de base (o branch no qual você deseja mesclar o pull request). Isso permite que {% data variables.product.prodname_code_scanning %} calcule quais alertas foram recém-introduzidos pelo pull request, que alertas já estavam presentes no branch de base e se alguns alertas existentes são corrigidos pelas alterações no pull request. Inicialmente, se você usar um pull request para adicionar {% data variables.product.prodname_code_scanning %} a um repositório, o branch de base ainda não foi analisado. Portanto, não é possível computar esses detalhes. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +Depois que {% data variables.product.prodname_code_scanning %} analisou o código em um pull request, ele precisa comparar a análise do branch de tópico (o branch que você usou para criar o pull request) com a análise do branch de base (o branch no qual você deseja mesclar o pull request). Isso permite que {% data variables.product.prodname_code_scanning %} calcule quais alertas foram recém-introduzidos pelo pull request, que alertas já estavam presentes no branch de base e se alguns alertas existentes são corrigidos pelas alterações no pull request. Inicialmente, se você usar um pull request para adicionar {% data variables.product.prodname_code_scanning %} a um repositório, o branch de base ainda não foi analisado. Portanto, não é possível computar esses detalhes. Neste caso, quando você clicar nos resultados verificando o pull request você verá a mensagem {% ifversion fpt or ghes > 3.2 or ghae-issue-3891 or ghec %}"Análise não encontrada"{% else %}"Análise ausente do commit base SHA-HASH"{% endif %}. Há outras situações em que não pode haver análise para o último commit do branch de base para um pull request. Isso inclui: diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md index 7d78ce5801..7121f308f2 100644 --- a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow.md @@ -158,6 +158,11 @@ Isso faz o upload do banco de dados como um artefato de ações que você pode b O artefato conterá uma cópia arquivada dos arquivos de origem digitalizados por {% data variables.product.prodname_codeql %} denominada _src.zip_. Se você comparar os arquivos do código-fonte no repositório e os arquivos em _src. ip_, você poderá ver quais tipos de arquivo estarão faltando. Uma vez que você sabe quais tipos de arquivo não estão sendo analisados, é mais fácil entender como você pode precisar alterar o fluxo de trabalho para a análise de {% data variables.product.prodname_codeql %}. +## Alerts found in generated code + +{% data reusables.code-scanning.alerts-found-in-generated-code %} + + ## Erros de extração no banco de dados A equipe de {% data variables.product.prodname_codeql %} trabalha constantemente em erros críticos de extração para garantir que todos os arquivos de origem possam ser digitalizados. No entanto, os extratores de {% data variables.product.prodname_codeql %} às vezes geram erros durante a criação do banco de dados. {% data variables.product.prodname_codeql %} fornece informações sobre erros de extração e avisos gerados durante a criação do banco de dados em um arquivo de registro. A informação sobre o diagnóstico de extração fornece uma indicação da saúde geral do banco de dados. A maioria dos erros dos extratores não impactam a análise significativamente. Um pequeno número de erros de extrator é saudável e normalmente indica um bom estado de análise. @@ -187,9 +192,7 @@ O {% data variables.product.prodname_codeql_workflow %} padrão usa uma matriz d O tempo de análise é tipicamente proporcional à quantidade de código em análise. Você pode reduzir o tempo de análise reduzindo a quantidade de código em análise de uma vez, por exemplo, excluindo o código de teste, ou dividindo a análise em vários fluxos de trabalho que analisam apenas um subconjunto do seu código por vez. -Para linguagens compiladas como Java, C, C++ e C#, o {% data variables.product.prodname_codeql %} analisa todo o código construído durante a execução do fluxo de trabalho. Para limitar a quantidade de código em análise, crie apenas o código que você deseja analisar especificando suas próprias etapas de criação em um bloco `Executar`. Você pode combinar a especificação das suas próprias etapas de criação ao usar os filtros `caminhos` ou `paths-ignore` nos eventos `pull_request` e `push` para garantir que o seu fluxo de trabalho só será executado quando o código específico for alterado. Para obter mais informações, consulte "[Sintaxe de fluxo de trabalho para o {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)". - -Para linguagens como Go, JavaScript, Python e TypeScript, que {% data variables.product.prodname_codeql %} analisa sem compilar o código-fonte, você pode especificar as opções de configuração adicionais para limitar a quantidade de código a ser analisado. Para obter mais informações, consulte "[Especificar diretórios a serem varridos](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)". +{% data reusables.code-scanning.alerts-found-in-generated-code %} Se você dividir sua análise em vários fluxos de trabalho, conforme descrito acima, ainda assim recomendamos que você tenha pelo menos um fluxo de trabalho que seja executado em um `agendamento` que analise todo o código no seu repositório. Já que o {% data variables.product.prodname_codeql %} analisa os fluxos de dados entre os componentes, alguns comportamentos de segurança complexos só podem ser detectados em uma criação completa. diff --git a/translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md b/translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md index 28837206e7..ac0e62d188 100644 --- a/translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md +++ b/translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md @@ -65,7 +65,7 @@ Você precisa disponibilizar todo o conteúdo do pacote {% data variables.produc ```shell $ wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-bundle-linux64.tar.gz -$ tar -xvzf ../codeql-bundle-linux64.tar.gz +$ tar -xvzf ./codeql-bundle-linux64.tar.gz ``` Depois de extrair o pacote do {% data variables.product.prodname_codeql_cli %}, você poderá executar o executável `codeql` no servidor: diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md index 30e864f09d..83bbc87f3d 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md +++ b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md @@ -1,7 +1,7 @@ --- -title: Configuring Dependabot alerts -intro: 'Enable {% data variables.product.prodname_dependabot_alerts %} to be notified when a new vulnerability is found in one of your dependencies.' -shortTitle: Configure Dependabot alerts +title: Configurando alertas do Dependabot +intro: 'Habilite {% data variables.product.prodname_dependabot_alerts %} para ser notificado quando uma nova vulnerabilidade for encontrada em uma de suas dependências.' +shortTitle: Configurar alertas Dependabot versions: fpt: '*' ghes: '*' @@ -17,89 +17,89 @@ topics: - Repositories --- -## About {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies +## Sobre {% data variables.product.prodname_dependabot_alerts %} para dependências vulneráveis {% data reusables.repositories.a-vulnerability-is %} -Dependabot performs a scan to detect vulnerable dependencies and sends Dependabot alerts when a new vulnerability is added to the GitHub Advisory Database or the dependency graph for a repository changes. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)". +O dependabot executa uma digitalização para detectar dependências vulneráveis e enviar alertas de Dependabot quando uma nova vulnerabilidade é adicionada ao banco de dados do GitHub Advisory ou ao gráfico de dependências para alterações de repositório. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)". -You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for: -* Your personal account -* Your repository -* Your organization +Você pode habilitar ou desabilitar {% data variables.product.prodname_dependabot_alerts %} para: +* Sua conta pessoal +* Seu repositório +* Sua organização -## Managing {% data variables.product.prodname_dependabot_alerts %} for your personal account +## Gerenciando {% data variables.product.prodname_dependabot_alerts %} para sua conta pessoal {% ifversion fpt or ghec %} -You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your personal account. +Você pode habilitar ou desabilitar {% data variables.product.prodname_dependabot_alerts %} para todos os repositórios pertencentes à sua conta pessoal. -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for existing repositories +### Habilitando ou desabilitando {% data variables.product.prodname_dependabot_alerts %} para repositórios existentes {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security-analysis %} -3. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Disable all** or **Enable all**. ![Screenshot of "Configure security and analysis" features with "Enable all" or "Disable all" buttons emphasized](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-all.png) -4. Optionally, enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories that you create. ![Screenshot of "Enable Dependabot alerts" with "Enable by default for new private repositories" checkbox emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-by-default.png) -5. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories you own. ![Screenshot of "Enable Dependabot alerts" with "Enable Dependabot alerts" button emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts.png) +3. Em "Código de segurança e análise" à direita de {% data variables.product.prodname_dependabot_alerts %}, clique em **Desabilitar todos** ou **Habilitar todos**. ![Captura de tela das funcionalidades "Configurar segurança e análise" com os botões "Habilitar todos" ou "Desabilitar todos" destacados](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-all.png) +4. Opcionalmente, habilite {% data variables.product.prodname_dependabot_alerts %} por padrão para novos repositórios que você criar. ![Captura de tela de "Habilitar alertas do Dependabot" com a caixa de seleção "Habilitar por padrão para novos repositórios privados" destacada](/assets/images/help/dependabot/dependabot-alerts-enable-by-default.png) +5. Clique em **Desabilitar {% data variables.product.prodname_dependabot_alerts %}** ou **Habilitar {% data variables.product.prodname_dependabot_alerts %}** para desabilitar ou habilitar {% data variables.product.prodname_dependabot_alerts %} para todos os repositórios que você possui. ![Captura de tela de "Habilitar alertas do Dependabot" com o botão "Habilitar alertas do Dependabot" destacado](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts.png) -When you enable {% data variables.product.prodname_dependabot_alerts %} for existing repositories, you will see any results displayed on GitHub within minutes. +Ao habilitar {% data variables.product.prodname_dependabot_alerts %} para repositórios existentes, você verá todos os resultados exibidos no GitHub em minutos. -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for new repositories +### Habilitando ou desabilitando {% data variables.product.prodname_dependabot_alerts %} para novos repositórios {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.security-analysis %} -3. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, enable or disable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories that you create. ![Screenshot of "Configure security and analysis" with "Enable for all new private repositories" check emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-for-all-new-repositories.png) +3. Em "Código de segurança e análise", à direita de {% data variables.product.prodname_dependabot_alerts %}, habilite ou desabilite{% data variables.product.prodname_dependabot_alerts %} por padrão para novos repositórios que você criar. ![Captura de tela de "Configurar segurança e análise" com a caixa de seleção "Habilitar para todos os novos repositórios privados" destacada](/assets/images/help/dependabot/dependabot-alerts-enable-for-all-new-repositories.png) {% else %} -{% data variables.product.prodname_dependabot_alerts %} for your repositories can be enabled or disabled by your enterprise owner. For more information, see "[Enabling Dependabot for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +{% data variables.product.prodname_dependabot_alerts %} para seus repositórios podem ser habilitados ou desabilitados pelo proprietário da empresa. Para obter mais informações, consulte "[Habilitando o Dependabot para a sua empresa](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". {% endif %} ## Gerenciar {% data variables.product.prodname_dependabot_alerts %} para o seu repositório -{% ifversion fpt or ghec %}You can manage {% data variables.product.prodname_dependabot_alerts %} for your public, private or internal repository. +{% ifversion fpt or ghec %}Você pode gerenciar {% data variables.product.prodname_dependabot_alerts %} para o seu repositório público, privado ou interno. Por padrão, notificamos as pessoas com permissões de administrador nos repositórios afetados sobre os novos {% data variables.product.prodname_dependabot_alerts %}. O {% data variables.product.product_name %} nunca divulga publicamente vulnerabilidades identificadas para qualquer repositório. Você também pode tornar o {% data variables.product.prodname_dependabot_alerts %} visível para pessoas ou repositórios de trabalho de equipes adicionais que você possui ou para os quais tem permissões de administrador. {% data reusables.security.security-and-analysis-features-enable-read-only %} -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for a repository +### Habilitando ou desabilitando {% data variables.product.prodname_dependabot_alerts %} para um repositório {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} -1. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Disable** or **Enable**. ![Screenshot of "Configure security and analysis" features with the "Disable" button emphasized for Dependabot alerts](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-fpt-private.png) +1. Em "Código de segurança e análise" à direita de {% data variables.product.prodname_dependabot_alerts %}, clique em **Desabilitar** ou **Habilitar**. ![Captura de tela da funcionalidade "Configurar segurança e análise" com o botão "Desabilitar" destacado para alertas de Dependabot](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-fpt-private.png) {% endif %}{% ifversion ghes or ghae %} -{% data variables.product.prodname_dependabot_alerts %} for your repository can be enabled or disabled by your enterprise owner. For more information, see "[Enabling Dependabot for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +{% data variables.product.prodname_dependabot_alerts %} para o seu repositório podem ser habilitados ou desabilitados pelo proprietário da empresa. Para obter mais informações, consulte "[Habilitando o Dependabot para a sua empresa](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". {% endif %} -## Managing {% data variables.product.prodname_dependabot_alerts %} for your organization -{% ifversion fpt or ghec %}You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your organization. Your changes affect all repositories. +## Gerenciando {% data variables.product.prodname_dependabot_alerts %} para a sua organização +{% ifversion fpt or ghec %}Você pode habilitar ou desabilitar {% data variables.product.prodname_dependabot_alerts %} para todos os repositórios pertencentes à sua organização. Suas alterações afetam todos os repositórios. -### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for all existing repositories +### Habilitando ou desabilitando {% data variables.product.prodname_dependabot_alerts %} para todos os repositórios existentes {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security-and-analysis %} -2. Under "Code security and analysis", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Disable all** or **Enable all**. +2. Em "Código de segurança e análise" à direita de {% data variables.product.prodname_dependabot_alerts %}, clique em **Desabilitar todos** ou **Habilitar todos**. {% ifversion fpt or ghec %} - ![Screenshot of "Configure security and analysis" features with the "Enable all" or "Disable all" button emphasized for Dependabot alerts](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-fpt.png) + ![Captura de tela das funcionalidades "Configurar segurança e análise" com o botão "Habilitar todos" ou "Desabilitar tudode" destacado para os alertas do Dependabot](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-fpt.png) {% endif %} {% ifversion ghae %} ![Botão "Habilitar tudo" ou "Desabilitar tudo" para os recursos de "Configurar segurança e análise"](/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png) {% endif %} {% ifversion fpt or ghec %} -3. Optionally, enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories in your organization. +3. Opcionalmente, habilite {% data variables.product.prodname_dependabot_alerts %} por padrão para novos repositórios na sua organização. {% ifversion fpt or ghec %} - ![Screenshot of "Enable by default" option for new repositories](/assets/images/help/dependabot/dependabot-alerts-enable-by-default-organizations.png) + ![Captura de tela da opção "Habilitar por padrão" para novos repositórios](/assets/images/help/dependabot/dependabot-alerts-enable-by-default-organizations.png) {% endif %} {% endif %} {% ifversion fpt or ghec %} -4. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories in your organization. +4. Clique em **Desabilitar {% data variables.product.prodname_dependabot_alerts %}** ou **Habilitar {% data variables.product.prodname_dependabot_alerts %}** para desabilitar ou habilitar {% data variables.product.prodname_dependabot_alerts %} para todos os repositórios da sua organização. {% ifversion fpt or ghec %} - ![Screenshot of "Enable Dependabot alerts" modal with button to disable or enable feature emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts-organizations.png) + ![Captura de tela do modo "Habilitar alertas do Dependabot" com botão para desabilitar ou habilitar destacado](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts-organizations.png) {% endif %}{% endif %}{% endif %}{% ifversion ghes or ghae %} -{% data variables.product.prodname_dependabot_alerts %} for your organization can be enabled or disabled by your enterprise owner. For more information, see "[About Dependabot for GitHub Enterprise Server](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +{% data variables.product.prodname_dependabot_alerts %} para sua organização pode ser habilitado ou desabilitado pelo proprietário da empresa. Para obter mais informações, consulte[Sobre o Dependabot para o GitHub Enterprise Server](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". {% endif %} diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 02703b5e61..76d5653c50 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -45,36 +45,36 @@ Cada alerta de {% data variables.product.prodname_dependabot %} tem um identific {% endif %} {% if dependabot-alerts-vulnerable-calls %} -## About the detection of calls to vulnerable functions +## Sobre a detecção de chamadas para funções vulneráveis {% data reusables.dependabot.vulnerable-calls-beta %} -When {% data variables.product.prodname_dependabot %} tells you that your repository uses a vulnerable dependency, you need to determine what the vulnerable functions are and check whether you are using them. Once you have this information, then you can determine how urgently you need to upgrade to a secure version of the dependency. +Quando {% data variables.product.prodname_dependabot %} disser que seu repositório usa uma dependência vulnerável, você deverá determinar quais são as funções vulneráveis e verificar se você as está usando. Com essa informação, você poderá determinar o quão urgente você precisa para atualizar para uma versão segura da dependência. -For supported languages, {% data variables.product.prodname_dependabot %} automatically detects whether you use a vulnerable function and adds the label "Vulnerable call" to affected alerts. You can use this information in the {% data variables.product.prodname_dependabot_alerts %} view to triage and prioritize remediation work more effectively. +Para as linguagens compatíveis, {% data variables.product.prodname_dependabot %} detecta automaticamente se você usa uma função vulnerável e adiciona a etiqeuta de "Chamada vulnerável" aos alertas afetados. Você pode usar estas informações na exibição de {% data variables.product.prodname_dependabot_alerts %} para triar e priorizar o trabalho de correção de forma mais eficaz. {% note %} -**Note:** During the beta release, this feature is available only for new Python advisories created *after* April 14, 2022, and for a subset of historical Python advisories. GitHub is working to backfill data across additional historical Python advisories, which are added on a rolling basis. Vulnerable calls are highlighted only on the {% data variables.product.prodname_dependabot_alerts %} pages. +**Observação:** Durante a versão beta, esse recurso está disponível apenas para novas consultorias do Python criadas *depois de* 14 de abril de 2022 e para um subconjunto de consultorias históricas do Python. GitHub is working to backfill data across additional historical Python advisories, which are added on a rolling basis. As chamadas vulneráveis são destacadas apenas nas páginas de {% data variables.product.prodname_dependabot_alerts %}. {% endnote %} -![Screenshot showing an alert with the "Vulnerable call" label](/assets/images/help/repository/dependabot-alerts-vulnerable-call-label.png) +![Captura de tela que mostra um alerta com a etiqueta "Chamada vulnerável"](/assets/images/help/repository/dependabot-alerts-vulnerable-call-label.png) -You can filter the view to show only alerts where {% data variables.product.prodname_dependabot %} detected at least one call to a vulnerable function using the `has:vulnerable-calls` filter in the search field. +Você pode filtrar a visualização para mostrar apenas alertas em que {% data variables.product.prodname_dependabot %} detectou pelo menos uma chamada para uma função vulnerável usando o filtro `has:vulnerable-calls` no campo de busca. -For alerts where vulnerable calls are detected, the alert details page shows additional information: +Para alertas quando chamadas vulneráveis forem detectadas, a página de detalhes de alerta mostra informações adicionais: -- A code block showing where the function is used or, where there are multiple calls, the first call to the function. -- An annotation listing the function itself, with a link to the line where the function is called. +- Um bloco de código que mostra onde a função é usada ou, onde houver várias chamadas, a primeira chamada para a função. +- Uma anotação que lista a função em si, com um link para a linha onde a função é chamada. -![Screenshot showing the alert details page for an alert with a "Vulnerable call" label](/assets/images/help/repository/review-calls-to-vulnerable-functions.png) +![Captura de tela que mostra a página de detalhes de alerta para um alerta com uma etiqueta "chamada vulnerável"](/assets/images/help/repository/review-calls-to-vulnerable-functions.png) -For more information, see "[Reviewing and fixing vulnerable dependencies](#reviewing-and-fixing-vulnerable-dependencies)" below. +Para obter mais informações, consulte "[Eevisando e corrigindo dependências vulneráveis](#reviewing-and-fixing-vulnerable-dependencies)" abaixo. {% endif %} -## Viewing vulnerable dependencies +## Visualizando dependências vulneráveis {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} {% data reusables.repositories.navigate-to-repo %} @@ -90,28 +90,28 @@ For more information, see "[Reviewing and fixing vulnerable dependencies](#revie 1. Clique no alerta que deseja exibir. ![Alerta selecionado na lista de alertas](/assets/images/help/graphs/click-alert-in-alerts-list.png) {% endif %} -## Reviewing and fixing vulnerable dependencies +## Revisando e corrigindo dependências vulneráveis -It’s important to ensure that all of your dependencies are clean of any security weaknesses. When {% data variables.product.prodname_dependabot %} discovers vulnerabilities in your dependencies, you should assess your project’s level of exposure and determine what remediation steps to take to secure your application. +É importante garantir que todas as suas dependências estejam limpas de qualquer fraqueza de segurança. Quando {% data variables.product.prodname_dependabot %} descobrir vulnerabilidades em suas dependências, você deverá avaliar o nível de exposição do seu projeto e determinar quais medidas de correção devem ser tomadas para proteger seu aplicativo. -If a patched version is available, you can generate a {% data variables.product.prodname_dependabot %} pull request to update this dependency directly from a {% data variables.product.prodname_dependabot %} alert. If you have {% data variables.product.prodname_dependabot_security_updates %} enabled, the pull request may be linked will in the Dependabot alert. +Se uma versão alterada estiver disponível, é possível gerar um pull request de {% data variables.product.prodname_dependabot %} para atualizar essa dependência diretamente de um alerta do {% data variables.product.prodname_dependabot %}. Se você tiver {% data variables.product.prodname_dependabot_security_updates %} habilitado, o pull request poderá estar vinculado ao alerta do Dependabot. -In cases where a patched version is not available, or you can’t update to the secure version, {% data variables.product.prodname_dependabot %} shares additional information to help you determine next steps. When you click through to view a {% data variables.product.prodname_dependabot %} alert, you can see the full details of the security advisory for the dependency including the affected functions. You can then check whether your code calls the impacted functions. This information can help you further assess your risk level, and determine workarounds or if you’re able to accept the risk represented by the security vulnerability. +Nos casos em que uma versão alterada não está disponível ou em que você não puder atualizar para a versão segura, {% data variables.product.prodname_dependabot %} irá compartilhar informações adicionais para ajudar você a determinar as próximas etapas. Ao clicar para ver um alerta de {% data variables.product.prodname_dependabot %}, você pode ver todos os detalhes da consultoria de segurança para a dependência, incluindo as funções afetadas. Você pode então verificar se seu código chama as funções afetadas. Essa informação pode ajudar você a avaliar seu nível de risco e determinar soluções alternativas ou se você pode aceitar o risco representado pela vulnerabilidade de segurança. {% if dependabot-alerts-vulnerable-calls %} -For supported languages, {% data variables.product.prodname_dependabot %} detects calls to vulnerable functions for you. When you view an alert labeled as "Vulnerable call", the details include the name of the function and a link to the code that calls it. Often you will be able to take decisions based on this information, without exploring further. +Para as linguagens compatíveis, {% data variables.product.prodname_dependabot %} detecta chamadas para funções vulneráveis para você. Ao ver um alerta marcado como "Chamada vulnerável", os detalhes incluem o nome da função e um link para o código que a chama. Muitas vezes, é possível tomar decisões com base nestas informações, sem ter de continuar explorando. {% endif %} -### Fixing vulnerable dependencies +### Corrigir dependências vulneráveis -1. View the details for an alert. For more information, see "[Viewing vulnerable dependencies](#viewing-vulnerable-dependencies)" (above). +1. Ver detalhes de um alerta. Para obter mais informações, consulte "[Visualizando dependências vulneráveis](#viewing-vulnerable-dependencies)" (acima). {% ifversion fpt or ghec or ghes > 3.2 %} -1. If you have {% data variables.product.prodname_dependabot_security_updates %} enabled, there may be a link to a pull request that will fix the dependency. Alternatively, you can click **Create {% data variables.product.prodname_dependabot %} security update** at the top of the alert details page to create a pull request. ![Crie um botão de atualização de segurança do {% data variables.product.prodname_dependabot %}](/assets/images/help/repository/create-dependabot-security-update-button-ungrouped.png) -1. Optionally, if you do not use {% data variables.product.prodname_dependabot_security_updates %}, you can use the information on the page to decide which version of the dependency to upgrade to and create a pull request to update the dependency to a secure version. +1. Se você tiver {% data variables.product.prodname_dependabot_security_updates %} habilitado, é possível que haja um link para um pull request que irá corrigir a dependência. Como alternativa, você pode clicar em **Criar {% data variables.product.prodname_dependabot %} atualização de segurança** na parte superior da página de detalhes do alerta para criar um pull request. ![Crie um botão de atualização de segurança do {% data variables.product.prodname_dependabot %}](/assets/images/help/repository/create-dependabot-security-update-button-ungrouped.png) +1. Opcionalmente, se você não usar {% data variables.product.prodname_dependabot_security_updates %}, você pode usar as informações na página para decidir para qual versão de dependência atualizar e criar um pull request para atualizar a dependência de uma versão segura. {% elsif ghes < 3.3 or ghae %} -1. You can use the information on the page to decide which version of the dependency to upgrade to and create a pull request to the manifest or lock file to a secure version. +1. Você pode usar as informações na página para decidir para qual versão da dependência atualizar e criar um pull request para o manifesto ou bloquear arquivo para uma versão segura. {% endif %} 1. Quando estiver pronto para atualizar a dependência e resolver a vulnerabilidade, faça merge da pull request. @@ -119,12 +119,12 @@ For supported languages, {% data variables.product.prodname_dependabot %} detect Cada pull request criado por {% data variables.product.prodname_dependabot %} inclui informações sobre os comandos que você pode usar para controlar {% data variables.product.prodname_dependabot %}. Para obter mais informações, consulte "[Gerenciar pull requests para atualizações de dependências](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)". {% endif %} -### Dismissing {% data variables.product.prodname_dependabot_alerts %} +### Ignorando {% data variables.product.prodname_dependabot_alerts %} -If you schedule extensive work to upgrade a dependency, or decide that an alert does not need to be fixed, you can dismiss the alert. Dismissing alerts that you have already assessed makes it easier to triage new alerts as they appear. +Se você agendar um extenso trabalho para atualizar uma dependência ou decidir que um alerta não precisa ser corrigido, você poderá ignorar o alerta. Ignorando alertas que você já avaliou facilita a triagem de novos alertas conforme eles aparecem. -1. View the details for an alert. For more information, see "[Viewing vulnerable dependencies](#viewing-vulnerable-dependencies)" (above). -1. Select the "Dismiss" dropdown, and click a reason for dismissing the alert.{% if reopen-dependabot-alerts %} Unfixed dismissed alerts can be reopened later.{% endif %} ![Escolher o motivo para ignorar o alerta a partir do menu suspenso "Ignorar"down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) +1. Ver detalhes de um alerta. Para obter mais informações, consulte "[Visualizando dependências vulneráveis](#viewing-vulnerable-dependencies)" (acima). +1. Selecione o menu suspenso "Ignorar" e clique em um motivo para ignorar o alerta.{% if reopen-dependabot-alerts %} Alertas não descartados podem ser reabertos posteriormente.{% endif %} ![Escolher o motivo para ignorar o alerta a partir do menu suspenso "Ignorar"down](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) {% if reopen-dependabot-alerts %} diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md b/translations/pt-BR/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md index 4d42ce889e..2fd22eb3f2 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md +++ b/translations/pt-BR/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md @@ -33,7 +33,7 @@ topics: É possível habilitar o {% data variables.product.prodname_dependabot_security_updates %} para qualquer repositório que use {% data variables.product.prodname_dependabot_alerts %} e o gráfico de dependências. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." -You can disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository or for all repositories owned by your personal account or organization. Para obter mais informações, consulte "[Gerenciar o {% data variables.product.prodname_dependabot_security_updates %} para seus repositórios](#managing-dependabot-security-updates-for-your-repositories) abaixo". +Você pode desabilitar {% data variables.product.prodname_dependabot_security_updates %} para um repositório individual ou para todos os repositórios pertencentes à sua conta pessoal ou organização. Para obter mais informações, consulte "[Gerenciar o {% data variables.product.prodname_dependabot_security_updates %} para seus repositórios](#managing-dependabot-security-updates-for-your-repositories) abaixo". {% ifversion fpt or ghec %}{% data reusables.dependabot.dependabot-tos %}{% endif %} @@ -63,7 +63,7 @@ Se as atualizações de segurança não estiverem habilitadas para o seu reposit Você pode habilitar ou desabilitar {% data variables.product.prodname_dependabot_security_updates %} para um repositório individual (veja abaixo). -You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your personal account or organization. For more information, see "[Managing security and analysis settings for your personal account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)." +Você também pode habilitar ou desabilitar {% data variables.product.prodname_dependabot_security_updates %} para todos os repositórios pertencentes à sua conta pessoal ou organização. Para mais informações consulte "[Gerenciar as configurações de segurança e análise da sua conta pessoal](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" ou "[Gerenciar as configurações de segurança e análise da sua organização](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)". O {% data variables.product.prodname_dependabot_security_updates %} exige configurações específicas do repositório. Para obter mais informações, consulte "[Repositórios compatíveis](#supported-repositories)". @@ -79,6 +79,6 @@ O {% data variables.product.prodname_dependabot_security_updates %} exige config ## Leia mais - "[Sobre {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)" -- "[Configuring {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts)"{% ifversion fpt or ghec %} +- "[Configurar {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts)"{% ifversion fpt or ghec %} - "[Gerenciando configurações de uso de dados para o seu repositório privado](/get-started/privacy-on-github/managing-data-use-settings-for-your-private-repository)"{% endif %} - "[Ecossistemas de pacotes compatíveis](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)" diff --git a/translations/pt-BR/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md b/translations/pt-BR/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md index 043fac7c9d..7ae58ac2f0 100644 --- a/translations/pt-BR/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md +++ b/translations/pt-BR/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md @@ -25,7 +25,7 @@ Para dar às pessoas instruções para relatar vulnerabilidades de segurança no {% ifversion not ghae %} -You can create a default security policy for your organization or personal account. Para obter mais informações, consulte "[Criando um arquivo padrão de integridade da comunidade](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." +Você pode criar uma política de segurança padrão para sua organização ou conta pessoal. Para obter mais informações, consulte "[Criando um arquivo padrão de integridade da comunidade](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} {% tip %} diff --git a/translations/pt-BR/content/code-security/getting-started/securing-your-repository.md b/translations/pt-BR/content/code-security/getting-started/securing-your-repository.md index 5a4ad39a19..3c73c0e21a 100644 --- a/translations/pt-BR/content/code-security/getting-started/securing-your-repository.md +++ b/translations/pt-BR/content/code-security/getting-started/securing-your-repository.md @@ -75,7 +75,7 @@ Para obter mais informações, consulte "[Explorar as dependências de um reposi {% data reusables.dependabot.dependabot-alerts-beta %} {% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %} -For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies){% ifversion fpt or ghec %}" and "[Managing security and analysis settings for your personal account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}." +Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies){% ifversion fpt or ghec %}" e "[Gerenciando configurações de segurança e análise da sua conta pessoal](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account){% endif %}". {% endif %} diff --git a/translations/pt-BR/content/code-security/security-overview/filtering-alerts-in-the-security-overview.md b/translations/pt-BR/content/code-security/security-overview/filtering-alerts-in-the-security-overview.md index 65ea15b7d8..4548816e2f 100644 --- a/translations/pt-BR/content/code-security/security-overview/filtering-alerts-in-the-security-overview.md +++ b/translations/pt-BR/content/code-security/security-overview/filtering-alerts-in-the-security-overview.md @@ -118,14 +118,14 @@ Disponível na visualização de alerta de digitalização de código. Todos os | `severity:note` | Exibe alertas de {% data variables.product.prodname_code_scanning %} categorizados como observações. | {% if dependabot-alerts-vulnerable-calls %} -## Filter by {% data variables.product.prodname_dependabot %} alert type +## Filtrar por tipo de alerta de {% data variables.product.prodname_dependabot %} -Available in the {% data variables.product.prodname_dependabot %} alert views. You can filter the view to show {% data variables.product.prodname_dependabot_alerts %} that are ready to fix or where additional information about exposure is available. You can click any result to see full details of the alert. +Disponível nas visualizações de alerta de {% data variables.product.prodname_dependabot %}. Você pode filtrar a visualização para mostrar {% data variables.product.prodname_dependabot_alerts %} que estão prontos para corrigir ou onde estão disponíveis informações adicionais sobre exposição. Você pode clicar em qualquer resultado para ver detalhes completos do alerta. -| Qualifier | Descrição | -| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `has:patch` | Displays {% data variables.product.prodname_dependabot %} alerts for vulnerabilities where a secure version is already available. | -| `has:vulnerable-calls` | Displays {% data variables.product.prodname_dependabot %} alerts where at least one call from the repository to a vulnerable function is detected. For more information, see "[Viewing and updating Dependabot alerts](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#about-the-detection-of-calls-to-vulnerable-functions)." | +| Qualifier | Descrição | +| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `has:patch` | Exibe alertas do {% data variables.product.prodname_dependabot %} para vulnerabilidades em que uma versão segura já está disponível. | +| `has:vulnerable-calls` | Exibe alertas de {% data variables.product.prodname_dependabot %}, em que pelo menos uma chamada do repositório para uma função vulnerável é detectada. Para obter mais informações, consulte "[Visualizando e atualizando alertas do Dependabot](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#about-the-detection-of-calls-to-vulnerable-functions)". | {% endif %} {% endif %} diff --git a/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md b/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md index ffed44e42e..c530ab3754 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md @@ -31,7 +31,7 @@ Se um pull request for direcionado ao branch padrão do seu repositório e conti Ao verificar as revisões de dependências em um pull request e alterar todas as dependências sinalizadas como vulneráveis, você pode evitar que vulnerabilidades sejam adicionadas ao seu projeto. Para obter mais informações sobre como funciona a revisão de dependências, consulte "[Revisar as alterações de dependência em um pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)". -For more information about configuring dependency review, see "[Configuring dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review)." +Para obter mais informações sobre como configurar uma revisão de dependência, consulte "[Configurando a análise de dependência](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review)". {% data variables.product.prodname_dependabot_alerts %} encontrará vulnerabilidades que já estão nas suas dependências, mas é muito melhor evitar a introdução de possíveis problemas do que corrigir problemas em uma data posterior. Para obter mais informações sobre {% data variables.product.prodname_dependabot_alerts %}, consulte "[Sobre {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies#dependabot-alerts-for-vulnerable-dependencies)." diff --git a/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md b/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md index 00ea06d66d..d4ae95ee4a 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md @@ -32,7 +32,7 @@ Ao criar um pull request que contém alterações para dependências direcionada ## Disponibilidade do gráfico de dependências -{% ifversion fpt or ghec %}O gráfico de dependências está disponível para cada repositório público que define as dependências em um ecossistema de pacote compatível usando um formato de arquivo compatível. Repository administrators can also set up the dependency graph for private repositories. For more information, see "[Configuring the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph)."{% endif %} +{% ifversion fpt or ghec %}O gráfico de dependências está disponível para cada repositório público que define as dependências em um ecossistema de pacote compatível usando um formato de arquivo compatível. Os administradores de repositórios também podem configurar o gráfico de dependências para repositórios privados. Para obter mais informações, consulte "[Configurando o gráfico de dependências](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph).{% endif %} {% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %} @@ -67,7 +67,7 @@ Os formatos recomendados definem explicitamente quais versões são usadas para | Gerenciador de pacotes | Linguagem | Formatos recomendados | Todos os formatos compatíveis | | ---------------------- | -------------------------------- | ------------------------------------------------------ | ------------------------------------------------------------------------- | | Composer | PHP | `composer.lock` | `composer.json`, `composer.lock` | -| `dotnet` CLI | .NET languages (C#, C++, F#, VB) | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` | +| NuGet | .NET languages (C#, F#, VB), C++ | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` | {%- if github-actions-in-dependency-graph %} | Fluxos de trabalho de {% data variables.product.prodname_actions %} @@ -84,7 +84,7 @@ Os formatos recomendados definem explicitamente quais versões são usadas para | Python Poetry | Python | `poetry.lock` | `poetry.lock`, `pyproject.toml` |{% endif %} | RubyGems | Ruby | `Gemfile.lock` | `Gemfile.lock`, `Gemfile`, `*.gemspec` | | Yarn | JavaScript | `yarn.lock` | `package.json`, `yarn.lock` | {% if github-actions-in-dependency-graph %} -[1] Observe que os fluxos de trabalho de {% data variables.product.prodname_actions %} devem estar localizados no diretório `.github/workflows/` de um repositório para serem reconhecidos como manifestos. Todas as ações ou fluxos de trabalho referenciados que usam a sintaxe `jobs[*].steps[*].uses` or `jobs..uses` serão analisados como dependências. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions)." +[1] Observe que os fluxos de trabalho de {% data variables.product.prodname_actions %} devem estar localizados no diretório `.github/workflows/` de um repositório para serem reconhecidos como manifestos. Todas as ações ou fluxos de trabalho referenciados que usam a sintaxe `jobs[*].steps[*].uses` or `jobs..uses` serão analisados como dependências. Para obter mais informações, consulte " Sintaxe de fluxo de trabalho[para o GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions)". [2] Se você listar suas dependências do Python nas no arquivo `setup.py`, é possível que não possamos analisar e listar todas as dependências do seu projeto. diff --git a/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md b/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md index 1af2df0116..1a4c7ee249 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md @@ -1,7 +1,7 @@ --- -title: Configuring dependency review -intro: You can use dependency review to catch vulnerabilities before they are added to your project. -shortTitle: Configure dependency review +title: Configurando a revisão de dependências +intro: Você pode usar a análise de dependência para capturar vulnerabilidades antes que sejam adicionadas ao seu projeto. +shortTitle: Configurar a revisão de dependências versions: fpt: '*' ghes: '>= 3.2' @@ -22,28 +22,28 @@ topics: {% data reusables.dependency-review.feature-overview %} -For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)" and "[Reviewing dependency changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)." +Para obter mais informações, consulte[Sobre a revisão de dependências](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)" e[Revisando as alterações de dependência em um pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)". -## About configuring dependency review +## Sobre a configuração de revisão de dependências {% ifversion fpt %} -A revisão de dependências está disponível em todos os repositórios públicos de todos os produtos e não pode ser desabilitada. Dependency review is available in private repositories owned by organizations that use GitHub Enterprise Cloud and have a license for [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security). Para obter mais informações, consulte a [documentação de {% data variables.product.prodname_ghe_cloud %}](/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review). +A revisão de dependências está disponível em todos os repositórios públicos de todos os produtos e não pode ser desabilitada. A revisão de dependências está disponível em repositórios privados pertencentes a organizações que usam o GitHub Enterprise Cloud e têm uma licença para [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security). Para obter mais informações, consulte a [documentação de {% data variables.product.prodname_ghe_cloud %}](/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review). {% elsif ghec %} -Revisão de dependências está incluída em {% data variables.product.product_name %} para repositórios públicos. To use dependency review in private repositories owned by organizations, you must have a license for [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security) and have the dependency graph enabled. +Revisão de dependências está incluída em {% data variables.product.product_name %} para repositórios públicos. Para usar a revisão de dependências em repositórios privados pertencentes a organizações, você deve ter uma licença para [{% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security) e ter o gráfico de dependências habilitado. {% data reusables.dependabot.enabling-disabling-dependency-graph-private-repo %} -1. If "{% data variables.product.prodname_GH_advanced_security %}" is not enabled, click **Enable** next to the feature. ![Screenshot of GitHub Advanced Security feature with "Enable" button emphasized](/assets/images/help/security/enable-ghas-private-repo.png) +1. Se "{% data variables.product.prodname_GH_advanced_security %} não estiver ativado, clique em **Habilitar ** ao lado do recurso. ![Captura de tela do recurso do GitHub Advanced Security com o botão "Habilitar" destacado](/assets/images/help/security/enable-ghas-private-repo.png) {% elsif ghes or ghae %} A revisão de dependências está disponível quando o gráfico de dependências está habilitado para {% data variables.product.product_location %} e {% data variables.product.prodname_advanced_security %} está habilitado para a organização ou repositório. Para obter mais informações, consulte "[Habilitar {% data variables.product.prodname_GH_advanced_security %} para a sua empresa](/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise)." -### Checking if the dependency graph is enabled +### Verificando se o gráfico de dependências está habilitado {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} -1. Under "Configure security and analysis features", check if the dependency graph is enabled. -1. If dependency graph is enabled, click **Enable** next to "{% data variables.product.prodname_GH_advanced_security %}" to enable {% data variables.product.prodname_advanced_security %}, including dependency review. The enable button is disabled if your enterprise has no available licenses for {% data variables.product.prodname_advanced_security %}.{% ifversion ghes < 3.3 %} ![Screenshot of "Code security and analysis" features"](/assets/images/enterprise/3.2/repository/code-security-and-analysis-enable-ghas-3.2.png){% endif %}{% ifversion ghes > 3.2 %} ![Screenshot of "Code security and analysis" features"](/assets/images/enterprise/3.4/repository/code-security-and-analysis-enable-ghas-3.4.png){% endif %} +1. Em "Configurar funcionalidades de segurança e análise", verifique se o gráfico de dependências está habilitado. +1. Se o gráfico de dependência estiver habilitado, clique em **Habilitar** ao lado de "{% data variables.product.prodname_GH_advanced_security %}" para habilitar {% data variables.product.prodname_advanced_security %}, incluindo a revisão de dependência. O botão de habilitar estará desabilitado se a sua empresa não tiver licenças disponíveis para {% data variables.product.prodname_advanced_security %}.{% ifversion ghes < 3.3 %} ![Screenshot of "Code security and analysis" features"](/assets/images/enterprise/3.2/repository/code-security-and-analysis-enable-ghas-3.2.png){% endif %}{% ifversion ghes > 3.2 %} ![Screenshot of "Code security and analysis" features"](/assets/images/enterprise/3.4/repository/code-security-and-analysis-enable-ghas-3.4.png){% endif %} {% endif %} diff --git a/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md b/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md index 6128b2abfa..27f1365227 100644 --- a/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md +++ b/translations/pt-BR/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md @@ -1,5 +1,5 @@ --- -title: Configuring the dependency graph +title: Configurando o gráfico de dependências intro: Você pode permitir que os usuários identifiquem as dependências dos seus projetos habilitando o gráfico de dependências. redirect_from: - /code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph @@ -13,7 +13,7 @@ topics: - Dependency graph - Dependencies - Repositories -shortTitle: Configure dependency graph +shortTitle: Configurar gráfico de dependências --- ## Sobre o gráfico de dependências @@ -22,10 +22,10 @@ shortTitle: Configure dependency graph Para obter mais informações, consulte "[Sobre o gráfico de dependência](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)". -{% ifversion fpt or ghec %} ## About configuring the dependency graph {% endif %} -{% ifversion fpt or ghec %}Para gerar um gráfico de dependência, o {% data variables.product.product_name %} precisa de acesso somente leitura ao manifesto dependência e aos arquivos de bloqueio em um repositório. O gráfico de dependências é gerado automaticamente para todos os repositórios públicos e você pode optar por habilitá-lo para repositórios privados. For more information on viewing the dependency graph, see "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)."{% endif %} +{% ifversion fpt or ghec %} ## Sobre a configuração do gráfico de dependências {% endif %} +{% ifversion fpt or ghec %}Para gerar um gráfico de dependência, o {% data variables.product.product_name %} precisa de acesso somente leitura ao manifesto dependência e aos arquivos de bloqueio em um repositório. O gráfico de dependências é gerado automaticamente para todos os repositórios públicos e você pode optar por habilitá-lo para repositórios privados. Para obter mais informações sobre a visualização do gráfico de dependências, consulte "[Explorando as dependências de um repositório](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository)".{% endif %} -{% ifversion ghes or ghae %} ## Enabling the dependency graph +{% ifversion ghes or ghae %} ## Habilitando o gráfico de dependências {% data reusables.dependabot.ghes-ghae-enabling-dependency-graph %}{% endif %}{% ifversion fpt or ghec %} ### Habilitar e desabilitar o gráfico de dependências para um repositório privado @@ -37,6 +37,6 @@ Quando o gráfico de dependências é ativado pela primeira vez, todos manifesto ## Leia mais -{% ifversion fpt or ghec %}- "[Viewing insights for your organization](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)"{% endif %} +{% ifversion fpt or ghec %}- "[Visualizando insights para sua organização](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)"{% endif %} - "[Visualizando {% data variables.product.prodname_dependabot_alerts %} para dependências vulneráveis](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" - "[Solução de problemas na detecção de dependências vulneráveis](/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies)" diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/security-in-codespaces.md b/translations/pt-BR/content/codespaces/codespaces-reference/security-in-codespaces.md index 80fe56a6b9..0dc1008dee 100644 --- a/translations/pt-BR/content/codespaces/codespaces-reference/security-in-codespaces.md +++ b/translations/pt-BR/content/codespaces/codespaces-reference/security-in-codespaces.md @@ -99,7 +99,7 @@ Há algumas práticas recomendadas e riscos adicionais dos quais você deve esta #### Compreendendo o arquivo devcontainer.json de um repositório -When you create a codespace, if a `devcontainer.json` file is found for your repository, it is parsed and used to configure your codespace. The `devcontainer.json` file can contain powerful features, such as installing third-party extensions and running arbitrary code supplied in a `postCreateCommand`. +Ao criar um codespace, se um arquivo `devcontainer.json` for encontrado para o seu repositório, ele será analisado e usado para configurar o seu codespace. O arquivo `devcontainer.json` pode conter funcionalidades poderosas, como instalar extensões de terceiros e executar código arbitrário fornecido em um `postCreateCommand`. Para obter mais informações, consulte "[Introdução a contêineres de desenvolvimento](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)". diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/understanding-billing-for-codespaces.md b/translations/pt-BR/content/codespaces/codespaces-reference/understanding-billing-for-codespaces.md index d2490fcac7..6d24666e51 100644 --- a/translations/pt-BR/content/codespaces/codespaces-reference/understanding-billing-for-codespaces.md +++ b/translations/pt-BR/content/codespaces/codespaces-reference/understanding-billing-for-codespaces.md @@ -20,7 +20,7 @@ Este artigo explica como a cobrança funciona para seus codespaces e explica com ## Obtendo acesso a {% data variables.product.prodname_codespaces %} -Your organization's administrator might limit {% data variables.product.prodname_codespaces %} usage to only specific personal accounts. Para obter acesso, você deverá entrar em contato com o gerente de faturamento. Para obter mais informações, consulte "[Gerenciar acesso e segurança para seus codespaces](/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces)". +O administrador da sua organização pode limitar o uso de {% data variables.product.prodname_codespaces %} para apenas contas pessoais específicas. Para obter acesso, você deverá entrar em contato com o gerente de faturamento. Para obter mais informações, consulte "[Gerenciar acesso e segurança para seus codespaces](/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces)". ## Quanto custa usar {% data variables.product.prodname_codespaces %} diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md b/translations/pt-BR/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md index da74842c00..e8e99ffe56 100644 --- a/translations/pt-BR/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md +++ b/translations/pt-BR/content/codespaces/codespaces-reference/using-github-copilot-in-codespaces.md @@ -19,5 +19,5 @@ redirect_from: [{% data variables.product.prodname_copilot %}](https://copilot.github.com/), um programador de par de IA pode ser usado em qualquer codespace. Para começar a usar {% data variables.product.prodname_copilot_short %} em {% data variables.product.prodname_codespaces %}, instale a [ extensão de {% data variables.product.prodname_copilot_short %} a partir do marketplace de {% data variables.product.prodname_vscode %}](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). -Para incluir o {% data variables.product.prodname_copilot_short %}, ou outras extensões, em todos os seus codespaces, habilite a sincronização de Configurações. Para obter mais informações, consulte "[Personalizar {% data variables.product.prodname_codespaces %} para sua conta](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)". Além disso, para incluir {% data variables.product.prodname_copilot_short %} em um determinado projeto para todos os usuários, você pode especificar `GitHub.copilot` como uma extensão no seu arquivo `devcontainer.json`. For information about configuring a `devcontainer.json` file, see "[Introduction to dev containers](/codespaces/customizing-your-codespace/configuring-codespaces-for-your-project#creating-a-custom-dev-container-configuration)." +Para incluir o {% data variables.product.prodname_copilot_short %}, ou outras extensões, em todos os seus codespaces, habilite a sincronização de Configurações. Para obter mais informações, consulte "[Personalizar {% data variables.product.prodname_codespaces %} para sua conta](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#settings-sync)". Além disso, para incluir {% data variables.product.prodname_copilot_short %} em um determinado projeto para todos os usuários, você pode especificar `GitHub.copilot` como uma extensão no seu arquivo `devcontainer.json`. Para obter informações sobre a configuração de um arquivo `devcontainer.json`, consulte "[Introdução aos contêineres de desenvolvimento](/codespaces/customizing-your-codespace/configuring-codespaces-for-your-project#creating-a-custom-dev-container-configuration)". diff --git a/translations/pt-BR/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md b/translations/pt-BR/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md index c53abc3913..4a6591d161 100644 --- a/translations/pt-BR/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md +++ b/translations/pt-BR/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md @@ -20,7 +20,7 @@ topics: {% endnote %} -{% data reusables.codespaces.codespaces-machine-types %} You can choose an alternative machine type either when you create a codespace or at any time after you've created a codespace. +{% data reusables.codespaces.codespaces-machine-types %} Você pode escolher um tipo alternativo ao criar um codespace ou a qualquer momento após criar um codespace. Para obter informações sobre como escolher um tipo de máquina ao criar um codespace, consulte "[Criando um codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)". Para informações sobre como mudar o tipo de máquina em {% data variables.product.prodname_vscode %}, consulte "[Usando {% data variables.product.prodname_codespaces %} em {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#changing-the-machine-type-in-visual-studio-code)." diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md index 454dab0bae..1082dfd203 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -76,49 +76,49 @@ Se você deseja criar um codespace para um repositório pertencente à sua conta ![Menu suspenso do branch](/assets/images/help/codespaces/branch-drop-down.png) -1. Click the **{% octicon "code" aria-label="The code icon" %} Code** button, then click the **Codespaces** tab. +1. Clique no botão **Código de {% octicon "code" aria-label="The code icon" %}** e, em seguida, clique na aba **Codespaces**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) -1. Create your codespace, either using the default options, or after configuring advanced options: +1. Crie o seu codespace, usando as opções padrão ou após a configuração das opções avançadas: - * **Use the default options** + * **Usar as opções padrão** - To create a codespace using the default options, click **Create codespace on BRANCH**. + Para criar um código com as opções padrão, clique em **Criar codespace no BRANCH**. - Optionally, before clicking **Create codespace on BRANCH**, you can click the down arrow at the side of the button to see what machine type will be used for your codespace. + Opcionalmente, antes de clicar em **Criar codespace no BRANCH**, você pode clicar na seta para baixo ao lado do botão para ver que tipo de máquina será usada no seu codespace. - ![View the default machine type](/assets/images/help/codespaces/default-machine-type.png) + ![Ver o tipo de máquina padrão](/assets/images/help/codespaces/default-machine-type.png) {% note %} - **Note**: The machine type with the lowest resources that are valid for the repository is selected by default. + **Observação**: O tipo de máquina com os recursos mais baixos válidos para o repositório é selecionado por padrão. {% endnote %} - * **Configure options** + * **Configurar opções** - To configure advanced options for your codespace, such as a different machine type or a particular `devcontainer.json` file: + Para configurar opções avançadas para o seu codespace como, por exemplo um tipo de máquina diferente ou um determinado arquivo `devcontainer.json`: - 1. Click the down arrow at the side of the **Create codespace on BRANCH** button, then click **Configure and create codespace**. - 1. Click the **Configure and create codespace** button. - 1. On the options page for your codespace, choose your preferred options from the drop-down menus. + 1. Clique na seta para baixo ao lado do botão **Criar codespace no BRANCH** e, em seguida, clique em **Configurar e criar codespace**. + 1. Clique no botão **Configurar e criar o codespace**. + 1. Na página de opções do seu codespace, escolha suas opções preferidas entre os menus suspensos. - ![The codespace options page](/assets/images/help/codespaces/advanced-options.png) + ![Página de opções de codespace](/assets/images/help/codespaces/advanced-options.png) {% note %} **Observações** - * You can bookmark the options page to give you a quick way to create a codespace for this repository and branch. - * The [https://github.com/codespaces/new](https://github.com/codespaces/new) page provides a quick way to create a codespace for any repository and branch. - * For more information about the `devcontainer.json` file, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#devcontainerjson)." - * For more information about machine types, see "[Changing the machine type for your codespace](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace#about-machine-types)." + * Você pode favoritar a página de opções para criar rapidamente um codespace para este repositório e branch. + * A página [https://github.com/codespaces/nova](https://github.com/codespaces/new) fornece uma maneira rápida de criar um codespace para qualquer repositório e branch. + * Para obter mais informações sobre o arquivo `devcontainer.json`, consulte "[Introdução aos contêineres de desenvolvimento](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#devcontainerjson)". + * Para obter mais informações sobre os tipos de máquina, consulte "[Alterando o tipo de máquina para seu codespace](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace#about-machine-types)". * {% data reusables.codespaces.codespaces-machine-type-availability %} {% endnote %} - 1. Click **Start session**. + 1. Clique **Iniciar sessão**. {% endwebui %} @@ -142,7 +142,7 @@ Solicita-se que você escolha um repositório, um branch e um tipo de máquina ( {% note %} -**Note**: Currently, {% data variables.product.prodname_cli %} doesn't allow you to choose a dev container configuration when you create a codespace. If you want to choose a specific dev container configuration, use the {% data variables.product.prodname_dotcom %} web interface to create your codespace. For more information, click the "Web browser" tab at the top of this page. +**Observação**: Atualmente, {% data variables.product.prodname_cli %} não permite que você escolha uma configuração de contêiner de desenvolvimento ao cria um codespace. Se você quiser escolher uma configuração de contêiner de desenvolvimento específica, use a interface web do {% data variables.product.prodname_dotcom %} para criar o seu codespace. Para mais informações, clique na aba "Navegador da Web" na parte superior desta página. {% endnote %} @@ -154,7 +154,7 @@ gh codespace create -r owner/repo -b branch -m ma Substitua `proprietário/repositório` pelo identificador do repositório. Substitua `branch` pelo nome do branch ou o hash SHA completo do commit, que você deseja fazer check-out inicialmente no codespace. Se você usar o sinalizador `-r` sem o sinalizador `b`, o codespace será criado a partir do branch padrão. -Substitua `machine-type` por um identificador válido para um tipo de máquina disponível. Os identificadores são strings como: `basicLinux32gb` e `standardLinux32gb`. The type of machines that are available depends on the repository, your personal account, and your location. Se você digitar um tipo de máquina inválido ou indisponível, os tipos disponíveis serão mostrados na mensagem de erro. Se você omitir este sinalizador e mais de um tipo de máquina estiver disponível, será solicitado que você escolha uma na lista. +Substitua `machine-type` por um identificador válido para um tipo de máquina disponível. Os identificadores são strings como: `basicLinux32gb` e `standardLinux32gb`. O tipo de máquina disponível depende do repositório, da sua conta pessoal e da sua localização. Se você digitar um tipo de máquina inválido ou indisponível, os tipos disponíveis serão mostrados na mensagem de erro. Se você omitir este sinalizador e mais de um tipo de máquina estiver disponível, será solicitado que você escolha uma na lista. Para obter mais informações sobre esse comando, consulte [o manual de{% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_codespace_create). diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md index 08ed5ab2ba..61ed17ef17 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/deleting-a-codespace.md @@ -55,42 +55,42 @@ Para excluir um codespace, use o comando `gh codespace delete` e, em seguida, es gh codespace delete ``` -Se você tiver alterações não salvas, será solicitado que você confirme a exclusão. You can use the `--force` flag to force deletion, avoiding this prompt. +Se você tiver alterações não salvas, será solicitado que você confirme a exclusão. Você pode usar o sinalizador `--force` para forçar a exclusão, evitando a instrução. Para obter mais informações sobre esse comando, consulte [o manual de{% data variables.product.prodname_cli %}](https://cli.github.com/manual/gh_codespace_delete). {% endcli %} -## Bulk deleting codespaces +## Exclusão de codespaces em massa {% webui %} -You can use {% data variables.product.prodname_cli %} to delete several or all of your codespaces with a single command. For more information, click the **{% data variables.product.prodname_cli %}** tab near the top of this page. +Você pode usar {% data variables.product.prodname_cli %} para excluir vários ou todos os seus codespaces com um único comando. Para obter mais informações, clique na aba **{% data variables.product.prodname_cli %}** perto da parte superior desta página. {% endwebui %} {% vscode %} -You can use {% data variables.product.prodname_cli %} to delete several or all of your codespaces with a single command. For more information, click the **{% data variables.product.prodname_cli %}** tab near the top of this page. +Você pode usar {% data variables.product.prodname_cli %} para excluir vários ou todos os seus codespaces com um único comando. Para obter mais informações, clique na aba **{% data variables.product.prodname_cli %}** perto da parte superior desta página. {% endvscode %} {% cli %} -You can delete several or all of your codespaces with a single command, using `gh codespace delete` followed by one of these flags: +Você pode excluir vários ou todos os seus codespaces com um único comando, usando o código `gh codespace delete` seguido por uma desses sinalizadores: -`--all` - Delete all of your codespaces. +`--all` - Exclua todos os seus codespaces. -`--repo REPOSITORY` - Delete all of your codespaces for this repository. Or use together with the `--days` flag to filter by age of the codespace. +`--repo REPOSITORY` - Exclua todos os seus codespaces do repositório. Ou use junto com o sinalizador `--days` para filtrar por idade do codespace. -`--days NUMBER` - Delete all of your codespaces that are older than the specified number of days. Can be used together with the `--repo` flag. +`--days NUMBER` - Exclua todos os seus codespaces que são mais antigos que o número de dias especificado. Pode ser usado junto com o sinalizador `--repo`. -By default you are prompted to confirm deletion of any codespaces that contain unsaved changes. You can use the `--force` flag to skip this confirmation. +Por padrão, solicita-se que você confirme a exclusão de todos os codespaces que contenham alterações não salvas. Você pode usar o sinalizador `--force` para pular esta confirmação. ### Exemplo -Delete all of the codespaces for the `octo-org/octo-repo` repository that you created more than 7 days ago. +Excluir todos os codespaces do repositório `octo-org/octo-repo` que você criou há mais de 7 dias. ``` gh cs delete --repo octo-org/octo-repo --days 7 diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-for-pull-requests.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-for-pull-requests.md index c6ee18c10b..55fd89cb48 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-for-pull-requests.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-for-pull-requests.md @@ -27,7 +27,7 @@ topics: 2. Na lista de pull requests, clique no pull request que deseja abrir em {% data variables.product.prodname_codespaces %}. 3. No lado direito da sua tela, clique em **Código de {% octicon "code" aria-label="The code icon" %}**. -4. In the {% data variables.product.prodname_codespaces %} tab, click **Create codespace on BRANCH**. ![Opção para abrir RP em um codespace](/assets/images/help/codespaces/open-with-codespaces-pr.png) +4. Na aba {% data variables.product.prodname_codespaces %}, clique em **Criar codespace no BRANCH**. ![Opção para abrir RP em um codespace](/assets/images/help/codespaces/open-with-codespaces-pr.png) ## Revendo um pull request em {% data variables.product.prodname_codespaces %} diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md index 545e286a6e..c6bc888387 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md @@ -75,7 +75,7 @@ Use o {% data variables.product.prodname_vs %} Marketplace para instalar a exten ## Alterar o tipo da máquina em {% data variables.product.prodname_vscode %} -{% data reusables.codespaces.codespaces-machine-types %} You can change the machine type of your codespace at any time. +{% data reusables.codespaces.codespaces-machine-types %} Você pode alterar o tipo de máquina do seu codespace a qualquer momento. 1. Em {% data variables.product.prodname_vscode %}, abra a Paleta de Comando (`shift comando P` / `shift control P`). 1. Pesquise e selecione "Codespaces: Alterar tipo de máquina." diff --git a/translations/pt-BR/content/codespaces/getting-started/deep-dive.md b/translations/pt-BR/content/codespaces/getting-started/deep-dive.md index f11a5e809b..7d6e1cee13 100644 --- a/translations/pt-BR/content/codespaces/getting-started/deep-dive.md +++ b/translations/pt-BR/content/codespaces/getting-started/deep-dive.md @@ -24,7 +24,7 @@ Há uma série de pontos de entrada para criar um codespace. Seu codespace pode ser efêmero se você tiver de fazer algum teste ou você pode retornar ao mesmo codespace para fazer um trabalho de recurso de longo prazo. Para obter mais informações, consulte "[Criar um codespace](/codespaces/developing-in-codespaces/creating-a-codespace)". -Once you've selected the option to create a new codespace, and optionally selected from the various configuration options for your codespace, some steps happen in the background before the codespace is available to you. +Uma vez selecionada a opção de criar um novo codespace, e opcionalmente selecionada a partir das várias opções de configuração do seu codespace, algumas etapas acontecem em segundo plano antes que o codespace esteja disponível para você. ![Botão de abrir com codespaces](/assets/images/help/codespaces/new-codespace-button.png) @@ -97,7 +97,7 @@ O Git está disponível por padrão no seu codespace. Portanto, você pode confi ![Executando o status do git no terminal do codespaces](/assets/images/help/codespaces/git-status.png) -Você pode criar um codespace a partir de qualquer branch, commit ou pull request no seu projeto, ou você pode mudar para branch novo branch ou branch existente de dentro do seu codespace ativo. Uma vez que {% data variables.product.prodname_codespaces %} foi projetado para ser efêmero, você pode usá-lo como um ambiente isolado para experimentar, verificar o pull request de um amigo de equipe ou corrigir os conflitos de merge. Você pode criar mais de um código de espaço por repositório ou até mesmo por branch. However, each personal account has a limit of 10 codespaces. Se você atingiu o limite e deseja criar um novo espaço de código, você deve primeiro excluir um código. +Você pode criar um codespace a partir de qualquer branch, commit ou pull request no seu projeto, ou você pode mudar para branch novo branch ou branch existente de dentro do seu codespace ativo. Uma vez que {% data variables.product.prodname_codespaces %} foi projetado para ser efêmero, você pode usá-lo como um ambiente isolado para experimentar, verificar o pull request de um amigo de equipe ou corrigir os conflitos de merge. Você pode criar mais de um código de espaço por repositório ou até mesmo por branch. No entanto, cada conta pessoal tem um limite de 10 codespaces. Se você atingiu o limite e deseja criar um novo espaço de código, você deve primeiro excluir um código. {% note %} diff --git a/translations/pt-BR/content/codespaces/getting-started/quickstart.md b/translations/pt-BR/content/codespaces/getting-started/quickstart.md index c810b85c07..5a7022695b 100644 --- a/translations/pt-BR/content/codespaces/getting-started/quickstart.md +++ b/translations/pt-BR/content/codespaces/getting-started/quickstart.md @@ -25,9 +25,9 @@ Para obter mais informações sobre exatamente como {% data variables.product.pr 1. Acesse o r[repositório do modelo](https://github.com/2percentsilk/haikus-for-codespaces) e selecione **Usar este modelo**. -2. Name your repository, select your preferred privacy setting, and click **Create repository from template**. +2. Nomeie seu repositório, selecione sua configuração de privacidade preferida e clique em **Criar repositório a partir do modelo**. -3. Acesse a página principal do repositório recém-criado. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on main**. +3. Acesse a página principal do repositório recém-criado. No nome do repositório, use o menu suspenso **Código de {% octicon "code" aria-label="The code icon" %}** e na guia **Codespaces**, clique em **Criar codespace no principal**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) diff --git a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md index 22c76f3330..a08121524c 100644 --- a/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md +++ b/translations/pt-BR/content/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces.md @@ -20,7 +20,7 @@ redirect_from: {% warning %} -**Deprecation note**: The access and security setting is now deprecated. To enable expanded access to other repositories, add the requested permissions to your dev container definition. For more information, see "[Managing access to other repositories within your codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)." +**Nota de obsolescência**: A configuração de acesso e segurança está obsoleta. Para habilitar o acesso expandido a outros repositórios, adicione as permissões solicitadas à definição do contêiner de desenvolvimento. Para obter mais informações, consulte "[Gerenciar o acesso a outros repositórios dentro de seu codespace](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)". {% endwarning %} diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md index 7504fe78f5..362e7d87ae 100644 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md +++ b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces.md @@ -22,7 +22,7 @@ shortTitle: Segredos criptografados ## Sobre os segredos criptografados para {% data variables.product.prodname_codespaces %} -You can add encrypted secrets to your personal account that you want to use in your codespaces. Por exemplo, você pode querer armazenar e acessar as seguintes informações confidenciais como segredos criptografados. +Você pode adicionar segredos criptografados à sua conta pessoal que deseja usar nos seus codespaces. Por exemplo, você pode querer armazenar e acessar as seguintes informações confidenciais como segredos criptografados. - Tokens de acesso pessoal para os serviços da nuvem - Entidades de serviço diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index 0d0396e5ae..4ed70db7d5 100644 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/translations/pt-BR/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -1,5 +1,5 @@ --- -title: Managing access to other repositories within your codespace +title: Gerenciando acesso a outros repositórios no seu codespace allowTitleToDifferFromFilename: true shortTitle: Acesso ao repositório intro: 'Você pode gerenciar os repositórios que {% data variables.product.prodname_codespaces %} pode acessar.' @@ -16,22 +16,22 @@ redirect_from: ## Visão Geral -By default, your codespace is assigned a token scoped to the repository from which it was created. For more information, see "[Security in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/security-in-codespaces#authentication)." If your project needs additional permissions for other repositories, you can configure this in the `devcontainer.json` file and ensure other collaborators have the right set of permissions. +Por padrão, seu código é atribuído um escopo de token para o repositório a partir do qual ele foi criado. Para obter mais informações, consulte "[Segurança em {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/security-in-codespaces#authentication)". Se o seu projeto precisar de permissões adicionais para outros repositórios, você poderá configurar isso no arquivo `devcontainer.json` e certificar-se de que outros colaboradores tenham o conjunto correto de permissões. -When permissions are listed in the `devcontainer.json` file, you will be prompted to review and authorize the additional permissions as part of codespace creation for that repository. Once you've authorized the listed permissions, {% data variables.product.prodname_github_codespaces %} will remember your choice and will not prompt you for authorization unless the permissions in the `devcontainer.json` file change. +Quando as permissões são listadas no arquivo `devcontainer.json`, será solicitado que você revise e autorize as permissões adicionais como parte da criação do codespace para esse repositório. Uma vez autorizadas as permissões listadas, {% data variables.product.prodname_github_codespaces %} lembrará de sua escolha e não pedirá autorização a menos que as permissões no arquivo `devcontainer.json` sejam alteradas. ## Pré-requisitos -To create codespaces with custom permissions defined, you must use one of the following: -* The {% data variables.product.prodname_dotcom %} web UI -* [{% data variables.product.prodname_dotcom %} CLI](https://github.com/cli/cli/releases/latest) 2.5.2 or later -* [{% data variables.product.prodname_github_codespaces %} Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) 1.5.3 or later +Para criar codespaces com permissões personalizadas definidas, você deve usar um dos seguintes: +* A interface de usuário web do {% data variables.product.prodname_dotcom %} +* [CLI de {% data variables.product.prodname_dotcom %}](https://github.com/cli/cli/releases/latest) 2.5.2 ou posterior +* [Extensão do Visual Studio Code de{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) 1.5.3 ou superior -## Setting additional repository permissions +## Configurando permissões adicionais do repositório -1. You configure repository permissions for {% data variables.product.prodname_github_codespaces %} in the `devcontainer.json` file. Se o seu repositório ainda não contiver um arquivo `devcontainer.json`, adicione um agora. For more information, "[Add a dev container to your project](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces)." +1. Você configura as permissões do repositório para {% data variables.product.prodname_github_codespaces %} no arquivo `devcontainer.json`. Se o seu repositório ainda não contiver um arquivo `devcontainer.json`, adicione um agora. Para mais informações, "[Adicione um contêiner de desenvolvimento ao seu projeto](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces)". -1. Edit the `devcontainer.json` file, adding the repository name and permissions needed to the `repositories` object: +1. Edite o arquivo `devcontainer.json`, adicionando o nome do repositório e as permissões necessárias ao objeto `repositórios`. ```json{:copy} { @@ -51,24 +51,24 @@ To create codespaces with custom permissions defined, you must use one of the fo {% note %} - **Note:** You can only reference repositories that belong to the same personal account or organization as the repository you are currently working in. + **Observação:** Você só pode fazer referência a repositórios que pertencem à mesma conta pessoal ou organização do repositório no qual você está trabalhando atualmente. {% endnote %} - You can grant as many or as few of the following permissions for each repository listed: - * `actions` - read / write - * `checks` - read / write - * `contents` - read / write - * `deployments` - read / write - * `discussions` - read / write - * `issues` - read / write - * `pages` - read / write - * `pull_requests` - read / write - * `repository_projects` - read / write - * `statuses` - read / write - * `workflows` - write + Você pode conceder as seguintes permissões para cada repositório listado: + * `actions` - leitura / gravação + * `checks` - leitura / gravação + * `contents` - leitura / gravação + * `deployments` - leitura / gravação + * `discussions` - leitura / gravação + * `issues` - leitura / gravação + * `pages` - leitura / gravação + * `pull_requests` - leitura / gravação + * `repository_projects` - leitura / gravação + * `statuses` - leitura / gravação + * `workflows` -gravação - To set a permission for all repositories in an organization, use the `*` wildcard following your organization name in the `repositories` object. + Para definir uma permissão para todos os repositórios na organização, use o curinga `*` que segue o nome da organização no objeto `repositórios`. ```json { @@ -86,7 +86,7 @@ To create codespaces with custom permissions defined, you must use one of the fo } ``` - To set all permissions for a given repository, use `read-all` or `write-all` in the `permissions` object + Para definir todas as permissões para um determinado repositório, use `read-all` ou `write-all` no objeto `permissões` ```json { @@ -104,29 +104,29 @@ To create codespaces with custom permissions defined, you must use one of the fo } ``` -## Authorizing requested permissions +## Autorizando permissões solicitadas -If additional repository permissions are defined in the `devcontainer.json` file, you will be prompted to review and optionally authorize the permissions when you create a codespace for this repository. When you authorize permissions for a repository, {% data variables.product.prodname_github_codespaces %} will not re-prompt you unless the set of requested permissions has changed for the repository. +Se as permissões adicionais do repositório forem definidas no arquivo `devcontainer.json`, será apens solicitado que você revise e, opcionalmente, autorize as permissões ao criar um codespace para este repositório. Ao autorizar permissões para um repositório, {% data variables.product.prodname_github_codespaces %} não irá perguntar você novamente a menos que o conjunto das permissões solicitadas tenha sido alterado no repositório. -![The requested permissions page](/assets/images/help/codespaces/codespaces-accept-permissions.png) +![Página de permissões solicitadas](/assets/images/help/codespaces/codespaces-accept-permissions.png) -You should only authorize permissions for repositories you know and trust. If you don't trust the set of requested permissions, click **Continue without authorizing** to create the codespace with the base set of permissions. Rejecting additional permissions may impact the functionality of your project within the codespace as the codespace will only have access to the repository from which it was created. +Você deve autorizar permissões apenas para repositórios que você conhece e confia. Se você não confia no conjunto das permissões solicitadas, clique em **Continuar sem autorizar** para criar o codespace com o conjunto base de permissões. Rejeitar permissões adicionais pode impactar a funcionalidade do seu projeto dentro do codespace, uma vez que este apenas terá acesso ao repositório no qual ele foi criado. -You can only authorize permissions that your personal account already possesses. If a codespace requests permissions for repositories that you don't currently have access to, contact an owner or admin of the repository to obtain sufficient access and then try to create a codespace again. +Você só pode autorizar as permissões que sua conta pessoal já possui. Se um codespace solicita permissões para repositórios aos quais você não tem acesso atualmente, entre em contato com o proprietário ou administrador do repositório para obter acessoe, em seguida, tente criar um codespace novamente. -## Access and security +## Acesso e segurança {% warning %} -**Deprecation note**: The access and security setting, in the {% data variables.product.prodname_codespaces %} section of your personal account settings, is now deprecated. To enable expanded access to other repositories, add the requested permissions to your dev container definition for your codespace, as described above. +**Observação de depreciação**: A configuração de acesso e segurança, na seção {% data variables.product.prodname_codespaces %} das configurações da sua conta pessoal está obsoleta. Para habilitar o acesso expandido a outros repositórios, adicione as permissões solicitadas à definição do contêiner de desenvolvimento para seu codespace, conforme descrito acima. {% endwarning %} -When you enable access and security for a repository owned by your personal account, any codespaces that are created for that repository will have read permissions to all other repositories you own. Se você deseja restringir os repositórios que um código pode acessar, você pode limitá-lo tanto para o repositório no qual o código foi aberto ou para repositórios específicos. Você só deve habilitar o acesso e a segurança para repositórios nos quais confia. +Ao habilitar o acesso e a segurança de um repositório pertencente à sua conta pessoal, todos os códigos que forem criados para esse repositório terão permissões de leitura em todos os outros repositórios que você possui. Se você deseja restringir os repositórios que um código pode acessar, você pode limitá-lo tanto para o repositório no qual o código foi aberto ou para repositórios específicos. Você só deve habilitar o acesso e a segurança para repositórios nos quais confia. {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.codespaces-tab %} -1. Under "Access and security", select the setting you want for your personal account. +1. Em "Acesso e segurança", selecione a configuração que deseja para sua conta pessoal. ![Botões de opção para gerenciar repositórios confiáveis](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) diff --git a/translations/pt-BR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md b/translations/pt-BR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md index 11ab68567a..de096800ce 100644 --- a/translations/pt-BR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md +++ b/translations/pt-BR/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces.md @@ -16,7 +16,7 @@ topics: ## Sobre os logs de segurança de {% data variables.product.prodname_codespaces %} -When you perform an action related to {% data variables.product.prodname_codespaces %} in repositories owned by your personal account, you can review the actions in the security log. Para obter informações sobre acesso ao registro, consulte "[Revisar seu log de segurança](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)". +Quando você executar uma ação relacionada a {% data variables.product.prodname_codespaces %} em repositórios pertencentes à sua conta pessoal, você poderá revisar as ações no log de segurança. Para obter informações sobre acesso ao registro, consulte "[Revisar seu log de segurança](/github/authenticating-to-github/reviewing-your-security-log#accessing-your-security-log)". ![log de segurança com informações de codespaces](/assets/images/help/settings/codespaces-audit-log.png) diff --git a/translations/pt-BR/content/codespaces/overview.md b/translations/pt-BR/content/codespaces/overview.md index e40b75c57c..1e6ce1566d 100644 --- a/translations/pt-BR/content/codespaces/overview.md +++ b/translations/pt-BR/content/codespaces/overview.md @@ -30,9 +30,9 @@ Um codespace é um ambiente de desenvolvimento hospedado na nuvem. Você pode pe Você pode criar um codespace a partir de qualquer branch ou commit no seu repositório e começar a desenvolver usando recursos de computação baseados na nuvem. {% data reusables.codespaces.links-to-get-started %} -To customize the runtimes and tools in your codespace, you can create one or more dev container configurations for your repository. Adding dev container configurations to your repository allows you to define a choice of different development environments that are appropriate for the work people will do in your repository. +Para personalizar os tempos de execução e ferramentas no seu codespace, é possível criar uma ou mais configurações de contêiner de desenvolvimento para o seu repositório. Adicionar configurações de contêiner de desenvolvimento ao repositório permite que você defina uma escolha de diferentes ambientes de desenvolvimento que sejam apropriados para o trabalho que as pessoas farão no seu repositório. -If you don't add a dev container configuration, {% data variables.product.prodname_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. Para obter mais informações, consulte "[Introdução a contêineres de desenvolvimento](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". +Se você não adicionar uma configuração de contêiner de desenvolvimento, o {% data variables.product.prodname_codespaces %} clonará seu repositório em um ambiente com a imagem de código padrão que inclui muitas ferramentas, linguagens e ambientes de tempo de execução. Para obter mais informações, consulte "[Introdução a contêineres de desenvolvimento](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". Você também pode personalizar aspectos do ambiente do seu codespace usando um repositório público do [dotfiles](https://dotfiles.github.io/tutorials/) e [Sincronização de configurações](https://code.visualstudio.com/docs/editor/settings-sync). A personalização pode incluir preferências de shell, ferramentas adicionais, configurações de editor e extensões de código VS. Para obter mais informações, consulte[Personalizando seu codespace](/codespaces/customizing-your-codespace)". diff --git a/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md index bf0b2f3b75..43fa1d38f8 100644 --- a/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md +++ b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/about-codespaces-prebuilds.md @@ -16,9 +16,9 @@ product: '{% data reusables.gated-features.codespaces %}' A pré-construção de seus codespaces permite que você seja mais produtivo e tenha acesso ao seu codespace mais rápido, independentemente do tamanho e complexidade do seu projeto. Isso ocorre porque qualquer código-fonte, extensões de editor, dependências de projetos, comandos e configurações já foram baixadas, instaladas e aplicadas antes de criar um codespace para o seu projeto. Pense em uma pré-compilação como um modelo pronto para um codespace. -By default, whenever you push changes to your repository, {% data variables.product.prodname_codespaces %} uses {% data variables.product.prodname_actions %} to automatically update your prebuilds. +Por padrão, sempre que você fizer alterações no repositório, {% data variables.product.prodname_codespaces %} irá usar {% data variables.product.prodname_actions %} para atualizar automaticamente suas pré-criações. -When prebuilds are available for a particular branch of a repository, and for your region, you'll see the "{% octicon "zap" aria-label="The zap icon" %} Prebuild ready" label in the list of machine type options when you create a codespace. Para obter mais informações, consulte "[Criar um codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)". +Quando as pré-criações estiverem disponíveis para um branch específico de um repositório e para sua região, você verá a etiqueta "Pré-criação de {% octicon "zap" aria-label="The zap icon" %} pronto" na lista de opções de tipo de máquina ao criar um codespace. Para obter mais informações, consulte "[Criar um codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)". ![A caixa de diálogo para escolher um tipo de máquina](/assets/images/help/codespaces/choose-custom-machine-type.png) @@ -36,9 +36,9 @@ O uso de codespaces criados usando pré-criações é cobrado na mesma frequênc ## Sobre fazer push de alterações em branches com pré-criação -By default, each push to a branch that has a prebuild configuration results in a {% data variables.product.prodname_dotcom %}-managed Actions workflow run to update the prebuild template. O fluxo de trabalho da pré-criação tem um limite de concorrência de uma execução de fluxo de trabalho de cada vez para uma determinada configuração de pré-compilação, a não ser que tenham sido feitas alterações que afetem a configuração do contêiner de desenvolvimento do repositório associado. Para obter mais informações, consulte "[Introdução a contêineres de desenvolvimento](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)". Se uma execução já estiver em andamento, a execução do fluxo de trabalho que foi enfileirada mais recentemente será executada a seguir, depois que a execução atual for concluída. +Por padrão, cada push em um branch que tem uma configuração de pré-criação resulta em um fluxo de trabalho de ações gerenciadas por {% data variables.product.prodname_dotcom %} para atualizar o modelo de pré-criação. O fluxo de trabalho da pré-criação tem um limite de concorrência de uma execução de fluxo de trabalho de cada vez para uma determinada configuração de pré-compilação, a não ser que tenham sido feitas alterações que afetem a configuração do contêiner de desenvolvimento do repositório associado. Para obter mais informações, consulte "[Introdução a contêineres de desenvolvimento](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)". Se uma execução já estiver em andamento, a execução do fluxo de trabalho que foi enfileirada mais recentemente será executada a seguir, depois que a execução atual for concluída. -With the prebuild template set to be updated on each push, it means that if there are very frequent pushes to your repository, prebuild template updates will occur at least as often as it takes to run the prebuild workflow. That is, if your workflow run typically takes one hour to complete, prebuilds will be created for your repository roughly hourly, if the run succeeds, or more often if there were pushes that change the dev container configuration on the branch. +Com o conjunto de modelos de pré-criação a ser atualizados em cada push, significa que se os pushes forem muito frequentes no seu repositório, as atualizações do modelo de pré-criação ocorrerão pelo menos com a frequência necessária para executar o fluxo de trabalho pré-criado. Ou seja, se a execução do fluxo de trabalho normalmente leva uma hora para ser concluída, serão criadas pré-compilações para o repositório em aproximadamente uma hora, se a execução for bem sucedida, ou mais frequentemente se houve pushes que alteram a configuração do contêiner de desenvolvimento no branch. Por exemplo, vamos imaginar que 5 pushes são feitos, em rápida sucessão, para um branch que tem uma configuração de pré-compilação. Nesta situação: diff --git a/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 9390b1e91e..b0b5f32897 100644 --- a/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -60,13 +60,13 @@ Antes de configurar as pré-compilações para seu projeto, os pontos a seguir d {% endnote %} -1. Choose how you want to automatically trigger updates of the prebuild template. +1. Escolha como você quer acionar automaticamente as atualizações do modelo de pré-criação. - * **Every push** (the default setting) - With this setting, prebuild configurations will be updated on every push made to the given branch. This will ensure that codespaces generated from a prebuild template always contain the latest codespace configuration, including any recently added or updated dependencies. - * **On configuration change** - With this setting, prebuild configurations will be updated every time associated configuration files for a given repo and branch are updated. This ensures that changes to the dev container configuration files for the repository are used when a codespace is generated from a prebuild template. The Actions workflow that updates the prebuild template will run less often, so this option will use fewer Actions minutes. However, this option will not guarantee that codespaces always include recently added or updated dependencies, so these may have to be added or updated manually after a codespace has been created. - * **Scheduled** - With this setting, you can have your prebuild configurations update on a custom schedule that's defined by you. This can reduce consumption of Actions minutes, and reduce the amount of time during which prebuilds are unavailable because they are being updated. However, with this option, codespaces may be created that do not use the latest dev container configuration changes. + * **Cada push** (a configuração padrão) - Com esta configuração, configurações de pré-criação serão atualizadas a cada push feito para o branch determinado. Isto irá garantir que os codespaces gerados a partir de um template de pré-criação sempre contenham as configurações mais recentes de codespace, incluindo as dependências adicionadas recentemente ou atualizadas. + * **Na alteração da configuração** - Com essa configuração, as configurações de pré-criação serão atualizadas toda vez que os arquivos de configuração associados para um determinado repositório e branch forem atualizados. Isso garante que as alterações nos arquivos de configuração de contêiner de desenvolvimento do repositório sejam usadas quando um codespace for gerado a partir de um modelo de pré-criação. O fluxo de trabalho de ações que atualizar o template de pré-criação será executado menos vezes. Portanto, esta opção usará menos minutos de ações. No entanto, esta opção não garante que os codespaces sempre incluam dependências recentemente adicionadas ou atualizadas. Portanto, elas podem ser adicionadas ou atualizadas manualmente depois que o codespace for criado. + * **Agendado** - Com esta configuração, você pode atualizar suas configurações de pré-criação em um agendamento personalizado definido por você. Isso pode reduzir o consumo de minutos de ações e reduzir a quantidade de tempo durante o qual as pré-criações não estão disponíveis porque estão sendo atualizadas. No entanto, com esta opção, é possível que se criem codespaces podem que não usam as últimas alterações de configuração de contêiner de desenvolvimento - ![The prebuild trigger options](/assets/images/help/codespaces/prebuilds-triggers.png) + ![As opções de acionamento de pré-criação](/assets/images/help/codespaces/prebuilds-triggers.png) 1. Clique em **Criar**. diff --git a/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md index f690d8d353..9820f53fd7 100644 --- a/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md +++ b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md @@ -16,17 +16,17 @@ miniTocMaxHeadingLevel: 3 ## Verificando, alterando e excluindo suas configurações de pré-compilação -The prebuilds that you configure for a repository are created and updated using a {% data variables.product.prodname_actions %} workflow, managed by the {% data variables.product.prodname_codespaces %} service. +As pré-compilações que você configurar para um repositórios são criadas e atualizadas usando um fluxo de trabalho de {% data variables.product.prodname_actions %}, gerenciado pelo serviço de {% data variables.product.prodname_codespaces %}. -Depending on the settings in a prebuild configuration, the workflow to update the prebuild template may be triggered by these events: +Dependendo das configurações em uma configuração de pré-criação, o fluxo de trabalho para atualizar o modelo de pré-criação poderá ser acionado por esses eventos: * Criando ou atualizando a configuração de pré-compilação * Enviando por push um commit ou um pull request para um branch configurado para pré-compilações -* Changing any of the dev container configuration files -* A schedule that you've defined in the prebuild configuration +* Alterando qualquer um dos arquivos de configuração de contêiner de desenvolvimento +* Um agendamento que você definiu na configuração de pré-criação * Acionando manualmente o fluxo de trabalho -The settings in the prebuild configuration determine which events automatically trigger an update of the prebuild template. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." +As configurações na configuração de pré-criação determinam quais eventos acionaram automaticamente uma atualização do modelo de pré-criação. Para obter mais informações, consulte "[Configurando pré-criações](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)". As pessoas com acesso de administrador a um repositório podem verificar o progresso de pré-compilações, editar e excluir configurações de pré-criação. diff --git a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 9223ed7bf5..1c8030b293 100644 --- a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -1,6 +1,6 @@ --- title: Introdução aos contêineres de desenvolvimento -intro: 'When you work in a codespace, the environment you are working in is created using a development container, or dev container, hosted on a virtual machine.' +intro: 'Ao trabalhar em um codespace, o ambiente em que você está trabalhando é criado usando um contêiner de desenvolvimento, ou contêiner de dev, hospedado em uma máquina virtual.' permissions: People with write permissions to a repository can create or edit the codespace configuration. redirect_from: - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project @@ -21,65 +21,65 @@ product: '{% data reusables.gated-features.codespaces %}' ## Sobre contêineres de desenvolvimento -Development containers, or dev containers, are Docker containers that are specifically configured to provide a full-featured development environment. Whenever you work in a codespace, you are using a dev container on a virtual machine. +Contêineres de desenvolvimento, ou contêineres de dev, são contêineres Docker configurados especificamente para fornecer um ambiente de desenvolvimento completo. Sempre que você trabalha em um codespace, você usa um contêiner de desenvolvimento em uma máquina virtual. -You can configure the dev container for a repository so that codespaces created for that repository give you a tailored development environment, complete with all the tools and runtimes you need to work on a specific project. If you don't define a configuration in the repository then {% data variables.product.prodname_github_codespaces %} uses a default configuration, which contains many of the common tools that your team might need for development with your project. For more information, see "[Using the default dev container configuration](#using-the-default-dev-container-configuration)." +É possível configurar o contêiner de desenvolvimento de um repositório para que códigos criados para esse repositório forneçam um ambiente de desenvolvimento personalizado. conclua com todas as ferramentas e tempos de execução que você precisa para trabalhar em um projeto específico. Se você não definir uma configuração no repositório, {% data variables.product.prodname_github_codespaces %} usará uma configuração-padrão, que contém muitas das ferramentas comuns que sua equipe pode precisar para desenvolver com o seu projeto. Para obter mais informações, consulte "[Usando o contêiner padrão de configuração de desenvolvimento](#using-the-default-dev-container-configuration)". -The configuration files for a dev container are contained in a `.devcontainer` directory in your repository. You can use {% data variables.product.prodname_vscode %} to add configuration files for you. You can choose from a selection of predefined configurations for various project types. You can use these without further configuration, or you can edit the configurations to refine the development environment they produce. For more information, see "[Using a predefined dev container configuration](#using-a-predefined-dev-container-configuration)." +Os arquivos de configuração para um contêiner de desenvolvimento estão contidos em um diretório `.devcontainer` no seu repositório. Você pode usar {% data variables.product.prodname_vscode %} para adicionar arquivos de configuração para você. Você pode escolher entre uma seleção de configurações predefinidas para vários tipos de projeto. Você pode usar essas configurações sem outras configurações ou pode editar as configurações para refinar o ambiente de desenvolvimento que elas produzem. Para obter mais informações, consulte "[Usando um contêiner de configuração de desenvolvimento predefinido](#using-a-predefined-dev-container-configuration)". -Alternatively, you can add your own custom configuration files. For more information, see "[Creating a custom dev container configuration](#creating-a-custom-dev-container-configuration)." +Como alternativa, você pode adicionar seus próprios arquivos de configuração personalizados. Para obter mais informações, consulte "[Criando uma configuração personalizada do contêiner de desenvolvimento](#creating-a-custom-dev-container-configuration)". -You can define a single dev container configuration for a repository, different configurations for different branches, or multiple configurations. When multiple configurations are available, users can choose their preferred configuration when they create a codespace. This is particularly useful for large repositories that contain source code in different programming languages or for different projects. You can create a choice of configurations that allow different teams to work in a codespace that's set up appropriately for the work they are doing. +É possível definir uma configuração de contêiner de desenvolvimento único para um repositório, configurações diferentes para branches diferentes ou várias configurações. Quando várias configurações estão disponíveis, os usuários podem escolher a sua configuração preferida quando criarem um codespace. Isso é particularmente útil para grandes repositórios que contêm código-fonte em diferentes linguagens de programação ou para diferentes projetos. Você pode criar uma variedade de configurações que permitem que diferentes equipes trabalhem em um codespace configurado adequadamente para o trabalho que estão fazendo. ### devcontainer.json -The primary file in a dev container configuration is the `devcontainer.json` file. You can use this file to determine the environment of codespaces created for your repository. The contents of this file define a dev container that can include frameworks, tools, extensions, and port forwarding. The `devcontainer.json` file usually contains a reference to a Dockerfile, which is typically located alongside the `devcontainer.json` file. +O arquivo primário em uma configuração de contêiner de desenvolvimento é o arquivo `devcontainer.json`. Você pode usar este arquivo para determinar o ambiente de codespaces criados no seu repositório. O conteúdo deste arquivo define um contêiner de desenvolvimento que pode incluir estruturas, ferramentas, extensões e encaminhamento de porta. O arquivo `devcontainer.json` geralmente contém uma referência a um arquivo Docker, que está normalmente localizado ao lado do arquivo `devcontainer.json`. -If you don't add a `devcontainer.json` file to your repository. the default dev container configuration is used. For more information, see "[Using the default dev container configuration](#using-the-default-dev-container-configuration)." +Se você não adicionar um arquivo `devcontainer.json` ao seu repositório. a configuração padrão do contêiner de desenvolvimento é usada. Para obter mais informações, consulte "[Usando o contêiner padrão de configuração de desenvolvimento](#using-the-default-dev-container-configuration)". -The `devcontainer.json` file is usually located in the `.devcontainer` directory of your repository. Alternatively, you can locate it directly in the root of the repository, in which case the file name must begin with a period: `.devcontainer.json`. +O arquivo `devcontainer.json` normalmente está localizado no diretório `.devcontainer` do seu repositório. Como alternativa, você pode localizá-lo diretamente na raiz do repositório, nesse caso o nome do arquivo deve começar com um ponto: `.devcontainer.json`. -If you want to have a choice of dev container configurations in your repository, any alternatives to the `.devcontainer/devcontainer.json` (or `.devcontainer.json`) file must be located in their own subdirectory at the path `.devcontainer/SUBDIRECTORY/devcontainer.json`. For example, you could have a choice of two configurations: +Se você quiser ter uma escolha de configurações de contêiner de desenvolvimento no seu repositório, todas as alternativas ao arquivo `.devcontainer/devcontainer.json` (ou `.devcontainer.json`) devem estar localizadas no seu próprio subdiretório no caminho `.devcontainer/SUBDIRECTORY/devcontainer.json`. Por exemplo, você poderia escolher entre duas configurações: * `.devcontainer/database-dev/devcontainer.json` * `.devcontainer/gui-dev/devcontainer.json` -When you have multiple `devcontainer.json` files in your repository, each codespace is created from only one of the configurations. Settings cannot be imported or inherited between `devcontainer.json` files. If a `devcontainer.json` file in a custom subdirectory has dependent files, such as the Dockerfile or scripts that are run by commands in the `devcontainer.json` file, it's recommended that you co-locate these files in the same subdirectory. +Quando você tem vários arquivos `devcontainer.json` no seu repositório, cada codespace é criado a partir apenas de uma das configurações. As configurações não podem ser importadas ou herdadas entre os arquivos `devcontainer.json`. Se um arquivo `devcontainer.json` em um subdiretório personalizado tiver arquivos dependentes, como o arquivo Docker ou scripts executados por comandos no arquivo `devcontainer.json`, recomenda-se que você colocalize esses arquivos no mesmo subdiretório. -For information about how to choose your preferred dev container configuration when you create a codespace, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)." +Para obter informações sobre como escolher sua configuração preferida de contêiner de desenvolvimento ao criar um codespace, consulte "[Criando um codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)" {% data reusables.codespaces.more-info-devcontainer %} -#### How to use the devcontainer.json +#### Como usar o devcontainer.json -It's useful to think of the `devcontainer.json` file as providing "customization" rather than "personalization." You should only include things that everyone working on your codebase needs as standard elements of the development environment, not things that are personal preferences. Things like linters are good to standardize on, and to require everyone to have installed, so they're good to include in your `devcontainer.json` file. Things like user interface decorators or themes are personal choices that should not be put in the `devcontainer.json` file. +It's useful to think of the `devcontainer.json` file as providing "customization" rather than "personalization." Você só deve incluir coisas que todos que trabalham em sua base de código precisam como elementos padrão do ambiente de desenvolvimento, não coisas que são preferências pessoais. Coisas como os linters estão corretas para padronizar e exigir que todos realizaram a instalação. Portanto, são boas para incluir no seu arquivo `devcontainer.json`. Coisas como decoradores ou temas de interface de usuário são escolhas pessoais que não devem ser colocadas no arquivo `devcontainer.json`. -You can personalize your codespaces by using dotfiles and Settings Sync. For more information, see "[Personalizing Codespaces for your account](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account)." +You can personalize your codespaces by using dotfiles and Settings Sync. Para obter mais informações, consulte "[Personalizando os codespaces para a sua conta](/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account). " ### arquivo Docker -You can add a Dockerfile as part of your dev container configuration. +Você pode adicionar um arquivo Docker como parte da configuração do seu contêiner de dev. -The Dockerfile is a text file that contains the instructions needed to create a Docker container image. This image is used to generate a development container each time someone creates a codespace using the `devcontainer.json` file that references this Dockerfile. The instructions in the Dockerfile typically begin by referencing a parent image on which the new image that will be created is based. This is followed by commands that are run during the image creation process, for example to install software packages. +O arquivo Docker é um arquivo de texto que contém as instruções necessárias para criar uma imagem Docker. Essa imagem é usada para gerar um contêiner de desenvolvimento toda vez que alguém cria um codespace usando o arquivo `devcontainer.json` que faz referência a este arquivo Docker. As instruções no arquivo Docker normalmente começam referenciando uma imagem principal na qual a nova imagem que será criada se baseia. Isto é seguido por comandos executados durante o processo de criação de imagem, por exemplo, para instalar pacotes de software. -The Dockerfile for a dev container is typically located in the `.devcontainer` folder, alongside the `devcontainer.json` in which it is referenced. +O arquivo Docker para um contêiner de desenvolvimento está normalmente localizado na pasta `.devcontainer` ao lado do `devcontainer.json` no qual ele é referenciado. {% note %} -**Note**: As an alternative to using a Dockerfile you can use the `image` property in the `devcontainer.json` file to refer directly to an existing image you want to use. If neither a Dockerfile nor an image is found then the default container image is used. For more information, see "[Using the default dev container configuration](#using-the-default-dev-container-configuration)." +**Observação**: Como alternativa ao uso de um arquivo Docker você pode usar a propriedade `imagem` no arquivo `devcontainer.json` a ser referenciado diretamente a uma imagem existente que deseja usar. Se nem um arquivo Docker nem uma imagem forem encontrados, a imagem do contêiner padrão será utilizada. Para obter mais informações, consulte "[Usando o contêiner padrão de configuração de desenvolvimento](#using-the-default-dev-container-configuration)". {% endnote %} -#### Simple Dockerfile example +#### Exemplo de arquivo Docker simples -The following example uses four instructions: +O exemplo a seguir utiliza quatro instruções: -`ARG` defines a build-time variable. +`ARG`define a variável de tempo de construção. -`FROM` specifies the parent image on which the generated Docker image will be based. +`FROM` especifica a imagem principal na qual a imagem Docker gerada será baseada. -`COPY` copies a file and adds it to the filesystem. +`COPY` copia um arquivo e o adiciona ao sistema de arquivos. -`RUN` updates package lists and runs a script. You can also use a `RUN` instruction to install software, as shown by the commented out instructions. To run multiple commands, use `&&` to combine the commands into a single `RUN` statement. +`RUN` atualiza listas de pacotes e executa um script. Você também pode usar uma instrução `RUN` para instalar software, conforme mostrado nas instruções comentadas. Para executar vários comandos, use `&&` para combinar os comandos em uma única instrução `RUN`. ```Dockerfile{:copy} ARG VARIANT="16-buster" @@ -96,11 +96,11 @@ COPY library-scripts/github-debian.sh /tmp/library-scripts/ RUN apt-get update && bash /tmp/library-scripts/github-debian.sh ``` -For more information about Dockerfile instructions, see "[Dockerfile reference](https://docs.docker.com/engine/reference/builder)" in the Docker documentation. +Para obter mais informações sobre instruções do arquivo Docker, consulte "[referência do arquivo Docker](https://docs.docker.com/engine/reference/builder)" na documentação do Docker. -#### Using a Dockerfile +#### Usando um arquivo Docker -To use a Dockerfile as part of a dev container configuration, reference it in your `devcontainer.json` file by using the `dockerfile` property. +Para usar um arquivo Dockerfile como parte de uma configuração de contêiner de desenvolvimento, referencie-o no seu arquivo `devcontainer.json` usando a propriedade `dockerfile`. ```json{:copy} { @@ -110,11 +110,11 @@ To use a Dockerfile as part of a dev container configuration, reference it in yo } ``` -For more information about using a Dockerfile in a dev container configuration, see the {% data variables.product.prodname_vscode %} documentation "[Create a development container](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile)." +Para obter mais informações sobre como usar um arquivo Docker em uma configuração de contêiner de desenvolvimento, consulte a documentação de {% data variables.product.prodname_vscode %} "[Criar um contêiner de desenvolvimento](https://code.visualstudio.com/docs/remote/create-dev-container#_dockerfile). " -## Using the default dev container configuration +## Usando a configuração padrão do contêiner de desenvolvimento -If you don't define a configuration in your repository, {% data variables.product.prodname_dotcom %} creates a codespace using a default Linux image. This Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like Git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the URL that the command outputs. +Se você não definir uma configuração no repositório, o {% data variables.product.prodname_dotcom %} criará um codespace que usa uma imagem padrão do Linux. This Linux image includes languages and runtimes like Python, Node.js, JavaScript, TypeScript, C++, Java, .NET, PHP, PowerShell, Go, Ruby, and Rust. It also includes other developer tools and utilities like Git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the URL that the command outputs. Alternatively, for more information about everything that's included in the default Linux image, see the latest file in the [`microsoft/vscode-dev-containers`](https://github.com/microsoft/vscode-dev-containers/tree/main/containers/codespaces-linux) repository. @@ -122,14 +122,14 @@ The default configuration is a good option if you're working on a small project ## Using a predefined dev container configuration -You can choose from a list of predefined configurations to create a dev container configuration for your repository. These configurations provide common setups for particular project types, and can help you quickly get started with a configuration that already has the appropriate container options, {% data variables.product.prodname_vscode %} settings, and {% data variables.product.prodname_vscode %} extensions that should be installed. +É possível escolher uma lista de configurações predefinidas para criar uma configuração de contêiner de desenvolvimento para o seu repositório. Essas configurações fornecem configurações comuns para determinados tipos de projeto e podem ajudar você rapidamente a começar com uma configuração que já tem as opções de contêiner apropriadas, configurações do {% data variables.product.prodname_vscode %} e extensões do {% data variables.product.prodname_vscode %} que devem ser instaladas. -Usar uma configuração predefinida é uma ótima ideia se você precisa de uma extensão adicional. You can also start with a predefined configuration and amend it as needed for your project. +Usar uma configuração predefinida é uma ótima ideia se você precisa de uma extensão adicional. Você também pode começar com uma configuração predefinida e alterá-la conforme necessário para o seu projeto. -You can add a predefined dev container configuration either while working in a codespace, or while working on a repository locally. +É possível adicionar uma configuração predefinida de contêiner de desenvolvimento enquanto trabalha em um codespace ou enquanto trabalha em um repositório localmente. {% data reusables.codespaces.command-palette-container %} -1. Click the definition you want to use. +1. Clique na definição que você deseja usar. ![Lista de definições de contêiner predefinidas](/assets/images/help/codespaces/predefined-container-definitions-list.png) @@ -138,7 +138,7 @@ You can add a predefined dev container configuration either while working in a c ![Botão OK](/assets/images/help/codespaces/prebuilt-container-ok-button.png) -1. If you are working in a codespace, apply your changes, by clicking **Rebuild now** in the message at the bottom right of the window. Para obter mais informações sobre a reconstrução do seu contêiner, consulte "[Aplicar alterações na sua configuração](#applying-changes-to-your-configuration)". +1. Se você estiver trabalhando em um codespace, aplique suas alterações clicando em **Reconstruir agora** na mensagem na parte inferior direita da janela. Para obter mais informações sobre a reconstrução do seu contêiner, consulte "[Aplicar alterações na sua configuração](#applying-changes-to-your-configuration)". !["Códigos: Recriar contêiner" em {% data variables.product.prodname_vscode_command_palette %}](/assets/images/help/codespaces/rebuild-prompt.png) @@ -150,7 +150,7 @@ You can add a predefined dev container configuration either while working in a c {% endnote %} -You can add features to your predefined container configuration to customize which tools are available and extend the functionality of your workspace without having to create a custom dev container configuration from scratch. For example, you could use a predefined container configuration and add the {% data variables.product.prodname_cli %}. Você pode criar essas funcionalidades para o seu projeto adicionando as funcionalidades ao seu arquivo `devcontainer.json` ao definir a configuração do seu contêiner. +Você pode adicionar funcionalidades à configuração de contêiner predefinida para personalizar quais ferramentas estão disponíveis e estender a funcionalidade do seu espaço de trabalho sem ter que criar uma configuração personalizada de um contêiner de desenvolvimento a partir do zero. Por exemplo, você poderia usar uma configuração de contêiner predefinida e adicionar o {% data variables.product.prodname_cli %}. Você pode criar essas funcionalidades para o seu projeto adicionando as funcionalidades ao seu arquivo `devcontainer.json` ao definir a configuração do seu contêiner. Você pode adicionar algumas das características mais comuns selecionando-as na configuração do contêiner predefinido. Para obter mais informações sobre as funcionalidades disponíveis, consulte a biblioteca de script [](https://github.com/microsoft/vscode-dev-containers/tree/main/script-library#scripts) no repositório `vscode-dev-containers`. @@ -161,15 +161,15 @@ Você pode adicionar algumas das características mais comuns selecionando-as na 1. Atualize as seleções das suas funcioanlidades e clique em **OK**. - ![The select additional features menu during container configuration](/assets/images/help/codespaces/select-additional-features.png) + ![O menu de seleção de funcionalidades adicionais durante a configuração do contêiner](/assets/images/help/codespaces/select-additional-features.png) 1. Para aplicar as alterações, no canto inferior direito da tela, clique em **Reconstruir agora**. Para obter mais informações sobre a reconstrução do seu contêiner, consulte "[Aplicar alterações na sua configuração](#applying-changes-to-your-configuration)". !["Codespaces: Reconstruir contêiner" na paleta de comandos](/assets/images/help/codespaces/rebuild-prompt.png) -## Creating a custom dev container configuration +## Criando uma configuração de contêiner de desenvolvimento personalizada -If none of the predefined configurations meets your needs, you can create a custom configuration by writing your own `devcontainer.json` file. +Se nenhuma das configurações predefinidas atender às suas necessidades, você poderá criar uma configuração personalizada escrevendo seu próprio arquivo `devcontainer.json`. * If you're adding a single `devcontainer.json` file that will be used by everyone who creates a codespace from your repository, create the file within a `.devcontainer` directory at the root of the repository. * If you want to offer users a choice of configuration, you can create multiple custom `devcontainer.json` files, each located within a separate subdirectory of the `.devcontainer` directory. @@ -186,19 +186,19 @@ If none of the predefined configurations meets your needs, you can create a cust ### Default configuration selection during codespace creation -If `.devcontainer/devcontainer.json` or `.devcontainer.json` exists, it will be the default selection in the list of available configuration files when you create a codespace. If neither file exists, the default dev container configuration will be selected by default. +If `.devcontainer/devcontainer.json` or `.devcontainer.json` exists, it will be the default selection in the list of available configuration files when you create a codespace. Se nenhum dos dois arquivos existir, a configuração padrão do contêiner de desenvolvimento será selecionada por padrão. -![The default configuration choice selected](/assets/images/help/codespaces/configuration-file-choice-default.png) +![A configuração padrão selecionada](/assets/images/help/codespaces/configuration-file-choice-default.png) -### Editing the devcontainer.json file +### Editando o arquivo devcontainer.json -You can add and edit the supported configuration keys in the `devcontainer.json` file to specify aspects of the codespace's environment, like which {% data variables.product.prodname_vscode %} extensions will be installed. {% data reusables.codespaces.more-info-devcontainer %} +Você pode adicionar e editar as chaves de configuração compatíveis no arquivo `devcontainer.json` para especificar aspectos do ambiente do codespace como, por exemplo, quais extensões de {% data variables.product.prodname_vscode %} serão instaladas. {% data reusables.codespaces.more-info-devcontainer %} -The `devcontainer.json` file is written using the JSONC format. This allows you to include comments within the configuration file. For more information, see "[Editing JSON with Visual Studio Code](https://code.visualstudio.com/docs/languages/json#_json-with-comments)" in the {% data variables.product.prodname_vscode %} documentation. +The `devcontainer.json` file is written using the JSONC format. Isso permite que você inclua comentários no arquivo de configuração. For more information, see "[Editing JSON with Visual Studio Code](https://code.visualstudio.com/docs/languages/json#_json-with-comments)" in the {% data variables.product.prodname_vscode %} documentation. {% note %} -**Note**: If you use a linter to valid the `devcontainer.json` file, make sure it is set to JSONC and not JSON or comments will be reported as errors. +**Note**: If you use a linter to validate the `devcontainer.json` file, make sure it is set to JSONC and not JSON or comments will be reported as errors. {% endnote %} diff --git a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-a-minimum-specification-for-codespace-machines.md b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-a-minimum-specification-for-codespace-machines.md index 5e8aca532b..d25cf05913 100644 --- a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-a-minimum-specification-for-codespace-machines.md +++ b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-a-minimum-specification-for-codespace-machines.md @@ -15,9 +15,9 @@ product: '{% data reusables.gated-features.codespaces %}' ## Visão Geral -Each codespace that you create is hosted on a separate virtual machine, and you can usually choose from different types of virtual machines. Each machine type has different resources (CPUs, memory, storage) and, by default, the machine type with the least resources is used. Para obter mais informações, consulte "["Mudar o tipo de máquina para seu codespace](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace#about-machine-types)." +Cada codespace que você cria é hospedado em uma máquina virtual separada, e você geralmente pode escolher entre diferentes tipos de máquinas virtuais. Cada tipo de máquina tem recursos diferentes (CPUs, memória, armazenamento) e, por padrão, usa-se o tipo de máquina com menos recursos. Para obter mais informações, consulte "["Mudar o tipo de máquina para seu codespace](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace#about-machine-types)." -If your project needs a certain level of compute power, you can configure {% data variables.product.prodname_github_codespaces %} so that only machine types that meet these requirements can be used by default, or selected by users. You configure this in a `devcontainer.json` file. +Se o seu projeto precisar de um certo nível de poder de computação, você poderá configurar {% data variables.product.prodname_github_codespaces %} para que somente os tipos de máquina que atendam a esses requisitos possam ser usados por padrão ou selecionados pelos usuários. Você configura isso em um arquivo `devcontainer.json`. {% note %} @@ -27,7 +27,7 @@ If your project needs a certain level of compute power, you can configure {% dat ## Definindo uma especificação mínima de máquina -1. {% data variables.product.prodname_codespaces %} for your repository are configured in a `devcontainer.json` file. Se o seu repositório ainda não contiver um arquivo `devcontainer.json`, adicione um agora. See "[Add a dev container configuration to your repository](/free-pro-team@latest/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces)." +1. {% data variables.product.prodname_codespaces %} para o seu repositório está configurado em um arquivo `devcontainer.json`. Se o seu repositório ainda não contiver um arquivo `devcontainer.json`, adicione um agora. Consulte "[Adicionar uma configuração de contêiner de desenvolvimento ao seu repositório](/free-pro-team@latest/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces)". 1. Edite o arquivo `devcontainer.json`, adicionando a propriedade `hostRequirements` como esta: ```json{:copy} @@ -44,7 +44,7 @@ If your project needs a certain level of compute power, you can configure {% dat 1. Salve o arquivo e faça commit as alterações no branch necessário do repositório. - Now when you create a codespace for that branch of the repository, and you go to the creation configuration options, you will only be able to select machine types that match or exceed the resources you've specified. + Agora, ao criar um codespace para o branch desse repositório e acessar as opções de configuração, você só poderá selecionar os tipos de máquina que coincidem ou excedem os recursos especificados. ![Caixa de diálogo que mostra uma escolha limitada de tipos de máquina](/assets/images/help/codespaces/machine-types-limited-choice.png) diff --git a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md index efa4f250c1..2eb1aaf28f 100644 --- a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md +++ b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md @@ -26,7 +26,7 @@ Este guia mostra como configurar seu projeto C# (.NET) em {% data variables.prod ## Etapa 1: Abra o seu projeto em um codespace -1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on main**. +1. No nome do repositório, use o menu suspenso **Código de {% octicon "code" aria-label="The code icon" %}** e na guia **Codespaces**, clique em **Criar codespace no principal**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) @@ -36,9 +36,9 @@ Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. {% data reusables.codespaces.customize-vcpus-and-ram %} -## Step 2: Add a dev container configuration to your repository from a template +## Etapa 2: Adicionar uma configuração de contêiner de desenvolvimento ao repositório a partir de um modelo -The default development container, or "dev container," for {% data variables.product.prodname_github_codespaces %} comes with the latest .NET version and common tools preinstalled. However, we recommend that you configure your own dev container to include all of the tools and scripts that your project needs. Isso garantirá um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_github_codespaces %} do seu repositório. +O contêiner de desenvolvimento padrão, ou "contêiner de dev", para {% data variables.product.prodname_github_codespaces %} vem com a versão mais recente do .NET e ferramentas comuns pré-instaladas. No entanto, recomendamos que você configure seu próprio contêiner de desenvolvimento para incluir todas as ferramentas e scripts de que seu projeto precisa. Isso garantirá um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_github_codespaces %} do seu repositório. {% data reusables.codespaces.setup-custom-devcontainer %} @@ -120,15 +120,15 @@ O arquivo recém-adicionado `devcontainer.json` define algumas propriedades que - **nome** - Você pode dar qualquer nome ao nosso contêiner de desenvolvimento. Este é apenas o padrão. - **build** - As propriedades de compilação. - - **dockerfile** - In the `build` object, `dockerfile` contains the path to the Dockerfile that was also added from the template. + - **Arquivo Docker** - No objeto `construir`, `Arquivo Docker` contém o caminho para o arquivo Dockerfile que também foi adicionado a partir do modelo. - **args** - **variante**: Este arquivo contém apenas um argumento de compilação, que é a versão do .NET Core que queremos usar. - **configurações** - Estas são as configurações de {% data variables.product.prodname_vscode %}. - - **terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. + - **terminal.integrated.shell.linux** - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação. - **extensões** - Estas são extensões incluídas por padrão. - **ms-dotnettools.csharp** - A extensão Microsoft C# fornece amplo suporte para o desenvolvimento em C#, incluindo funcionalidades como IntelliSense, links, depuração, navegação de código, formatação de código, refatoração, explorador de variáveis, explorador de testes e muito mais. - **forwardPorts** - Todas as portas listadas aqui serão encaminhadas automaticamente. Para obter mais informações, consulte "[Encaminhando portas no seu codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)". -- **postCreateCommand** - Use this to run commands that aren't defined in the Dockerfile, after your codespace is created. +- **postCreateCommand** - Use isto para executar comandos que não estão definidos no arquivo Docker depois que seu codespace for criado. - **remoteUser** - Por padrão, você está executando como usuário do vscode, mas, opcionalmente, você pode definir isso como root. #### arquivo Docker @@ -161,7 +161,7 @@ Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner ## Etapa 3: Modifique seu arquivo devcontainer.json -With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando seu codespace for iniciado. +Com a configuração do contêiner de desenvolvimento adicionada e um entendimento básico do que tudo faz, agora você pode fazer alterações para personalizar ainda mais seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando seu codespace for iniciado. 1. No Explorer, selecione o arquivo `devcontainer.json` a partir da árvore para abri-lo. Você pode ter que expandir a pasta `.devcontainer` para vê-la. diff --git a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md index cf49fd78f9..9f5920c8aa 100644 --- a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md +++ b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md @@ -25,7 +25,7 @@ Este guia mostra como configurar seu projeto Java em {% data variables.product.p ## Etapa 1: Abra o seu projeto em um codespace -1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on main**. +1. No nome do repositório, use o menu suspenso **Código de {% octicon "code" aria-label="The code icon" %}** e na guia **Codespaces**, clique em **Criar codespace no principal**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) @@ -35,9 +35,9 @@ Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. {% data reusables.codespaces.customize-vcpus-and-ram %} -## Step 2: Add a dev container configuration to your repository from a template +## Etapa 2: Adicionar uma configuração de contêiner de desenvolvimento ao repositório a partir de um modelo -The default development container, or "dev container," for {% data variables.product.prodname_github_codespaces %} comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you configure your own dev container to include all of the tools and scripts that your project needs. Isso garantirá um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_github_codespaces %} do seu repositório. +O contêiner de desenvolvimento padrão, ou "contêiner de dev", para {% data variables.product.prodname_github_codespaces %}, vem com a versão mais recente do Java, gerenciadores de pacotes (Maven, Gradle) e outras ferramentas comuns pré-instaladas. No entanto, recomendamos que você configure seu próprio contêiner de desenvolvimento para incluir todas as ferramentas e scripts de que seu projeto precisa. Isso garantirá um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_github_codespaces %} do seu repositório. {% data reusables.codespaces.setup-custom-devcontainer %} @@ -48,7 +48,7 @@ The default development container, or "dev container," for {% data variables.pro ### Anatomia do seu contêiner de desenvolvimento -Adding the Java dev container template adds a `.devcontainer` directory to the root of your project's repository with the following files: +A adição do modelo de contêiner de desenvolvimento do Java adiciona um diretório `.devcontainer` à raiz do repositório do seu projeto com os seguintes arquivos: - `devcontainer.json` - arquivo Docker @@ -98,17 +98,17 @@ O arquivo recém-adicionado `devcontainer.json` define algumas propriedades que } ``` -- **name** - You can name your dev container anything, this is just the default. +- **nome** - Você pode dar qualquer nome ao seu contêiner de desenvolvimento. Este é apenas o padrão. - **build** - As propriedades de compilação. - - **dockerfile** - In the `build` object, `dockerfile` contains the path to the Dockerfile that was also added from the template. + - **Arquivo Docker** - No objeto `construir`, `Arquivo Docker` contém o caminho para o arquivo Dockerfile que também foi adicionado a partir do modelo. - **args** - - **variant**: This file only contains one build argument, which is the Java version that is passed into the Dockerfile. -- **settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. + - **variante**: Este arquivo contém apenas um argumento de compilação, que é a versão de Java que é passada para o arquivo Docker. +- **configurações** - Estas são configurações de {% data variables.product.prodname_vscode %} que você pode definir. + - **terminal.integrated.shell.linux** - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação. - **extensões** - Estas são extensões incluídas por padrão. - - **vscjava.vscode-java-pack** - The Java Extension Pack provides popular extensions for Java development to get you started. + - **vscjava.vscode-java-pack** - O pacote de extensão Java fornece extensões populares para o desenvolvimento do Java para você começar. - **forwardPorts** - Todas as portas listadas aqui serão encaminhadas automaticamente. Para obter mais informações, consulte "[Encaminhando portas no seu codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)". -- **postCreateCommand** - Use this to run commands that aren't defined in the Dockerfile, after your codespace is created. +- **postCreateCommand** - Use isto para executar comandos que não estão definidos no arquivo Docker depois que seu codespace for criado. - **remoteUser** - Por padrão, você está executando como usuário do `vscode`, mas, opcionalmente, você pode definir isso como `root`. #### arquivo Docker @@ -139,11 +139,11 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/shar # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 ``` -You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our container. +Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner para especificar os pacotes do OS, versões do Java ou pacotes globais que queremos que sejam incluídos no nosso contêiner. ## Etapa 3: Modifique seu arquivo devcontainer.json -With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando seu codespace for iniciado. +Com a configuração do contêiner de desenvolvimento adicionada e um entendimento básico do que tudo faz, agora você pode fazer alterações para personalizar ainda mais seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando seu codespace for iniciado. 1. No Explorer, selecione o arquivo `devcontainer.json` a partir da árvore para abri-lo. Você pode ter que expandir a pasta `.devcontainer` para vê-la. diff --git a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md index 94b2aa1557..0ac6665bfd 100644 --- a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md +++ b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md @@ -31,7 +31,7 @@ Este guia mostra como configurar seu projeto JavaScript, Node.js ou TypeScript e ## Etapa 1: Abra o seu projeto em um codespace -1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on main**. +1. No nome do repositório, use o menu suspenso **Código de {% octicon "code" aria-label="The code icon" %}** e na guia **Codespaces**, clique em **Criar codespace no principal**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) @@ -42,9 +42,9 @@ Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. {% data reusables.codespaces.customize-vcpus-and-ram %} -## Step 2: Add a dev container configuration to your repository from a template +## Etapa 2: Adicionar uma configuração de contêiner de desenvolvimento ao repositório a partir de um modelo -The default development container, or "dev container," for {% data variables.product.prodname_github_codespaces %} will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. However, we recommend that you configure your own dev container, as this allows you to define any particular tools and scripts your project needs. This will ensure a fully reproducible environment for all GitHub Codespaces users in your repository. +O contêiner de desenvolvimento padrão, ou "dev container", para {% data variables.product.prodname_github_codespaces %} é compatível com a execução de projetos do Node.js como [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) de forma inovadora. No entanto, recomendamos que você configure seu próprio contêiner de desenvolvimento, pois isso permite que você defina todas as ferramentas e scripts específicos de que seu projeto precisa. Isso irá garantir um ambiente reproduzível para todos os usuários do codespace do GitHub no seu repositório. {% data reusables.codespaces.setup-custom-devcontainer %} @@ -53,7 +53,7 @@ The default development container, or "dev container," for {% data variables.pro ![Selecione a opção Node na lista](/assets/images/help/codespaces/add-node-prebuilt-container.png) -1. Click the recommended version of Node.js. +1. Clique na versão recomendada do Node.js. ![Seleção de versão do Node.js](/assets/images/help/codespaces/add-node-version.png) @@ -61,7 +61,7 @@ The default development container, or "dev container," for {% data variables.pro ### Anatomia do seu contêiner de desenvolvimento -Adding the Node.js dev container template adds a `.devcontainer` directory to the root of your project's repository with the following files: +A adição do modelo de contêiner de desenvolvimento do Node.js adiciona um diretório `.devcontainer` à raiz do repositório do seu projeto com os seguintes arquivos: - `devcontainer.json` - arquivo Docker @@ -102,17 +102,17 @@ O arquivo recém-adicionado `devcontainer.json` define algumas propriedades que } ``` -- **name** - You can name your dev container anything, this is just the default. +- **nome** - Você pode dar qualquer nome ao seu contêiner de desenvolvimento. Este é apenas o padrão. - **build** - As propriedades de compilação. - - **dockerfile** - In the `build` object, `dockerfile` contains the path to the Dockerfile that was also added from the template. + - **Arquivo Docker** - No objeto `construir`, `Arquivo Docker` contém o caminho para o arquivo Dockerfile que também foi adicionado a partir do modelo. - **args** - - **variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. -- **settings** - These are {% data variables.product.prodname_vscode %} settings that you can set. - - **terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. + - **variante**: Este arquivo contém apenas um argumento de compilação, que é a variante de nó que queremos usar e que é passada para o arquivo Docker. +- **configurações** - Estas são configurações de {% data variables.product.prodname_vscode %} que você pode definir. + - **terminal.integrated.shell.linux** - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação. - **extensões** - Estas são extensões incluídas por padrão. - - **dbaeumer.vscode-eslint** - ES lint is a great extension for linting, but for JavaScript there are a number of great Marketplace extensions you could also include. + - <**dbaeumer.vscode-eslint** - ES lint é uma ótima extensão para linting, mas para o JavaScript, há uma série de ótimas extensões do Marketplace que você também pode incluir. - **forwardPorts** - Todas as portas listadas aqui serão encaminhadas automaticamente. Para obter mais informações, consulte "[Encaminhando portas no seu codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)". -- **postCreateCommand** - Use this to run commands that aren't defined in the Dockerfile, after your codespace is created. +- **postCreateCommand** - Use isto para executar comandos que não estão definidos no arquivo Docker depois que seu codespace for criado. - **remoteUser** - Por padrão, você está executando como usuário do vscode, mas, opcionalmente, você pode definir isso como root. #### arquivo Docker @@ -138,7 +138,7 @@ Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner ## Etapa 3: Modifique seu arquivo devcontainer.json -With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. Neste exemplo, você irá adicionar propriedades para instalar o npm quando seu codespace for lançado e para fazer uma lista de portas dentro do contêiner disponível localmente. +Com a configuração do contêiner de desenvolvimento adicionada e um entendimento básico do que tudo faz, agora você pode fazer alterações para personalizar ainda mais seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar o npm quando seu codespace for lançado e para fazer uma lista de portas dentro do contêiner disponível localmente. 1. No Explorer, selecione o arquivo `devcontainer.json` a partir da árvore para abri-lo. Você pode ter que expandir a pasta `.devcontainer` para vê-la. diff --git a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md index 8a8161b2e3..e1e3339513 100644 --- a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md +++ b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md @@ -28,7 +28,7 @@ Este guia mostra como configurar seu projeto Python em {% data variables.product ## Etapa 1: Abra o seu projeto em um codespace -1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on main**. +1. No nome do repositório, use o menu suspenso **Código de {% octicon "code" aria-label="The code icon" %}** e na guia **Codespaces**, clique em **Criar codespace no principal**. ![Botão de codespace novo](/assets/images/help/codespaces/new-codespace-button.png) @@ -38,9 +38,9 @@ Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. {% data reusables.codespaces.customize-vcpus-and-ram %} -## Step 2: Add a dev container configuration to your repository from a template +## Etapa 2: Adicionar uma configuração de contêiner de desenvolvimento ao repositório a partir de um modelo -The default development container, or "dev container," for {% data variables.product.prodname_github_codespaces %} comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you configure your own dev container to include all of the tools and scripts that your project needs. Isso garantirá um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_github_codespaces %} do seu repositório. +O contêiner de desenvolvimento padrão ou "contêiner dev" para {% data variables.product.prodname_github_codespaces %} vem com a versão mais recente do Python, gerentes de pacotes (pip, Miniconda) e outras ferramentas comuns pré-instaladas. No entanto, recomendamos que você configure seu próprio contêiner de desenvolvimento para incluir todas as ferramentas e scripts de que seu projeto precisa. Isso garantirá um ambiente reprodutível para todos os usuários de {% data variables.product.prodname_github_codespaces %} do seu repositório. {% data reusables.codespaces.setup-custom-devcontainer %} @@ -52,7 +52,7 @@ The default development container, or "dev container," for {% data variables.pro ### Anatomia do seu contêiner de desenvolvimento -Adding the Python dev container template adds a `.devcontainer` directory to the root of your project's repository with the following files: +A adição do modelo de contêiner de desenvolvimento do Node.js adiciona uma diretório `.devcontainer` à raiz do repositório do seu projeto com os seguintes arquivos: - `devcontainer.json` - arquivo Docker @@ -111,15 +111,15 @@ O arquivo recém-adicionado `devcontainer.json` define algumas propriedades que - **nome** - Você pode dar qualquer nome ao nosso contêiner de desenvolvimento. Este é apenas o padrão. - **build** - As propriedades de compilação. - - **dockerfile** - In the `build` object, `dockerfile` contains the path to the Dockerfile that was also added from the template. + - **Arquivo Docker** - No objeto `construir`, `Arquivo Docker` contém o caminho para o arquivo Dockerfile que também foi adicionado a partir do modelo. - **args** - - **variant**: This file only contains one build argument, which is the node variant we want to use that is passed into the Dockerfile. + - **variante**: Este arquivo contém apenas um argumento de compilação, que é a variante de nó que queremos usar e que é passada para o arquivo Docker. - **configurações** - Estas são as configurações de {% data variables.product.prodname_vscode %}. - - **terminal.integrated.shell.linux** - While bash is the default here, you could use other terminal shells by modifying this. + - **terminal.integrated.shell.linux** - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação. - **extensões** - Estas são extensões incluídas por padrão. - **ms-python. ython** - A extensão Microsoft Python fornece um amplo suporte para a linguagem do Python (para todas as versões ativamente compatíveis da linguagem: >=3.), incluindo recursos como IntelliSense, linting, depuração, navegação de código, formatação de código, refatoração, explorador de variáveis, explorador de teste e muito mais. - **forwardPorts** - Todas as portas listadas aqui serão encaminhadas automaticamente. Para obter mais informações, consulte "[Encaminhando portas no seu codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)". -- **postCreateCommand** - Use this to run commands that aren't defined in the Dockerfile, like `pip3 install -r requirements`, after your codespace is created. +- **postCreateCommand** - Use isto para executar comandos que não estão definidos no arquivo Docker como `pip3 install -r requirements`, depois que seu codespace for criado. - **remoteUser** - Por padrão, você está executando como usuário do `vscode`, mas, opcionalmente, você pode definir isso como `root`. #### arquivo Docker @@ -151,7 +151,7 @@ Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner ## Etapa 3: Modifique seu arquivo devcontainer.json -With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando seu codespace for iniciado. +Com a configuração do contêiner de desenvolvimento adicionada e um entendimento básico do que tudo faz, agora você pode fazer alterações para personalizar ainda mais seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando seu codespace for iniciado. 1. No Explorador, expanda a pasta `.devcontainer` e selecione o arquivo `devcontainer.json` a partir da árvore para abri-lo. diff --git a/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index 34cccc0a77..905757512d 100644 --- a/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -32,7 +32,7 @@ Se você ainda não puder criar um codespace para um repositório em que {% data O proprietário de um codespace tem controle total sobre ele e apenas o proprietário pode excluir seus codespaces. Você não pode excluir um codespace criado por outro usuário. -You can delete your codespaces in the browser, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. {% data variables.product.prodname_cli %} also allows you to bulk delete codespaces. Para obter mais informações, consulte "[Excluindo um codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)". +Você pode excluir seus codespaces do navegador, em {% data variables.product.prodname_vscode %}, ou usando {% data variables.product.prodname_cli %}. {% data variables.product.prodname_cli %} também permite que você exclua codespaces em massa. Para obter mais informações, consulte "[Excluindo um codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)". ## Armazenamento do contêiner @@ -56,4 +56,4 @@ Algumas opções mais destrutivas: Este codespace está em execução em modo de recuperação devido a um erro no contêiner. ``` -Review the creation logs, update the dev container configuration as needed, and run **Codespaces: Rebuild Container** in the {% data variables.product.prodname_vscode_command_palette %} to retry. Para obter mais informações, consulte " [Programas registra](/codespaces/troubleshooting/codespaces-logs)" e "[Configurando {% data variables.product.prodname_codespaces %} para o seu projeto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)". +Revise os registros de criação, atualize a configuração do contêiner de desenvolvimento conforme necessário e execute **Codespaces: Recriar contêiner** no {% data variables.product.prodname_vscode_command_palette %} para tentar novamente. Para obter mais informações, consulte " [Programas registra](/codespaces/troubleshooting/codespaces-logs)" e "[Configurando {% data variables.product.prodname_codespaces %} para o seu projeto](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)". diff --git a/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index f90c97c0f0..fefe32cc37 100644 --- a/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -18,13 +18,13 @@ Para obter mais informações sobre as pré-compilações de {% data variables.p ## Verificando se um código foi criado a partir de uma pré-compilação? -When you create a codespace, you can choose the type of the virtual machine you want to use. If a prebuild is available for the type of virtual machine, "{% octicon "zap" aria-label="The zap icon" %} Prebuild ready" is shown next to it. +Ao criar um codespace, você pode escolher o tipo de máquina virtual que deseja usar. Se uma pré-criação estiver disponível para o tipo de máquina virtual, "Pré-criação pronta para{% octicon "zap" aria-label="The zap icon" %}" será exibida ao lado. -![A list of available machine types](/assets/images/help/codespaces/choose-custom-machine-type.png) +![Uma lista dos tipos de máquina disponíveis](/assets/images/help/codespaces/choose-custom-machine-type.png) Se você tiver sua preferência de editor de {% data variables.product.prodname_codespaces %} definida como "Visual Studio Code para Web", a página "Configurando seu codespace" mostrará a mensagem "Prebuilt codespace found" se uma pré-compilação estiver sendo utilizada. -![The 'prebuilt codespace found' message](/assets/images/help/codespaces/prebuilt-codespace-found.png) +![A mensagem "codespaces da pre-criação encontrados"](/assets/images/help/codespaces/prebuilt-codespace-found.png) Da mesma forma, se sua preferência de editor for "Visual Studio Code", o terminal integrado conterá a mensagem "Você está em um codespace pré-compilado efinido pela configuração de pré-compilação do seu repositório" ao criar um novo codespace. Para obter mais informações, consulte "[Definindo seu editor padrão para codespaces](/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces)". @@ -46,16 +46,16 @@ cat /workspaces/.codespaces/shared/environment-variables.json | jq '.ACTION_NAME Você pode notar que, às vezes, quando você cria um novo codespace a partir de um branch habilitado por uma pré-compilaçã, a etiqueta "Pré-compilação de {% octicon "zap" aria-label="The zap icon" %} pronta" não é exibida na caixa de diálogo para escolher um tipo de máquina. Isto significa que pré-compilações não estão disponíveis no momento. -By default, each time you push to a prebuild-enabled branch, the prebuild template is updated. If the push involves a change to the dev container configuration then, while the update is in progress, the "{% octicon "zap" aria-label="The zap icon" %} Prebuild Ready" label is removed from the list of machine types. Neste tempo, você ainda pode criar codespaces sem um modelo de pré-compilação. If required, you can reduce the occasions on which prebuilds are unavailable for a repository by setting the prebuild template to be updated only when you make a change to your dev container configuration files, or only on a custom schedule. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." +Por padrão, a cada vez que você fizer push para um branch habilitado por uma pré-criação, o template de pré-criação será atualizado. Se o push envolver uma alteração na configuração do contêiner de desenvolvimento, enquanto a atualização estiver em andamento, a etiqueta "Pré-criação pronta de {% octicon "zap" aria-label="The zap icon" %} será removida da lista de tipos de máquina. Neste tempo, você ainda pode criar codespaces sem um modelo de pré-compilação. Se necessário, você pode reduzir as ocasiões em que as pré-criações não estão disponíveis para um repositório, definindo o template de pré-criação para ser atualizado somente quando você fizer uma alteração nos arquivos de configuração do contêiner de desenvolvimento ou apenas em um agendamento personalizado. Para obter mais informações, consulte "[Configurando pré-criações](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)". -Se seu branch não estiver especificamente habilitado para pré-compilações, ele ainda poderá se beneficiar de pré-compilações se ele foi criado a partir de um branch habilitado por pré-compilação. However, if the dev container configuration is changed on your branch, so that it's not the same as the configuration on the base branch, prebuilds will no longer be available on your branch. +Se seu branch não estiver especificamente habilitado para pré-compilações, ele ainda poderá se beneficiar de pré-compilações se ele foi criado a partir de um branch habilitado por pré-compilação. No entanto, se a configuração do contêiner de desenvolvimento for alterada no seu branch, para que não seja igual à configuração no branch de base, as pré-criações não estarão mais disponíveis no seu branch. Essas são as coisas a serem verificadas se a etiqueta " Pré-compilação de {% octicon "zap" aria-label="The zap icon" %} pronta" não for exibido para um determinado branch: * Confirme que existe uma configuração de pré-compilação para este branch. Se você não for administrador do repositório, entre em contato com um para confirmar. * Confirme que a configuração de pré-compilação inclui sua região. -* Verifique se uma alteração para a configuração do contêiner de desenvolvimento foi enviada por push para o branch habilitado pela pré-compilação recentemente. If so, you will typically have to wait until the prebuild workflow run for this push completes before prebuilds are available again. -* Se nenhuma alteração de configuração foi realizada recentemente, acesse a aba **Ações** do seu repositório, clique em **{% octicon "codespaces" aria-label="The Codespaces icon" %} Pré-compilações de {% data variables.product.prodname_codespaces %}** na lista de fluxos de trabalho e verifique se as execuções do fluxo de trabalho de pré-compilação são sendo bem-sucedidas. If latest runs of a workflow failed, and one or more of these failed runs contained changes to the dev container configuration, then there will be no available prebuilds for the associated branch. +* Verifique se uma alteração para a configuração do contêiner de desenvolvimento foi enviada por push para o branch habilitado pela pré-compilação recentemente. Se for dessa forma, normalmente você terá que esperar até que o fluxo de trabalho de pré-criação, aguarde até que a execução do fluxo de trabalho de pré-compilação seja concluída antes que as pré-criações estejam disponíveis novamente. +* Se nenhuma alteração de configuração foi realizada recentemente, acesse a aba **Ações** do seu repositório, clique em **{% octicon "codespaces" aria-label="The Codespaces icon" %} Pré-compilações de {% data variables.product.prodname_codespaces %}** na lista de fluxos de trabalho e verifique se as execuções do fluxo de trabalho de pré-compilação são sendo bem-sucedidas. Se as últimas execuções de um fluxo de trabalho falharem e uma ou mais dessas execuções falharam continham alterações na configuração do contêiner de desenvolvimento, não haverá pré-compilações disponíveis para o branch associado. ## Leia mais diff --git a/translations/pt-BR/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/translations/pt-BR/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index 25b1856f25..f490b5bfd9 100644 --- a/translations/pt-BR/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/translations/pt-BR/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -83,7 +83,7 @@ Você pode selecionar permissões em uma string de consultas usando o nome da pe | `plano` | Concede acesso para obter informações sobre o plano de um usuário do GitHub que usa o ponto final "[Obter um usuário](/rest/reference/users#get-a-user)". Pode ser: `nenhum` ou `leitura`. | | [`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Concede acesso a vários pontos finais do pull request. Pode ser: `nenhum`, `leitura` ou `gravação`. | | [`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Concede acesso à [API de webhooks do repositório](/rest/reference/repos#hooks). Pode ser: `nenhum`, `leitura` ou `gravação`. | -| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Concede acesso à [API de Projetos](/rest/reference/projects). Pode ser: `nenhum`, `leitura`, `gravação` ou `administrador`.{% ifversion fpt or ghes or ghec %} +| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Concede acesso à [API de Projetos](/rest/reference/projects). Pode ser: `nenhum`, `leitura`, `gravação` ou `administrador`.{% ifversion ghes or ghec %} | [`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | Concede acesso à [API de varredura de segredo](/rest/reference/secret-scanning). Pode ser: `none`, `read` ou `write`.{% endif %}{% ifversion fpt or ghes or ghec %} | [`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | Concede acesso à [API de varredura de código](/rest/reference/code-scanning/). Pode ser: `nenhum`, `leitura` ou `gravação`.{% endif %} | [`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | Concede acesso à [API de conteúdo](/rest/reference/repos#contents). Pode ser: `nenhum`, `leitura` ou `gravação`. | @@ -123,6 +123,7 @@ Você pode selecionar permissões em uma string de consultas usando o nome da pe | [`pull_request`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %} | [`pull_request_review`](/webhooks/event-payloads/#pull_request_review) | `pull_request` | {% data reusables.webhooks.pull_request_review_short_desc %} | [`pull_request_review_comment`](/webhooks/event-payloads/#pull_request_review_comment) | `pull_request` | {% data reusables.webhooks.pull_request_review_comment_short_desc %} +| [`pull_request_review_thread`](/webhooks/event-payloads/#pull_request_review_thread) | `pull_request` | {% data reusables.webhooks.pull_request_review_thread_short_desc %} | [`push`](/webhooks/event-payloads/#push) | `Conteúdo` | {% data reusables.webhooks.push_short_desc %} | [`versão`](/webhooks/event-payloads/#release) | `Conteúdo` | {% data reusables.webhooks.release_short_desc %} | [`repositório`](/webhooks/event-payloads/#repository) | `metadados` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %} diff --git a/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index f5f7b62886..291beb59ce 100644 --- a/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/pt-BR/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -48,7 +48,7 @@ X-Accepted-OAuth-Scopes: user |  `repo_deployment` | Concede acesso aos [status da implementação](/rest/reference/repos#deployments) para {% ifversion not ghae %}público{% else %}interno{% endif %} e repositórios privados. Este escopo só é necessário para conceder a outros usuários ou serviços acesso aos status de implantação, *sem* conceder acesso ao código.{% ifversion not ghae %} |  `public_repo` | Limita o acesso a repositórios públicos. Isso inclui acesso de leitura/gravação em código, status de commit, projetos de repositório, colaboradores e status de implantação de repositórios e organizações públicos. Também é necessário para repositórios públicos marcados como favoritos.{% endif %} |  `repo:invite` | Concede habilidades de aceitar/recusar convites para colaborar em um repositório. Este escopo só é necessário para conceder a outros usuários ou serviços acesso a convites *sem* conceder acesso ao código.{% ifversion fpt or ghes or ghec %} -|  `security_events` | Concede:
    Acesso de leitura e escrita a eventos de segurança na [API de {% data variables.product.prodname_code_scanning %}](/rest/reference/code-scanning)
    acesso de leitura e escrita a eventos de segurança na [API de {% data variables.product.prodname_secret_scanning %}](/rest/reference/secret-scanning)
    Este escopo só é necessário para conceder acesso de outros usuários ou serviços a eventos de segurança *sem* conceder acesso ao código.{% endif %} +|  `security_events` | Grants:
    read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) {%- ifversion ghec %}
    read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning){%- endif %}
    This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} | **`admin:repo_hook`** | Concede acesso de leitura, gravação, fixação e exclusão aos hooks do repositório em {% ifversion fpt %}repositórios públicos, privados ou internos{% elsif ghec or ghes %}públicos, ou internos{% elsif ghae %}privados ou internos{% endif %}. O escopos do `repo` {% ifversion fpt or ghec or ghes %}e `public_repo` concedem{% else %}o escopo concede{% endif %} o acesso total aos repositórios, incluindo hooks de repositório. Use o escopo `admin:repo_hook` para limitar o acesso apenas a hooks de repositório. | |  `write:repo_hook` | Concede acesso de leitura, gravação e fixação aos hooks em {% ifversion fpt %}repositórios públicos ou privados{% elsif ghec or ghes %}público, privado ou interno{% elsif ghae %}privado ou interno{% endif %}. | |  `read:repo_hook` | Concede acesso de leitura e fixação aos hooks em {% ifversion fpt %}repositórios públicos ou privados{% elsif ghec or ghes %}público, privado ou interno{% elsif ghae %}privado ou interno{% endif %}. | diff --git a/translations/pt-BR/content/developers/webhooks-and-events/events/github-event-types.md b/translations/pt-BR/content/developers/webhooks-and-events/events/github-event-types.md index 5b7c3e3f4b..709a188ad9 100644 --- a/translations/pt-BR/content/developers/webhooks-and-events/events/github-event-types.md +++ b/translations/pt-BR/content/developers/webhooks-and-events/events/github-event-types.md @@ -208,6 +208,16 @@ Este evento retorna um objeto de `carga` vazio. {% data reusables.webhooks.pull_request_review_comment_event_api_properties %} {% data reusables.webhooks.pull_request_review_comment_properties %} +## PullRequestReviewThreadEvent + +{% data reusables.webhooks.pull_request_review_thread_short_desc %} + +{% data reusables.webhooks.events_api_payload %} + +### Objeto da `carga` do evento + +{% data reusables.webhooks.pull_request_thread_properties %} + ## PushEvent {% data reusables.webhooks.push_short_desc %} diff --git a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 2f35e99640..485ef771eb 100644 --- a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1062,6 +1062,28 @@ As entregas para eventos `review_requested` e `review_request_removed` terão um {{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }} +## pull_request_review_thread + +{% data reusables.webhooks.pull_request_review_thread_short_desc %} + +### Disponibilidade + +- Webhooks do repositório +- Webhooks da organização +- {% data variables.product.prodname_github_apps %} com a permissão `pull_requests` + +### Objeto da carga do webhook + +{% data reusables.webhooks.pull_request_thread_properties %} +{% data reusables.webhooks.repo_desc %} +{% data reusables.webhooks.org_desc %} +{% data reusables.webhooks.app_desc %} +{% data reusables.webhooks.sender_desc %} + +### Exemplo de carga de webhook + +{{ webhookPayloadsForCurrentVersion.pull_request_review_thread.resolved }} + ## push {% data reusables.webhooks.push_short_desc %} @@ -1163,7 +1185,7 @@ Este evento ocorre quando um {% data variables.product.prodname_github_app %} en | Tecla | Tipo | Descrição | | ------ | -------- | ---------------------------------------------------------------------------------- | -| `Ação` | `string` | A ação que foi executada. Este pode ser um dos seguintes:
    • `created` - Um repositório foi criado.
    • `deleted` - Um repositório foi excluído.
    • `archived` - Um repositório está arquivado.
    • `unarchived` - Um repositório não está arquivado.
      • {% ifversion ghes or ghae %}
    • `anonymous_access_enabled` - Um repositório está [habilitado para acesso anônimo ao Git](/rest/overview/api-previews#anonymous-git-access-to-repositories), `anonymous_access_disabled` - Um repositório está [desativado para acesso anônimo ao Git](/rest/overview/api-previews#anonymous-git-access-to-repositories)
      • {% endif %}
    • `edited` - As informações de um repositório são editadas.
    • `renamed` - Um repositório é renomeado.
    • `transferred` - Um repositório é transferido.
    • `publicized` - Um repositório é publicado.
    • `privatizado` - Um repositório é privatizado.
    | +| `Ação` | `string` | A ação que foi executada. Este pode ser um dos seguintes:
    • `created` - Um repositório foi criado.
    • `deleted` - Um repositório foi excluído.
    • `archived` - Um repositório está arquivado.
    • `unarchived` - Um repositório não está arquivado.
      • {% ifversion ghes or ghae %}
    • `anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
      • {% endif %}
    • `edited` - As informações de um repositório são editadas.
    • `renamed` - Um repositório é renomeado.
    • `transferred` - Um repositório é transferido.
    • `publicized` - Um repositório é publicado.
    • `privatizado` - Um repositório é privatizado.
    | {% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.org_desc %} {% data reusables.webhooks.app_desc %} @@ -1216,7 +1238,7 @@ Este evento ocorre quando um {% data variables.product.prodname_github_app %} en {% endif %} -{% ifversion fpt or ghes or ghec %} +{% ifversion ghes or ghec %} ## secret_scanning_alert @@ -1241,7 +1263,7 @@ Este evento ocorre quando um {% data variables.product.prodname_github_app %} en {{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }} {% endif %} -{% ifversion fpt or ghes > 3.4 or ghec or ghae-issue-6581 %} +{% ifversion ghes > 3.4 or ghec or ghae-issue-6581 %} ## secret_scanning_alert_location {% data reusables.webhooks.secret_scanning_alert_location_event_short_desc %} diff --git a/translations/pt-BR/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md b/translations/pt-BR/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md index 8335e6f8ce..e6831e32ff 100644 --- a/translations/pt-BR/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md +++ b/translations/pt-BR/content/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile.md @@ -1,6 +1,6 @@ --- title: Personalizando o perfil da sua organização -intro: Você pode compartilhar informações sobre sua organização personalizando o perfil da sua organização +intro: Você pode compartilhar informações sobre sua organização personalizando o perfil da sua organização. versions: fpt: '*' ghec: '*' @@ -11,19 +11,69 @@ topics: shortTitle: Personalizar perfil da organização --- -## Sobre o README do perfil da sua organização +{% if org-profile-pin-private %} -Você pode compartilhar informações sobre como interagir com a sua organização criando um README do perfil da organização. {% data variables.product.prodname_dotcom %} mostra o README do perfil da sua organização na aba "Visão geral" da sua organização. +## About your organization's profile page -Você pode escolher quais informações incluir no perfil da sua organização. Aqui estão alguns exemplos de informações que podem ser úteis no perfil da sua organização. +You can customize your organization's Overview page to show content dedicated to public users or members of the organization. Members of your organization who are signed into {% data variables.product.prodname_dotcom %}, are shown a member view when they visit your organization's profile page. Users who are not members of your organization will be shown a public view. + +![Image of an organization profile page](/assets/images/help/organizations/new_organization_page.png) +{% endif %} + +### Repositórios fixos + +You can give users easy access to important or frequently used repositories, by choosing up to six repositories for public users and six repositories for members of the organization. Once you pin repositories to your organization profile, the "Pinned" section is shown above the "Repositories" section of the profile page. + +Only organization owners can pin repositories. For more information, see "[Pinning repositories to your organization's profile](#pinning-repositories-to-your-organizations-profile)." + +### Organization profile READMEs + +You can share information about how to engage with your organization by creating an organization profile README for both public users and members of the organization. {% data variables.product.prodname_dotcom %} mostra o README do perfil da sua organização na aba "Visão geral" da sua organização. + +You can choose what information to include in your organization profile README. Here are some examples of information that may be helpful. - Uma seção "Sobre" que descreve sua organização - Orientação para obter ajuda na organização Você pode formatar o texto e incluir emoji, imagens e GIFs no README do perfil da sua organização usando o Markdown enriquecido de {% data variables.product.company_short %}. Para obter mais informações, consulte "[Começando a escrever e formatar no {% data variables.product.prodname_dotcom %}](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)". -## Adicionando um README de perfil da organização +## Adding a public organization profile README 1. Se sua organização ainda não tiver um repositório público de `.github`, crie um repositório público de `.github`. 2. No repositório `.github` da sua organização, crie um arquivo `README.md` na pasta `perfil`. -3. Faça o commit das alterações para o arquivo `README.md`. O conteúdo do `README.md` será exibido no perfil da sua organização. +3. Faça o commit das alterações para o arquivo `README.md`. The content of the `README.md` will appear on your organization's public profile. + + ![Image of an organization's public README](/assets/images/help/organizations/org_public_readme.png) + +{% if org-profile-pin-private %} + +## Adding a member-only organization profile README + +1. If your organization does not already have a `.github-private` repository, create a public `.github-private` repository. This action can be performed by any user that has write access to that repository. +2. In your organization's `.github-private` repository, create a `README.md` file in the `profile` folder. +3. Faça o commit das alterações para o arquivo `README.md`. The content of the `README.md` will be displayed in the member view of your organization's profile. + + ![Image of an organization's private README](/assets/images/help/organizations/org_member_readme.png) + +## Pinning repositories to your organization's profile + +You can pin repositories that you want to feature, such as those that are frequently used, to your organization's profile page. To choose which repositories to pin to your organization's profile, you must be an organization owner or administrator. + +1. Navigate to your organization's profile page. +2. In the right sidebar of the page in the {% octicon "eye" aria-label="The eye octicon" %} "View as" link, choose the **Public** or **Member** profile view from the dropdown menu. + + ![Image of the organization profile view dropdown](/assets/images/help/organizations/org_profile_view.png) + +3. In the pinned repositories section, select **Customize pins**. + + ![Image of the customize pins link](/assets/images/help/organizations/customize_pins_link.png) + + - If you haven't yet pinned any repositories to your organization's profile, you'll need to instead click **pin repositories** in the right sidebar of the profile page. ![Image of pin repositories link in right sidebar](/assets/images/help/organizations/pin_repositories_link.png) + +4. In the "Edit pinned repositories" dialog box, select a combination of up to six public, {% ifversion not fpt %}private, or internal{% else %}or private{% endif %} repositories to display. + + ![Image of pinned repo dialog](/assets/images/help/organizations/pinned_repo_dialog.png) + +5. Clique em **Save pins** (Salvar itens fixos). + +{% endif %} diff --git a/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md b/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md index 2456e5f11d..fbe05d7dd3 100644 --- a/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md +++ b/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md @@ -1,7 +1,6 @@ --- title: Restringir notificações de e-mail para sua organização intro: 'Para evitar que as informações da organização sejam divulgadas para contas pessoais de e-mail, você pode restringir domínios em que os integrantes podem receber notificações de e-mail sobre a atividade da organização.' -product: '{% data reusables.gated-features.restrict-email-domain %}' permissions: Organization owners can restrict email notifications for an organization. redirect_from: - /articles/restricting-email-notifications-about-organization-activity-to-an-approved-email-domain @@ -10,7 +9,6 @@ redirect_from: - /organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain - /organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization versions: - fpt: '*' ghes: '>=3.2' ghec: '*' type: how_to @@ -26,11 +24,7 @@ shortTitle: Restringir notificações de e-mail Quando as notificações de e-mail restritas são habilitadas em uma organização, os integrantes só podem usar um endereço de e-mail associado a um domínio verificado ou aprovado para receber as notificações de e-mail sobre a atividade da organização. Para obter mais informações, consulte "[Verificar ou aprovar um domínio para a sua organização](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)". -{% data reusables.enterprise-accounts.approved-domains-beta-note %} - -{% data reusables.notifications.email-restrictions-verification %} - -{% ifversion fpt or ghec %} +{% ifversion ghec %} {% note %} **Observação:** Para restringir notificações por e-mail, a sua organização deve usar {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} @@ -38,6 +32,8 @@ Quando as notificações de e-mail restritas são habilitadas em uma organizaç {% endnote %} {% endif %} +{% data reusables.notifications.email-restrictions-verification %} + Os colaboradores externos não estão sujeitos às restrições de notificações por e-mail para domínios verificados ou aprovados. Para obter mais informações sobre colaboradores externos, consulte "[Funções em uma organização](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)". Se sua organização pertence a uma conta corporativa os integrantes da organização poderão receber notificações de qualquer domínio verificado ou aprovado para a conta corporativa, Além de quaisquer domínios verificados ou aprovados para a organização. Para obter mais informações, consulte "[Verificando ou aprovando um domínio para sua empresa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)". diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md index 237eee15bc..7ed345796b 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md @@ -1,7 +1,6 @@ --- title: Verificando ou aprovando um domínio para sua organização intro: 'Você pode verificar a propriedade de domínios com {% data variables.product.company_short %} para confirmar a identidade da sua organização. Você também pode aprovar domínios para os quais {% data variables.product.company_short %} pode enviar notificações de email para os integrantes da sua organização.' -product: '{% data reusables.gated-features.verify-and-approve-domain %}' redirect_from: - /articles/verifying-your-organization-s-domain - /articles/verifying-your-organizations-domain @@ -9,7 +8,6 @@ redirect_from: - /organizations/managing-organization-settings/verifying-your-organizations-domain permissions: Organization owners can verify or approve a domain for an organization. versions: - fpt: '*' ghes: '>=3.2' ghec: '*' type: how_to @@ -23,15 +21,25 @@ shortTitle: Verificar ou aprovar um domínio ## Sobre a verificação do domínio -Após a verificação da propriedade dos domínios da sua organização, é exibido um selo "Verified" (Verificado) no perfil da organização. {% ifversion fpt or ghec %} Se a sua organização estiver no {% data variables.product.prodname_ghe_cloud %} e tiver concordado com os Termos de serviço corporativos, os proprietários da organização poderão verificar a identidade dos seus integrantes exibindo o endereço de e-mail de cada um deles no domínio verificado. Para obter mais informações, consulte "[Sobre a página de perfil da sua organização](/articles/about-your-organization-s-profile/)" e "Atualizar para os Termos de serviço corporativos".{% endif %} +Após a verificação da propriedade dos domínios da sua organização, é exibido um selo "Verified" (Verificado) no perfil da organização. {% ifversion ghec %}If your organization has agreed to the Corporate Terms of Service, organization owners will be able to verify the identity of organization members by viewing each member's email address within the verified domain. Para obter mais informações, consulte "[Sobre a página de perfil da sua organização](/articles/about-your-organization-s-profile/)" e "Atualizar para os Termos de serviço corporativos".{% endif %} -{% ifversion fpt or ghec %}Se sua organização pertencer a uma conta corporativa um selo "Verificado" de{% elsif ghes %}A{% endif %} será exibido no perfil da sua organização para todos os domínios verificados para a conta corporativa, além de todos os domínios verificados para a organização. Os proprietários da organização podem ver quaisquer domínios que um proprietário da empresa verificou ou aprovou e pode editar os domínios se o proprietário da organização também for um proprietário corporativo. {% ifversion fpt or ghec %}Para obter mais informações, consulte "[Verificar ou aprovar um domínio para a sua empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise).{% endif %}{% ifversion ghes > 3.1 %}Para obter mais informações, consulte[Verificando ou aprovando um domínio para sua empresa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)".{% endif %} +{% ifversion ghec %}Se sua organização pertencer a uma conta corporativa um selo "Verificado" de{% elsif ghes %}A{% endif %} será exibido no perfil da sua organização para todos os domínios verificados para a conta corporativa, além de todos os domínios verificados para a organização. Os proprietários da organização podem ver quaisquer domínios que um proprietário da empresa verificou ou aprovou e pode editar os domínios se o proprietário da organização também for um proprietário corporativo. Para obter mais informações, consulte "[Verificando ou aprovando um domínio para sua empresa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)". + +{% ifversion ghec %} +{% note %} + +**Note:** To verify or approve domains, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} + +{% endnote %} +{% endif %} {% data reusables.organizations.verified-domains-details %} -{% ifversion fpt or ghec %}Em {% data variables.product.prodname_ghe_cloud %}, depois de verificar a propriedade do domínio da sua organização, você pode restringir notificações de e-mail para a organização para esse domínio. Para obter mais informações, consulte "[Restringir notificações de e-mail para sua organização](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)". {% ifversion fpt %}{% data reusables.enterprise.link-to-ghec-trial %}{% endif %}{% endif %} +{% ifversion ghec or ghes > 3.1 %} +After verifying ownership of your organization's domain, you can restrict email notifications for the organization to that domain. Para obter mais informações, consulte "[Restringir notificações de e-mail para sua organização](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)". +{% endif %} -{% ifversion fpt or ghec %}Você também pode verificar domínios personalizados usados para {% data variables.product.prodname_pages %} para evitar ofertas públicas de domínio quando um domínio personalizado permanece configurado, mas seu site de {% data variables.product.prodname_pages %} está desabilitado ou não usa mais o domínio. Para obter mais informações, consulte "[Verificando o seu domínio personalizado para {% data variables.product.prodname_pages %}](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)."{% endif %} +{% ifversion ghec %}Você também pode verificar domínios personalizados usados para {% data variables.product.prodname_pages %} para evitar ofertas públicas de domínio quando um domínio personalizado permanece configurado, mas seu site de {% data variables.product.prodname_pages %} está desabilitado ou não usa mais o domínio. Para obter mais informações, consulte "[Verificando o seu domínio personalizado para {% data variables.product.prodname_pages %}](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)."{% endif %} ## Sobre a aprovação de domínio @@ -43,7 +51,7 @@ Após aprovar domínios para a sua organização, você pode restringir notifica Os proprietários de empresas não podem ver quais integrantes da organização ou endereços de e-mail recebem notificações dentro dos domínios aprovados. -Os proprietários de empresas também podem aprovar domínios adicionais para organizações pertencentes à empresa. {% ifversion fpt or ghec %}Para obter mais informações, consulte "[Verificar ou aprovar um domínio para a sua empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise).{% endif %}{% ifversion ghes > 3.1 %}Para obter mais informações, consulte[Verificando ou aprovando um domínio para sua empresa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)".{% endif %} +Os proprietários de empresas também podem aprovar domínios adicionais para organizações pertencentes à empresa. {% ifversion ghec %}Para obter mais informações, consulte "[Verificar ou aprovar um domínio para a sua empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise).{% endif %}{% ifversion ghes > 3.1 %}Para obter mais informações, consulte[Verificando ou aprovando um domínio para sua empresa](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)".{% endif %} ## Verificando um domínio para a sua organização @@ -65,12 +73,8 @@ Para verificar um domínio, você deve ter acesso para modificar registros de do ## Aprovando um domínio para a sua organização -{% ifversion fpt or ghes > 3.1 or ghec %} - {% data reusables.enterprise-accounts.approved-domains-beta-note %} -{% endif %} - {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.verified-domains %} diff --git a/translations/pt-BR/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md b/translations/pt-BR/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md index 68f7d4e441..bb565532bc 100644 --- a/translations/pt-BR/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md +++ b/translations/pt-BR/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md @@ -92,9 +92,10 @@ Algumas das funcionalidades listadas abaixo estão limitadas a organizações qu | Definir lembretes agendados (consulte "[Gerenciar lembretes agendados para pull requests](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests)") | **X** | | | | | | Adicionar colaboradores em **todos os repositórios** | **X** | | | | | | Acessar o log de auditoria da organização | **X** | | | | | -| Edit the organization's profile page (see "[About your organization's profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile)") | **X** | | | | | +| Edit the organization's profile page (see "[About your organization's profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile)") | **X** | | | | |{% ifversion ghec %} | Verify the organization's domains (see "[Verifying your organization's domain](/articles/verifying-your-organization-s-domain)") | **X** | | | | | -| Restrict email notifications to verified or approved domains (see "[Restricting email notifications for your organization](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)") | **X** | | | | | +| Restrict email notifications to verified or approved domains (see "[Restricting email notifications for your organization](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)") | **X** | | | | +{% endif %} | Excluir **todas as equipes** | **X** | | | | | | Excluir a conta da organização, inclusive todos os repositórios | **X** | | | | | | Create teams (see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)") | **X** | **X** | **X** | | **X** | diff --git a/translations/pt-BR/content/rest/README.md b/translations/pt-BR/content/rest/README.md deleted file mode 100644 index 78257d456a..0000000000 --- a/translations/pt-BR/content/rest/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# REST - -O diretório `/content/rest` é onde fica a documentação da API REST do GitHub! - -* Os diretórios `/content/rest/guias` e `/content/rest/overview` contêm artigos regulares. Eles podem ser editados por uma pessoa. -* O diretório `/content/rest/reference` contém um artigo para cada grupo de pontos de extremidade na API REST do GitHub. A maioria do conteúdo nesse diretório é processada usando tags `include`. - - O conteúdo processados com as tags `include` é fornecido no diretório `/lib/rest/static`, que é gerado automaticamente a partir do código fonte da API internamente no GitHub e não deve ser editado por uma pessoa. Para obter mais informações, consulte [`/lib/rest/README.md`](/lib/rest/README.md). - - **Não podemos aceitar alterações no conteúdo interpretado por tags `incluede`. No entanto, você pode abrir um problema descrevendo as alterações que gostaria de ver.** diff --git a/translations/pt-BR/content/rest/actions/artifacts.md b/translations/pt-BR/content/rest/actions/artifacts.md new file mode 100644 index 0000000000..50728ce183 --- /dev/null +++ b/translations/pt-BR/content/rest/actions/artifacts.md @@ -0,0 +1,15 @@ +--- +title: Artifacts +intro: 'The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/actions/cache.md b/translations/pt-BR/content/rest/actions/cache.md new file mode 100644 index 0000000000..227622ec99 --- /dev/null +++ b/translations/pt-BR/content/rest/actions/cache.md @@ -0,0 +1,11 @@ +--- +title: Cache +intro: 'The Cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories.' +topics: + - API +versions: + fpt: '*' + ghec: '*' +--- + +The cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories. For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)." diff --git a/translations/pt-BR/content/rest/actions/index.md b/translations/pt-BR/content/rest/actions/index.md new file mode 100644 index 0000000000..1eef306da9 --- /dev/null +++ b/translations/pt-BR/content/rest/actions/index.md @@ -0,0 +1,26 @@ +--- +title: Actions +intro: 'With the Actions API, you can manage and control {% data variables.product.prodname_actions %} for an organization or repository.' +redirect_from: + - /v3/actions + - /rest/reference/actions +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /artifacts + - /cache + - /permissions + - /secrets + - /self-hosted-runner-groups + - /self-hosted-runners + - /workflow-jobs + - /workflow-runs + - /workflows +--- +The {% data variables.product.prodname_actions %} API enables you to manage {% data variables.product.prodname_actions %} using the REST API. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/actions/permissions.md b/translations/pt-BR/content/rest/actions/permissions.md new file mode 100644 index 0000000000..250824f7dd --- /dev/null +++ b/translations/pt-BR/content/rest/actions/permissions.md @@ -0,0 +1,15 @@ +--- +title: Permissions +intro: 'The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Permissions + +The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/actions/secrets.md b/translations/pt-BR/content/rest/actions/secrets.md new file mode 100644 index 0000000000..bb9cdca350 --- /dev/null +++ b/translations/pt-BR/content/rest/actions/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. ' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/actions/self-hosted-runner-groups.md b/translations/pt-BR/content/rest/actions/self-hosted-runner-groups.md new file mode 100644 index 0000000000..77b15aa36f --- /dev/null +++ b/translations/pt-BR/content/rest/actions/self-hosted-runner-groups.md @@ -0,0 +1,17 @@ +--- +title: Self-hosted runner groups +intro: 'The Self-hosted Runners Groups API allows you manage groups of self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Self-hosted runner groups + +The Self-hosted Runners Groups API allows you manage groups of self-hosted runners. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/actions/self-hosted-runners.md b/translations/pt-BR/content/rest/actions/self-hosted-runners.md new file mode 100644 index 0000000000..61c8aa3d5a --- /dev/null +++ b/translations/pt-BR/content/rest/actions/self-hosted-runners.md @@ -0,0 +1,17 @@ +--- +title: Self-hosted runners +intro: 'The Self-hosted Runners API allows you to register, view, and delete self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Self-hosted runners + +The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/actions/workflow-jobs.md b/translations/pt-BR/content/rest/actions/workflow-jobs.md new file mode 100644 index 0000000000..469ea0382f --- /dev/null +++ b/translations/pt-BR/content/rest/actions/workflow-jobs.md @@ -0,0 +1,15 @@ +--- +title: Workflow jobs +intro: 'The Workflow Jobs API allows you to view logs and workflow jobs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/actions/workflow-runs.md b/translations/pt-BR/content/rest/actions/workflow-runs.md new file mode 100644 index 0000000000..3fca12a420 --- /dev/null +++ b/translations/pt-BR/content/rest/actions/workflow-runs.md @@ -0,0 +1,15 @@ +--- +title: Workflow runs +intro: 'The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/actions/workflows.md b/translations/pt-BR/content/rest/actions/workflows.md new file mode 100644 index 0000000000..55dad18cea --- /dev/null +++ b/translations/pt-BR/content/rest/actions/workflows.md @@ -0,0 +1,15 @@ +--- +title: Workflows +intro: 'The Workflows API allows you to view workflows for a repository.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/activity/events.md b/translations/pt-BR/content/rest/activity/events.md new file mode 100644 index 0000000000..9b3f58527b --- /dev/null +++ b/translations/pt-BR/content/rest/activity/events.md @@ -0,0 +1,33 @@ +--- +title: Events +intro: 'The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These events power the various activity streams on the site. + +The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{% data variables.product.prodname_dotcom %} Event types](/developers/webhooks-and-events/github-event-types)." An events API for repository issues is also available. For more information, see the "[Issue Events API](/rest/reference/issues#events)." + +Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events +> HTTP/2 200 +> X-Poll-Interval: 60 +> ETag: "a18c3bded88eb5dbb5c849a489412bf3" + +# The quotes around the ETag value are important +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events \ +$ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). \ No newline at end of file diff --git a/translations/pt-BR/content/rest/activity/feeds.md b/translations/pt-BR/content/rest/activity/feeds.md new file mode 100644 index 0000000000..e11e4cf1f4 --- /dev/null +++ b/translations/pt-BR/content/rest/activity/feeds.md @@ -0,0 +1,63 @@ +--- +title: Feeds +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Example of getting an Atom feed + +To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories: + + curl -H "Accept: application/atom+xml" https://github.com/security-advisories + +#### Response + +```shell +HTTP/2 200 +``` + +```xml + + + tag:github.com,2008:/security-advisories + + GitHub Security Advisory Feed + + GitHub + + 2019-01-14T19:34:52Z + + tag:github.com,2008:GHSA-abcd-12ab-23cd + 2018-07-26T15:14:52Z + 2019-01-14T19:34:52Z + [GHSA-abcd-12ab-23cd] Moderate severity vulnerability that affects Octoapp + + + <p>Octoapp node module before 4.17.5 suffers from a Modification of Assumed-Immutable Data (MAID) vulnerability via defaultsDeep, merge, and mergeWith functions, which allows a malicious user to modify the prototype of "Object" via <strong>proto</strong>, causing the addition or modification of an existing property that will exist on all objects.</p> + <p><strong>Affected Packages</strong></p> + + <dl> + <dt>Octoapp</dt> + <dd>Ecosystem: npm</dd> + <dd>Severity: moderate</dd> + <dd>Versions: &lt; 4.17.5</dd> + <dd>Fixed in: 4.17.5</dd> + </dl> + + <p><strong>References</strong></p> + + <ul> + <li>https://nvd.nist.gov/vuln/detail/CVE-2018-123</li> + </ul> + + + + +``` \ No newline at end of file diff --git a/translations/pt-BR/content/rest/activity/index.md b/translations/pt-BR/content/rest/activity/index.md new file mode 100644 index 0000000000..3f18631406 --- /dev/null +++ b/translations/pt-BR/content/rest/activity/index.md @@ -0,0 +1,21 @@ +--- +title: Activity +intro: 'The Activity API allows you to list events and feeds and manage notifications, starring, and watching for the authenticated user.' +redirect_from: + - /v3/activity + - /rest/reference/activity +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /events + - /feeds + - /notifications + - /starring + - /watching +--- diff --git a/translations/pt-BR/content/rest/activity/notifications.md b/translations/pt-BR/content/rest/activity/notifications.md new file mode 100644 index 0000000000..49678f8f9c --- /dev/null +++ b/translations/pt-BR/content/rest/activity/notifications.md @@ -0,0 +1,70 @@ +--- +title: Notifications +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Users receive notifications for conversations in repositories they watch including: + +* Issues and their comments +* Pull Requests and their comments +* Comments on any commits + +Notifications are also sent for conversations in unwatched repositories when the user is involved including: + +* **@mentions** +* Issue assignments +* Commits the user authors or commits +* Any discussion in which the user actively participates + +All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints. + +Notifications come back as "threads". A thread contains information about the current discussion of an issue, pull request, or commit. + +Notifications are optimized for polling with the `Last-Modified` header. If there are no new notifications, you will see a `304 Not Modified` response, leaving your current rate limit untouched. There is an `X-Poll-Interval` header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +# Add authentication to your requests +$ curl -I {% data variables.product.api_url_pre %}/notifications +HTTP/2 200 +Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT +X-Poll-Interval: 60 + +# Pass the Last-Modified header exactly +$ curl -I {% data variables.product.api_url_pre %}/notifications +$ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +### Notification reasons + +When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification. + +Here's a list of potential `reason`s for receiving a notification: + +Reason Name | Description +------------|------------ +`assign` | You were assigned to the issue. +`author` | You created the thread. +`comment` | You commented on the thread. +`ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. +`invitation` | You accepted an invitation to contribute to the repository. +`manual` | You subscribed to the thread (via an issue or pull request). +`mention` | You were specifically **@mentioned** in the content. +`review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} +`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in your repository.{% endif %} +`state_change` | You changed the thread state (for example, closing an issue or merging a pull request). +`subscribed` | You're watching the repository. +`team_mention` | You were on a team that was mentioned. + +Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different. + +For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then **@mentioned** on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/activity/starring.md b/translations/pt-BR/content/rest/activity/starring.md new file mode 100644 index 0000000000..9c45ddad6f --- /dev/null +++ b/translations/pt-BR/content/rest/activity/starring.md @@ -0,0 +1,30 @@ +--- +title: Starring +intro: 'Repository starring is a feature that lets users bookmark repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. + +### Starring vs. Watching + +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Many API +client applications may be using the original "watcher" endpoints for accessing +this data. You can now start using the "star" endpoints instead (described +below). For more information, see the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) and the "[Repository Watching API](/rest/reference/activity#watching)." + +### Custom media types for starring + +There is one supported custom media type for the Starring REST API. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`. + + application/vnd.github.v3.star+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/activity/watching.md b/translations/pt-BR/content/rest/activity/watching.md new file mode 100644 index 0000000000..10f078782e --- /dev/null +++ b/translations/pt-BR/content/rest/activity/watching.md @@ -0,0 +1,14 @@ +--- +title: Watching +intro: "Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/apps/apps.md b/translations/pt-BR/content/rest/apps/apps.md new file mode 100644 index 0000000000..7f7fa4b74f --- /dev/null +++ b/translations/pt-BR/content/rest/apps/apps.md @@ -0,0 +1,22 @@ +--- +title: Apps +intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.apps.general-apps-restrictions %} + +This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more. + +When authenticated as a GitHub App, the GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of an app. + +You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user. + +A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints. diff --git a/translations/pt-BR/content/rest/apps/index.md b/translations/pt-BR/content/rest/apps/index.md new file mode 100644 index 0000000000..5bbc724e11 --- /dev/null +++ b/translations/pt-BR/content/rest/apps/index.md @@ -0,0 +1,21 @@ +--- +title: Apps +intro: The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps. +redirect_from: + - /v3/apps + - /rest/reference/apps +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /apps + - /installations + - /marketplace + - /oauth-applications + - /webhooks +--- diff --git a/translations/pt-BR/content/rest/apps/installations.md b/translations/pt-BR/content/rest/apps/installations.md new file mode 100644 index 0000000000..8e858caed4 --- /dev/null +++ b/translations/pt-BR/content/rest/apps/installations.md @@ -0,0 +1,16 @@ +--- +title: Installations +intro: 'The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." + +To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." diff --git a/translations/pt-BR/content/rest/apps/marketplace.md b/translations/pt-BR/content/rest/apps/marketplace.md new file mode 100644 index 0000000000..d49e3bed46 --- /dev/null +++ b/translations/pt-BR/content/rest/apps/marketplace.md @@ -0,0 +1,22 @@ +--- +title: Marketplace +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' +--- + +For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)." + +The {% data variables.product.prodname_marketplace %} API allows you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription. + +### Testing with stubbed endpoints + +This API includes endpoints that allow you to [test your {% data variables.product.prodname_github_app %}](/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/) with **stubbed data**. Stubbed data is hard-coded, fake data that will not change based on actual subscriptions. + +To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether API logic succeeds before listing {% data variables.product.prodname_github_apps %} on {% data variables.product.prodname_marketplace %}. + +Be sure to replace stubbed endpoints with production endpoints before deploying your {% data variables.product.prodname_github_app %}. diff --git a/translations/pt-BR/content/rest/apps/oauth-applications.md b/translations/pt-BR/content/rest/apps/oauth-applications.md new file mode 100644 index 0000000000..037850e51c --- /dev/null +++ b/translations/pt-BR/content/rest/apps/oauth-applications.md @@ -0,0 +1,14 @@ +--- +title: OAuth Applications +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. diff --git a/translations/pt-BR/content/rest/apps/webhooks.md b/translations/pt-BR/content/rest/apps/webhooks.md new file mode 100644 index 0000000000..c3cf61466f --- /dev/null +++ b/translations/pt-BR/content/rest/apps/webhooks.md @@ -0,0 +1,14 @@ +--- +title: Webhooks +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %} diff --git a/translations/pt-BR/content/rest/billing.md b/translations/pt-BR/content/rest/billing.md new file mode 100644 index 0000000000..6f9ccd86a6 --- /dev/null +++ b/translations/pt-BR/content/rest/billing.md @@ -0,0 +1,15 @@ +--- +title: Billing +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.4' +redirect_from: + - /rest/reference/billing +--- + +You can get billing information for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#billing)" REST API. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/branches/branch-protection.md b/translations/pt-BR/content/rest/branches/branch-protection.md new file mode 100644 index 0000000000..e831cd0fea --- /dev/null +++ b/translations/pt-BR/content/rest/branches/branch-protection.md @@ -0,0 +1,13 @@ +--- +title: Protected branches +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/branches/branches.md b/translations/pt-BR/content/rest/branches/branches.md new file mode 100644 index 0000000000..99f1050d0a --- /dev/null +++ b/translations/pt-BR/content/rest/branches/branches.md @@ -0,0 +1,12 @@ +--- +title: Branches +intro: 'The Branches API allows you to modify branches and their protection settings.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/pt-BR/content/rest/branches/index.md b/translations/pt-BR/content/rest/branches/index.md new file mode 100644 index 0000000000..6b13175895 --- /dev/null +++ b/translations/pt-BR/content/rest/branches/index.md @@ -0,0 +1,18 @@ +--- +title: Branches +intro: The branches API allows you to modify branches and their protection settings. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /branches + - /branch-protection +redirect_from: + - /rest/reference/branches +--- diff --git a/translations/pt-BR/content/rest/checks/index.md b/translations/pt-BR/content/rest/checks/index.md new file mode 100644 index 0000000000..6b0e064cb8 --- /dev/null +++ b/translations/pt-BR/content/rest/checks/index.md @@ -0,0 +1,20 @@ +--- +title: Checks +intro: 'With the Checks API, you can build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' +redirect_from: + - /v3/checks + - /rest/reference/checks +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /runs + - /suites +--- + +You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/checks/runs.md b/translations/pt-BR/content/rest/checks/runs.md new file mode 100644 index 0000000000..c49d26fd02 --- /dev/null +++ b/translations/pt-BR/content/rest/checks/runs.md @@ -0,0 +1,13 @@ +--- +title: Check Runs +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/checks/suites.md b/translations/pt-BR/content/rest/checks/suites.md new file mode 100644 index 0000000000..9aec42aad3 --- /dev/null +++ b/translations/pt-BR/content/rest/checks/suites.md @@ -0,0 +1,19 @@ +--- +title: Check Suites +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% note %} + + **Note:** A GitHub App only receives one [`check_suite`](/webhooks/event-payloads/#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks/event-payloads/#create) events. + +{% endnote %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/code-scanning.md b/translations/pt-BR/content/rest/code-scanning.md new file mode 100644 index 0000000000..8c464645a9 --- /dev/null +++ b/translations/pt-BR/content/rest/code-scanning.md @@ -0,0 +1,32 @@ +--- +title: Code Scanning +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API + - Code scanning + - REST +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/code-scanning +--- + +{% data reusables.code-scanning.beta %} + +The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[Finding security vulnerabilities and errors in your code](/github/finding-security-vulnerabilities-and-errors-in-your-code)." + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +### Custom media type for {% data variables.product.prodname_code_scanning %} + +There is one supported custom media type for the {% data variables.product.prodname_code_scanning %} REST API. + + application/sarif+json + +You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. For more information about this operation, see "[Get a {% data variables.product.prodname_code_scanning %} analysis for a repository](#get-a-code-scanning-analysis-for-a-repository)." When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than the summary of the analysis that's returned when you use the default media type. The response also includes additional data such as the `github/alertNumber` and `github/alertUrl` properties. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + +For more information, see "[Media types](/rest/overview/media-types)." +{% endif %} diff --git a/translations/pt-BR/content/rest/codes-of-conduct.md b/translations/pt-BR/content/rest/codes-of-conduct.md new file mode 100644 index 0000000000..dd96f59734 --- /dev/null +++ b/translations/pt-BR/content/rest/codes-of-conduct.md @@ -0,0 +1,16 @@ +--- +title: Codes of Conduct +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/codes-of-conduct +--- + +You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a repository's code of conduct, use the "[Get a repository](/rest/reference/repos#get-a-repository)" endpoint. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/codespaces/codespaces.md b/translations/pt-BR/content/rest/codespaces/codespaces.md new file mode 100644 index 0000000000..11d920b1c2 --- /dev/null +++ b/translations/pt-BR/content/rest/codespaces/codespaces.md @@ -0,0 +1,14 @@ +--- +title: Codespaces +intro: 'The Codespaces API enables you to manage your codespaces using the REST API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% data reusables.codespaces.codespaces-api-beta-note %} + +The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)." diff --git a/translations/pt-BR/content/rest/codespaces/index.md b/translations/pt-BR/content/rest/codespaces/index.md new file mode 100644 index 0000000000..d97a0755c0 --- /dev/null +++ b/translations/pt-BR/content/rest/codespaces/index.md @@ -0,0 +1,18 @@ +--- +title: Codespaces +intro: 'The {% data variables.product.prodname_codespaces %} API enables you to manage your codespaces using the REST API.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /codespaces + - /machines + - /repository-secrets + - /secrets +redirect_from: + - /rest/reference/codespaces +--- diff --git a/translations/pt-BR/content/rest/codespaces/machines.md b/translations/pt-BR/content/rest/codespaces/machines.md new file mode 100644 index 0000000000..b39416253f --- /dev/null +++ b/translations/pt-BR/content/rest/codespaces/machines.md @@ -0,0 +1,14 @@ +--- +title: Machines +intro: 'The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)." + +You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/codespaces/repository-secrets.md b/translations/pt-BR/content/rest/codespaces/repository-secrets.md new file mode 100644 index 0000000000..ccab41f36e --- /dev/null +++ b/translations/pt-BR/content/rest/codespaces/repository-secrets.md @@ -0,0 +1,15 @@ +--- +title: Repository Secrets +intro: 'The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.5' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +## Repository Secrets + +The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/codespaces/secrets.md b/translations/pt-BR/content/rest/codespaces/secrets.md new file mode 100644 index 0000000000..fb315dc8ce --- /dev/null +++ b/translations/pt-BR/content/rest/codespaces/secrets.md @@ -0,0 +1,15 @@ +--- +title: User Secrets +intro: 'The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +## User Secrets + +The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/collaborators/collaborators.md b/translations/pt-BR/content/rest/collaborators/collaborators.md new file mode 100644 index 0000000000..e2c617d39f --- /dev/null +++ b/translations/pt-BR/content/rest/collaborators/collaborators.md @@ -0,0 +1,12 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/collaborators/index.md b/translations/pt-BR/content/rest/collaborators/index.md new file mode 100644 index 0000000000..925f1ff4e9 --- /dev/null +++ b/translations/pt-BR/content/rest/collaborators/index.md @@ -0,0 +1,18 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /collaborators + - /invitations +redirect_from: + - /rest/reference/collaborators +--- diff --git a/translations/pt-BR/content/rest/collaborators/invitations.md b/translations/pt-BR/content/rest/collaborators/invitations.md new file mode 100644 index 0000000000..502e22608a --- /dev/null +++ b/translations/pt-BR/content/rest/collaborators/invitations.md @@ -0,0 +1,22 @@ +--- +title: Invitations +intro: 'The Repository Invitations API allows users or external services to invite other users to collaborate on a repo.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. + +Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted +access to invitations **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as invitations. + +### Invite a user to a repository + +Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/collaborators/collaborators#add-a-repository-collaborator)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/commits/comments.md b/translations/pt-BR/content/rest/commits/comments.md new file mode 100644 index 0000000000..34ff1e9f90 --- /dev/null +++ b/translations/pt-BR/content/rest/commits/comments.md @@ -0,0 +1,25 @@ +--- +title: Commit comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Custom media types for commit comments + +These are the supported media types for commit comments. You can read more +about the use of media types in the API [here](/rest/overview/media-types). + + application/vnd.github-commitcomment.raw+json + application/vnd.github-commitcomment.text+json + application/vnd.github-commitcomment.html+json + application/vnd.github-commitcomment.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/commits/commits.md b/translations/pt-BR/content/rest/commits/commits.md new file mode 100644 index 0000000000..8b0fa3f792 --- /dev/null +++ b/translations/pt-BR/content/rest/commits/commits.md @@ -0,0 +1,12 @@ +--- +title: Commits +intro: 'The Commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/pt-BR/content/rest/commits/index.md b/translations/pt-BR/content/rest/commits/index.md new file mode 100644 index 0000000000..425b0999cf --- /dev/null +++ b/translations/pt-BR/content/rest/commits/index.md @@ -0,0 +1,19 @@ +--- +title: Commits +intro: 'The commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /commits + - /comments + - /statuses +redirect_from: + - /rest/reference/commits +--- diff --git a/translations/pt-BR/content/rest/commits/statuses.md b/translations/pt-BR/content/rest/commits/statuses.md new file mode 100644 index 0000000000..27050e2439 --- /dev/null +++ b/translations/pt-BR/content/rest/commits/statuses.md @@ -0,0 +1,23 @@ +--- +title: Commit statuses +intro: 'The status API allows external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Statuses can also include an optional `description` and `target_url`, and we highly recommend providing them as they make statuses much more useful in the GitHub UI. + +As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The `target_url` would be the full URL to the build output, and the `description` would be the high level summary of what happened with the build. + +Statuses can include a `context` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. + +Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the `repo` scope grants permission to code as well as statuses. + +If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks). \ No newline at end of file diff --git a/translations/pt-BR/content/rest/dependabot/index.md b/translations/pt-BR/content/rest/dependabot/index.md new file mode 100644 index 0000000000..9de244ec7d --- /dev/null +++ b/translations/pt-BR/content/rest/dependabot/index.md @@ -0,0 +1,16 @@ +--- +title: Dependabot +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /secrets +redirect_from: + - /rest/reference/dependabot +--- diff --git a/translations/pt-BR/content/rest/dependabot/secrets.md b/translations/pt-BR/content/rest/dependabot/secrets.md new file mode 100644 index 0000000000..f57bff7358 --- /dev/null +++ b/translations/pt-BR/content/rest/dependabot/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +topics: + - API +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +allowTitleToDifferFromFilename: true +--- + +The {% data variables.product.prodname_dependabot %} Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/dependency-graph/dependency-review.md b/translations/pt-BR/content/rest/dependency-graph/dependency-review.md new file mode 100644 index 0000000000..b08e657b46 --- /dev/null +++ b/translations/pt-BR/content/rest/dependency-graph/dependency-review.md @@ -0,0 +1,19 @@ +--- +title: Dependency Review +intro: 'The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment.' +versions: + fpt: '*' + ghes: '>=3.6' + ghec: '*' + ghae: 'issue-6396' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +## Dependency review + +{% data reusables.dependency-review.dependency-review-api-beta-note %} + +The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/reference/dependency-graph.md b/translations/pt-BR/content/rest/dependency-graph/index.md similarity index 53% rename from translations/pt-BR/content/rest/reference/dependency-graph.md rename to translations/pt-BR/content/rest/dependency-graph/index.md index 39a124e607..393c5eaa5c 100644 --- a/translations/pt-BR/content/rest/reference/dependency-graph.md +++ b/translations/pt-BR/content/rest/dependency-graph/index.md @@ -1,16 +1,16 @@ --- -title: Gráfico de dependências +title: Dependency Graph intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.' versions: fpt: '*' ghes: '>=3.6' ghec: '*' - ghae: issue-6396 + ghae: 'issue-6396' topics: - API miniTocMaxHeadingLevel: 3 +children: + - /dependency-review +redirect_from: + - /rest/reference/dependency-graph --- - - diff --git a/translations/pt-BR/content/rest/deploy-keys.md b/translations/pt-BR/content/rest/deploy-keys.md new file mode 100644 index 0000000000..0158b1194b --- /dev/null +++ b/translations/pt-BR/content/rest/deploy-keys.md @@ -0,0 +1,19 @@ +--- +title: Deploy Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/deploy_keys +--- + +{% data reusables.repositories.deploy-keys %} + +Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/deployments/deployments.md b/translations/pt-BR/content/rest/deployments/deployments.md new file mode 100644 index 0000000000..84f4f9eea3 --- /dev/null +++ b/translations/pt-BR/content/rest/deployments/deployments.md @@ -0,0 +1,60 @@ +--- +title: Deployments +intro: 'The Deployments API allows you to create and delete deployments and deployment environments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). + +Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume. + +Deployment statuses can also include an optional `description` and `log_url`, which are highly recommended because they make deployment statuses more useful. The `log_url` is the full URL to the deployment output, and +the `description` is a high-level summary of what happened with the deployment. + +GitHub dispatches `deployment` and `deployment_status` events when new deployments and deployment statuses are created. These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made. + +Below is a simple sequence diagram for how these interactions would work. + +``` ++---------+ +--------+ +-----------+ +-------------+ +| Tooling | | GitHub | | 3rd Party | | Your Server | ++---------+ +--------+ +-----------+ +-------------+ + | | | | + | Create Deployment | | | + |--------------------->| | | + | | | | + | Deployment Created | | | + |<---------------------| | | + | | | | + | | Deployment Event | | + | |---------------------->| | + | | | SSH+Deploys | + | | |-------------------->| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | + | | | Deploy Completed | + | | |<--------------------| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | +``` + +Keep in mind that GitHub is never actually accessing your servers. It's up to your third-party integration to interact with deployment events. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether they're responsible for pushing the code out to your servers, building native code, etc. + +Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the {% ifversion not ghae %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well. + +### Inactive deployments + +When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status. + +You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. diff --git a/translations/pt-BR/content/rest/deployments/environments.md b/translations/pt-BR/content/rest/deployments/environments.md new file mode 100644 index 0000000000..1d90c1aa6b --- /dev/null +++ b/translations/pt-BR/content/rest/deployments/environments.md @@ -0,0 +1,16 @@ +--- +title: Environments +intro: 'The Environments API allows you to create, configure, and delete environments.' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." + +{% data reusables.gated-features.environments %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/deployments/index.md b/translations/pt-BR/content/rest/deployments/index.md new file mode 100644 index 0000000000..c92c19aec6 --- /dev/null +++ b/translations/pt-BR/content/rest/deployments/index.md @@ -0,0 +1,19 @@ +--- +title: Deployments +intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /deployments + - /environments + - /statuses +redirect_from: + - /rest/reference/deployments +--- diff --git a/translations/pt-BR/content/rest/deployments/statuses.md b/translations/pt-BR/content/rest/deployments/statuses.md new file mode 100644 index 0000000000..0896d48e75 --- /dev/null +++ b/translations/pt-BR/content/rest/deployments/statuses.md @@ -0,0 +1,13 @@ +--- +title: Deployment Statuses +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/emojis.md b/translations/pt-BR/content/rest/emojis.md new file mode 100644 index 0000000000..ca45960388 --- /dev/null +++ b/translations/pt-BR/content/rest/emojis.md @@ -0,0 +1,14 @@ +--- +title: Emojis +intro: 'With the Emojis API, you can list and view all the available emojis to use in {% data variables.product.product_name %}.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/emojis +--- diff --git a/translations/pt-BR/content/rest/enterprise-admin/admin-stats.md b/translations/pt-BR/content/rest/enterprise-admin/admin-stats.md new file mode 100644 index 0000000000..d18be10342 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/admin-stats.md @@ -0,0 +1,12 @@ +--- +title: Admin stats +intro: 'The Admin Stats API provides a variety of metrics about your installation.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/announcement.md b/translations/pt-BR/content/rest/enterprise-admin/announcement.md new file mode 100644 index 0000000000..05a248af24 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/announcement.md @@ -0,0 +1,14 @@ +--- +title: Announcement +intro: 'The Announcement API allows you to manage the global announcement banner in your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +## Announcement + +The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/audit-log.md b/translations/pt-BR/content/rest/enterprise-admin/audit-log.md new file mode 100644 index 0000000000..7fa5096e21 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/audit-log.md @@ -0,0 +1,11 @@ +--- +title: Audit log +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/enterprise-admin/billing.md b/translations/pt-BR/content/rest/enterprise-admin/billing.md new file mode 100644 index 0000000000..15f8a05d8f --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/billing.md @@ -0,0 +1,11 @@ +--- +title: Billing +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/enterprise-admin/global-webhooks.md b/translations/pt-BR/content/rest/enterprise-admin/global-webhooks.md new file mode 100644 index 0000000000..b14fc8ab70 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/global-webhooks.md @@ -0,0 +1,14 @@ +--- +title: Global Webhooks +intro: 'Global Webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. + +*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/index.md b/translations/pt-BR/content/rest/enterprise-admin/index.md new file mode 100644 index 0000000000..2845bef7e0 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/index.md @@ -0,0 +1,82 @@ +--- +title: GitHub Enterprise administration +intro: You can use these endpoints to administer your enterprise. +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/enterprise-admin + - /v3/enterprise + - /rest/reference/enterprise-admin +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +shortTitle: Enterprise administration +children: + - /admin-stats + - /announcement + - /audit-log + - /billing + - /global-webhooks + - /ldap + - /license + - /management-console + - /org-pre-receive-hooks + - /orgs + - /pre-receive-environments + - /pre-receive-hooks + - /repo-pre-receive-hooks + - /users + - /scim +--- + +{% ifversion fpt or ghec %} + +{% note %} + +**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. + +{% endnote %} + +{% endif %} + +### Endpoint URLs + +REST API endpoints{% ifversion ghes %}—except [Management Console](#management-console) API endpoints—{% endif %} are prefixed with the following URL: + +```shell +{% data variables.product.api_url_pre %} +``` + +{% ifversion fpt or ghec %} +When endpoints include `{enterprise}`, replace `{enterprise}` with the handle for your enterprise account, which is included in the URL for your enterprise settings. For example, if your enterprise account is located at `https://github.com/enterprises/octo-enterprise`, replace `{enterprise}` with `octo-enterprise`. +{% endif %} + +{% ifversion ghes %} +[Management Console](#management-console) API endpoints are only prefixed with a hostname: + +```shell +http(s)://hostname/ +``` +{% endif %} +{% ifversion ghae or ghes %} +### Authentication + +Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** {% ifversion ghes %}(which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) {% endif %}or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% ifversion ghes %} +OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %} + +Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/){% endif %}. + +{% endif %} + +{% ifversion ghae or ghes %} +### Version information + +The current version of your enterprise is returned in the response header of every API: +`X-GitHub-Enterprise-Version: {{currentVersion}}.0` +You can also read the current version by calling the [meta endpoint](/rest/reference/meta/). + +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/ldap.md b/translations/pt-BR/content/rest/enterprise-admin/ldap.md new file mode 100644 index 0000000000..af2f31c0a7 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/ldap.md @@ -0,0 +1,11 @@ +--- +title: LDAP +intro: 'You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/license.md b/translations/pt-BR/content/rest/enterprise-admin/license.md new file mode 100644 index 0000000000..2fd64bd48e --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/license.md @@ -0,0 +1,12 @@ +--- +title: License +intro: 'The License API provides information on your Enterprise license.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/management-console.md b/translations/pt-BR/content/rest/enterprise-admin/management-console.md new file mode 100644 index 0000000000..5e9f95ee02 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/management-console.md @@ -0,0 +1,35 @@ +--- +title: Management Console +intro: 'The Management Console API helps you manage your {% data variables.product.product_name %} installation.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% tip %} + +You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`; otherwise, the port number is `8080`. + +If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. + +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/). + +{% endtip %} + +### Authentication + +You need to pass your [Management Console password](/enterprise/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#create-a-github-enterprise-server-license). + +Use the `api_key` parameter to send this token with each request. For example: + +```shell +$ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' +``` + +You can also use standard HTTP authentication to send this token. For example: + +```shell +$ curl -L -u "api_key:your-amazing-password" 'https://hostname:admin_port/setup/api' +``` \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/org-pre-receive-hooks.md b/translations/pt-BR/content/rest/enterprise-admin/org-pre-receive-hooks.md new file mode 100644 index 0000000000..bc8b8b31ea --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/org-pre-receive-hooks.md @@ -0,0 +1,23 @@ +--- +title: Organization Pre-receive Hooks +intro: 'The Organization Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to an organization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Object attributes + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this endpoint or this hook's global configuration. Only site admins are able to access the global configuration. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/orgs.md b/translations/pt-BR/content/rest/enterprise-admin/orgs.md new file mode 100644 index 0000000000..f8fdc559dc --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: 'The Organization Administration API allows you to create organizations on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/pre-receive-environments.md b/translations/pt-BR/content/rest/enterprise-admin/pre-receive-environments.md new file mode 100644 index 0000000000..feb2ce08b5 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/pre-receive-environments.md @@ -0,0 +1,34 @@ +--- +title: Pre-receive Environments +intro: 'The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Environment + +| Name | Type | Description | +|-----------------------|-----------|----------------------------------------------------------------------------| +| `name` | `string` | The name of the environment as displayed in the UI. | +| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. | +| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. | +| `download` | `object` | This environment's download status. | +| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. | + +#### Pre-receive Environment Download + +| Name | Type | Description | +|-----------------|----------|---------------------------------------------------------| +| `state` | `string` | The state of the most recent download. | +| `downloaded_at` | `string` | The time when the most recent download started. | +| `message` | `string` | On failure, this will have any error messages produced. | + +Possible values for `state` are `not_started`, `in_progress`, `success`, `failed`. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/pre-receive-hooks.md b/translations/pt-BR/content/rest/enterprise-admin/pre-receive-hooks.md new file mode 100644 index 0000000000..08d5c5f3ce --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/pre-receive-hooks.md @@ -0,0 +1,27 @@ +--- +title: Pre-receive Hooks +intro: 'The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Hook + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `script` | `string` | The script that the hook runs. | +| `script_repository` | `object` | The GitHub repository where the script is kept. | +| `environment` | `object` | The pre-receive environment where the script is executed. | +| `enforcement` | `string` | The state of enforcement for this hook. | +| `allow_downstream_configuration` | `boolean` | Whether enforcement can be overridden at the org or repo level. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/repo-pre-receive-hooks.md b/translations/pt-BR/content/rest/enterprise-admin/repo-pre-receive-hooks.md new file mode 100644 index 0000000000..831ca1a06a --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/repo-pre-receive-hooks.md @@ -0,0 +1,22 @@ +--- +title: Repository Pre-receive Hooks +intro: 'The Repository Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to a repository.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Object attributes + +| Name | Type | Description | +|---------------------|----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/enterprise-admin/scim.md b/translations/pt-BR/content/rest/enterprise-admin/scim.md new file mode 100644 index 0000000000..326d333cbf --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/scim.md @@ -0,0 +1,11 @@ +--- +title: SCIM +intro: '' +versions: + fpt: '*' + ghec: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/enterprise-admin/users.md b/translations/pt-BR/content/rest/enterprise-admin/users.md new file mode 100644 index 0000000000..6d9aea56c7 --- /dev/null +++ b/translations/pt-BR/content/rest/enterprise-admin/users.md @@ -0,0 +1,12 @@ +--- +title: Users +intro: 'The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/gists/comments.md b/translations/pt-BR/content/rest/gists/comments.md new file mode 100644 index 0000000000..9b01fd1f71 --- /dev/null +++ b/translations/pt-BR/content/rest/gists/comments.md @@ -0,0 +1,21 @@ +--- +title: Comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Custom media types for Gist comments + +These are the supported media types for gist comments. + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.base64 + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/gists/gists.md b/translations/pt-BR/content/rest/gists/gists.md new file mode 100644 index 0000000000..5cb6fef354 --- /dev/null +++ b/translations/pt-BR/content/rest/gists/gists.md @@ -0,0 +1,35 @@ +--- +title: Gists +intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on GitHub.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Authentication + +You can read public gists {% ifversion ghae or ghes %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." + + + +### Truncation + +The Gist API provides up to one megabyte of content for each file in the gist. Each file returned for a gist through the API has a key called `truncated`. If `truncated` is `true`, the file is too large and only a portion of the contents were returned in `content`. + +If you need the full contents of the file, you can make a `GET` request to the URL specified by `raw_url`. Be aware that for files larger than ten megabytes, you'll need to clone the gist via the URL provided by `git_pull_url`. + +In addition to a specific file's contents being truncated, the entire files list may be truncated if the total number exceeds 300 files. If the top level `truncated` key is `true`, only the first 300 files have been returned in the files list. If you need to fetch all of the gist's files, you'll need to clone the gist via the URL provided by `git_pull_url`. + +### Custom media types for gists + +These are the supported media types for fetching gist contents. + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.base64 + +For more information, see "[Media types](/rest/overview/media-types)." diff --git a/translations/pt-BR/content/rest/gists/index.md b/translations/pt-BR/content/rest/gists/index.md new file mode 100644 index 0000000000..7c9ddbab2c --- /dev/null +++ b/translations/pt-BR/content/rest/gists/index.md @@ -0,0 +1,18 @@ +--- +title: Gists +intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on {% data variables.product.product_name %}.' +redirect_from: + - /v3/gists + - /rest/reference/gists +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /gists + - /comments +--- diff --git a/translations/pt-BR/content/rest/git/blobs.md b/translations/pt-BR/content/rest/git/blobs.md new file mode 100644 index 0000000000..a4df5aca84 --- /dev/null +++ b/translations/pt-BR/content/rest/git/blobs.md @@ -0,0 +1,24 @@ +--- +title: Blobs +intro: 'A Git blob (binary large object) is the object type used to store the contents of each file in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) +to your Git database on {% data variables.product.product_name %}. Blobs leverage [these custom media types](#custom-media-types-for-blobs). You can read more about the use of media types in the API [here](/rest/overview/media-types). + +### Custom media types for blobs + +These are the supported media types for blobs. + + application/json + application/vnd.github.VERSION.raw + +For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/git/commits.md b/translations/pt-BR/content/rest/git/commits.md new file mode 100644 index 0000000000..18c14bb2ac --- /dev/null +++ b/translations/pt-BR/content/rest/git/commits.md @@ -0,0 +1,14 @@ +--- +title: Commits +intro: 'A Git commit is a snapshot of the hierarchy ([Git tree](/rest/reference/git#trees)) and the contents of the files ([Git blob](/rest/reference/git#blobs)) in a Git repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/git/index.md b/translations/pt-BR/content/rest/git/index.md new file mode 100644 index 0000000000..da1de11653 --- /dev/null +++ b/translations/pt-BR/content/rest/git/index.md @@ -0,0 +1,24 @@ +--- +title: Git database +intro: 'The Git Database API enables you to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update Git references (branch heads and tags).' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/git + - /rest/reference/git +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /blobs + - /commits + - /refs + - /tags + - /trees +--- + +The Git Database API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the Git Database API, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/git/refs.md b/translations/pt-BR/content/rest/git/refs.md new file mode 100644 index 0000000000..55b5f8122a --- /dev/null +++ b/translations/pt-BR/content/rest/git/refs.md @@ -0,0 +1,15 @@ +--- +title: References +intro: 'A Git reference (`git ref`) is just a file that contains a Git commit SHA-1 hash.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is just a Git reference that stores the new Git commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v1/Git-Internals-Git-References) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/git/tags.md b/translations/pt-BR/content/rest/git/tags.md new file mode 100644 index 0000000000..101fde046a --- /dev/null +++ b/translations/pt-BR/content/rest/git/tags.md @@ -0,0 +1,14 @@ +--- +title: Tags +intro: 'A Git tag is similar to a [Git reference](/rest/reference/git#refs), but the Git commit that it points to never changes.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags) to your Git database on {% data variables.product.product_name %}. The Git tags API only supports [annotated tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags), not lightweight tags. diff --git a/translations/pt-BR/content/rest/git/trees.md b/translations/pt-BR/content/rest/git/trees.md new file mode 100644 index 0000000000..7471c1d66a --- /dev/null +++ b/translations/pt-BR/content/rest/git/trees.md @@ -0,0 +1,14 @@ +--- +title: Trees +intro: 'A Git tree object creates the hierarchy between files in a Git repository. ' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/gitignore.md b/translations/pt-BR/content/rest/gitignore.md new file mode 100644 index 0000000000..0a641c3994 --- /dev/null +++ b/translations/pt-BR/content/rest/gitignore.md @@ -0,0 +1,24 @@ +--- +title: Gitignore +intro: 'The Gitignore API fetches `.gitignore` templates that can be used to ignore files and directories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/gitignore +--- + +When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). + +### Custom media types for gitignore + +You can use this custom media type when getting a gitignore template. + + application/vnd.github.VERSION.raw + +For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/index.md b/translations/pt-BR/content/rest/index.md index 9c9ae42378..773fa86484 100644 --- a/translations/pt-BR/content/rest/index.md +++ b/translations/pt-BR/content/rest/index.md @@ -1,7 +1,7 @@ --- -title: API de REST do GitHub -shortTitle: API REST -intro: 'Para criar integrações, recuperar dados e automatizar seus fluxos de trabalho, crie com a API REST de {% data variables.product.prodname_dotcom %}.' +title: GitHub REST API +shortTitle: REST API +intro: 'To create integrations, retrieve data, and automate your workflows, build with the {% data variables.product.prodname_dotcom %} REST API.' introLinks: quickstart: /rest/guides/getting-started-with-the-rest-api featuredLinks: @@ -31,7 +31,49 @@ versions: ghec: '*' children: - /overview - - /reference - /guides + - /actions + - /activity + - /apps + - /billing + - /branches + - /checks + - /codes-of-conduct + - /code-scanning + - /codespaces + - /collaborators + - /commits + - /dependabot + - /dependency-graph + - /deploy-keys + - /deployments + - /emojis + - /enterprise-admin + - /gists + - /git + - /gitignore + - /interactions + - /issues + - /licenses + - /markdown + - /meta + - /metrics + - /migrations + - /oauth-authorizations + - /orgs + - /packages + - /pages + - /projects + - /pulls + - /rate-limit + - /reactions + - /releases + - /repos + - /scim + - /search + - /secret-scanning + - /teams + - /users + - /webhooks --- diff --git a/translations/pt-BR/content/rest/interactions/index.md b/translations/pt-BR/content/rest/interactions/index.md new file mode 100644 index 0000000000..10c5349a73 --- /dev/null +++ b/translations/pt-BR/content/rest/interactions/index.md @@ -0,0 +1,19 @@ +--- +title: Interactions +intro: 'With the Interactions API, people with owner or admin access can set the interaction limit for the users in their organizations and repositories.' +redirect_from: + - /v3/interactions + - /rest/reference/interactions +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /repos + - /user +--- + +Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/interactions/orgs.md b/translations/pt-BR/content/rest/interactions/orgs.md new file mode 100644 index 0000000000..2185e2bb46 --- /dev/null +++ b/translations/pt-BR/content/rest/interactions/orgs.md @@ -0,0 +1,19 @@ +--- +title: Organization +intro: "The Organization Interactions API allows organization owners to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories." +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} in the organization. +* {% data reusables.interactions.contributor-user-limit-definition %} in the organization. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the organization. + +Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the [Repository](#repository) interactions endpoints instead. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/interactions/repos.md b/translations/pt-BR/content/rest/interactions/repos.md new file mode 100644 index 0000000000..5bba6ae46d --- /dev/null +++ b/translations/pt-BR/content/rest/interactions/repos.md @@ -0,0 +1,19 @@ +--- +title: Repository +intro: 'The Repository Interactions API allows people with owner or admin access to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} in the repository. +* {% data reusables.interactions.contributor-user-limit-definition %} in the repository. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the repository. + +If an interaction limit is enabled for the user or organization that owns the repository, the limit cannot be changed for the individual repository. Instead, use the [User](#user) or [Organization](#organization) interactions endpoints to change the interaction limit. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/interactions/user.md b/translations/pt-BR/content/rest/interactions/user.md new file mode 100644 index 0000000000..b7fa0c6174 --- /dev/null +++ b/translations/pt-BR/content/rest/interactions/user.md @@ -0,0 +1,18 @@ +--- +title: User +intro: 'The User Interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories. + +Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the [Repository](#repository) interactions endpoints instead. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/issues/assignees.md b/translations/pt-BR/content/rest/issues/assignees.md new file mode 100644 index 0000000000..3d465a739e --- /dev/null +++ b/translations/pt-BR/content/rest/issues/assignees.md @@ -0,0 +1,12 @@ +--- +title: Assignees +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/issues/comments.md b/translations/pt-BR/content/rest/issues/comments.md new file mode 100644 index 0000000000..9d68676a6a --- /dev/null +++ b/translations/pt-BR/content/rest/issues/comments.md @@ -0,0 +1,14 @@ +--- +title: Comments +intro: 'The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Issue Comments use [these custom media types](#custom-media-types). You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/translations/pt-BR/content/rest/issues/events.md b/translations/pt-BR/content/rest/issues/events.md new file mode 100644 index 0000000000..e6eaa7a53c --- /dev/null +++ b/translations/pt-BR/content/rest/issues/events.md @@ -0,0 +1,14 @@ +--- +title: Events +intro: 'The Issue Events API can return different types of events triggered by activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[Events API](/developers/webhooks-and-events/github-event-types)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/issues/index.md b/translations/pt-BR/content/rest/issues/index.md new file mode 100644 index 0000000000..11fae409e7 --- /dev/null +++ b/translations/pt-BR/content/rest/issues/index.md @@ -0,0 +1,23 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +redirect_from: + - /v3/issues + - /rest/reference/issues +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /issues + - /assignees + - /comments + - /events + - /labels + - /milestones + - /timeline +--- diff --git a/translations/pt-BR/content/rest/issues/issues.md b/translations/pt-BR/content/rest/issues/issues.md new file mode 100644 index 0000000000..630bf7315f --- /dev/null +++ b/translations/pt-BR/content/rest/issues/issues.md @@ -0,0 +1,23 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Custom media types for issues + +These are the supported media types for issues. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/issues/labels.md b/translations/pt-BR/content/rest/issues/labels.md new file mode 100644 index 0000000000..c2d910ec3e --- /dev/null +++ b/translations/pt-BR/content/rest/issues/labels.md @@ -0,0 +1,12 @@ +--- +title: Labels +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/issues/milestones.md b/translations/pt-BR/content/rest/issues/milestones.md new file mode 100644 index 0000000000..2ae71632ba --- /dev/null +++ b/translations/pt-BR/content/rest/issues/milestones.md @@ -0,0 +1,12 @@ +--- +title: Milestones +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/issues/timeline.md b/translations/pt-BR/content/rest/issues/timeline.md new file mode 100644 index 0000000000..4d7a73e4ca --- /dev/null +++ b/translations/pt-BR/content/rest/issues/timeline.md @@ -0,0 +1,16 @@ +--- +title: Timeline +intro: 'The Timeline Events API can return different types of events triggered by timeline activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[GitHub Events API](/developers/webhooks-and-events/github-event-types)." + +You can use this API to display information about issues and pull request or determine who should be notified of issue comments. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/licenses.md b/translations/pt-BR/content/rest/licenses.md new file mode 100644 index 0000000000..78619bfa73 --- /dev/null +++ b/translations/pt-BR/content/rest/licenses.md @@ -0,0 +1,35 @@ +--- +title: Licenses +intro: "The Licenses API lets you to retrieve popular open source licenses and information about a particular project's license file." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/licenses +--- + +The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's `LICENSE` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation. + +If a license is matched, the license key and name returned conforms to the [SPDX specification](https://spdx.org/). + +**Note:** These endpoints will also return a repository's license information: + +- [Get a repository](/rest/reference/repos#get-a-repository) +- [List repositories for a user](/rest/reference/repos#list-repositories-for-a-user) +- [List organization repositories](/rest/reference/repos#list-organization-repositories) +- [List forks](/rest/reference/repos#list-forks) +- [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user) +- [List team repositories](/rest/reference/teams#list-team-repositories) + +{% warning %} + +GitHub is a lot of things, but it’s not a law firm. As such, GitHub does not provide legal advice. Using the Licenses API or sending us an email about it does not constitute legal advice nor does it create an attorney-client relationship. If you have any questions about what you can and can't do with a particular license, you should consult with your own legal counsel before moving forward. In fact, you should always consult with your own lawyer before making any decisions that might have legal ramifications or that may impact your legal rights. + +GitHub created the License API to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers (at least most of us aren't) and that we make mistakes like everyone else. For that reason, GitHub provides the API on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API. + +{% endwarning %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/markdown.md b/translations/pt-BR/content/rest/markdown.md new file mode 100644 index 0000000000..2f782424e3 --- /dev/null +++ b/translations/pt-BR/content/rest/markdown.md @@ -0,0 +1,14 @@ +--- +title: Markdown +intro: 'The Markdown API enables you to render a markdown document as an HTML page or as raw text.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/markdown +--- diff --git a/translations/pt-BR/content/rest/meta.md b/translations/pt-BR/content/rest/meta.md new file mode 100644 index 0000000000..6ecb71fe20 --- /dev/null +++ b/translations/pt-BR/content/rest/meta.md @@ -0,0 +1,14 @@ +--- +title: Meta +intro: 'The Meta API returns meta information about {% data variables.product.product_name %} including the IP addresses of {% data variables.product.product_name %} services.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/meta +--- diff --git a/translations/pt-BR/content/rest/metrics/community.md b/translations/pt-BR/content/rest/metrics/community.md new file mode 100644 index 0000000000..725ad20ea0 --- /dev/null +++ b/translations/pt-BR/content/rest/metrics/community.md @@ -0,0 +1,10 @@ +--- +title: Community +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/metrics/index.md b/translations/pt-BR/content/rest/metrics/index.md new file mode 100644 index 0000000000..4f450b3a9e --- /dev/null +++ b/translations/pt-BR/content/rest/metrics/index.md @@ -0,0 +1,20 @@ +--- +title: Metrics +intro: 'The repository metrics API allows you to retrieve community profile, statistics, and traffic for your repository.' +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/repository-metrics + - /rest/reference/metrics +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /community + - /statistics + - /traffic +--- diff --git a/translations/pt-BR/content/rest/metrics/statistics.md b/translations/pt-BR/content/rest/metrics/statistics.md new file mode 100644 index 0000000000..955c527812 --- /dev/null +++ b/translations/pt-BR/content/rest/metrics/statistics.md @@ -0,0 +1,31 @@ +--- +title: Statistics +intro: 'The Repository Statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different types of repository activity.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### A word about caching + +Computing repository statistics is an expensive operation, so we try to return cached +data whenever possible. If the data hasn't been cached when you query a repository's +statistics, you'll receive a `202` response; a background job is also fired to +start compiling these statistics. Give the job a few moments to complete, and +then submit the request again. If the job has completed, that request will receive a +`200` response with the statistics in the response body. + +Repository statistics are cached by the SHA of the repository's default branch; pushing to the default branch resets the statistics cache. + +### Statistics exclude some types of commits + +The statistics exposed by the API match the statistics shown by [different repository graphs](/github/visualizing-repository-data-with-graphs/about-repository-graphs). + +To summarize: +- All statistics exclude merge commits. +- Contributor statistics also exclude empty commits. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/metrics/traffic.md b/translations/pt-BR/content/rest/metrics/traffic.md new file mode 100644 index 0000000000..9360f43231 --- /dev/null +++ b/translations/pt-BR/content/rest/metrics/traffic.md @@ -0,0 +1,12 @@ +--- +title: Traffic +intro: 'For repositories that you have push access to, the traffic API provides access to the information provided in your repository graph. ' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "Viewing traffic to a repository." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/migrations/index.md b/translations/pt-BR/content/rest/migrations/index.md new file mode 100644 index 0000000000..46ce2d736a --- /dev/null +++ b/translations/pt-BR/content/rest/migrations/index.md @@ -0,0 +1,21 @@ +--- +title: Migrations +intro: 'The Migration API lets you migrate the repositories and users of your organization from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.' +redirect_from: + - /v3/migrations + - /v3/migration + - /v3/migration/migrations + - /rest/reference/migrations +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /source-imports + - /users +--- diff --git a/translations/pt-BR/content/rest/migrations/orgs.md b/translations/pt-BR/content/rest/migrations/orgs.md new file mode 100644 index 0000000000..4ee5218d95 --- /dev/null +++ b/translations/pt-BR/content/rest/migrations/orgs.md @@ -0,0 +1,17 @@ +--- +title: Organization +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.organization_migrations_intro %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/migrations/source-imports.md b/translations/pt-BR/content/rest/migrations/source-imports.md new file mode 100644 index 0000000000..01bd775089 --- /dev/null +++ b/translations/pt-BR/content/rest/migrations/source-imports.md @@ -0,0 +1,87 @@ +--- +title: Source Imports +intro: '{% data variables.migrations.source_imports_intro %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) to find out the status of the import. + +A more detailed example can be seen in this diagram: + +``` ++---------+ +--------+ +---------------------+ +| Tooling | | GitHub | | Original Repository | ++---------+ +--------+ +---------------------+ + | | | + | Start import | | + |----------------------------->| | + | | | + | | Download source data | + | |--------------------------------------------->| + | | Begin streaming data | + | |<---------------------------------------------| + | | | + | Get import progress | | + |----------------------------->| | + | "status": "importing" | | + |<-----------------------------| | + | | | + | Get commit authors | | + |----------------------------->| | + | | | + | Map a commit author | | + |----------------------------->| | + | | | + | | | + | | Finish streaming data | + | |<---------------------------------------------| + | | | + | | Rewrite commits with mapped authors | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Map a commit author | | + |----------------------------->| | + | | Rewrite commits with mapped authors | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Get large files | | + |----------------------------->| | + | | | + | opt_in to Git LFS | | + |----------------------------->| | + | | Rewrite commits for large files | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Get import progress | | + |----------------------------->| | + | "status": "complete" | | + |<-----------------------------| | + | | | + | | | +``` \ No newline at end of file diff --git a/translations/pt-BR/content/rest/migrations/users.md b/translations/pt-BR/content/rest/migrations/users.md new file mode 100644 index 0000000000..185cc1a43e --- /dev/null +++ b/translations/pt-BR/content/rest/migrations/users.md @@ -0,0 +1,20 @@ +--- +title: Users +intro: 'The Users migrations API is only available to authenticated account owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.user_migrations_intro %} For a list of migration data that you can download, see "[Download a user migration archive](#download-a-user-migration-archive)." + +To download an archive, you'll need to start a user migration first. Once the status of the migration is `exported`, you can download the migration. + +Once you've created a migration archive, it will be available to download for seven days. But, you can delete the user migration archive sooner if you'd like. You can unlock your repository when the migration is `exported` to begin using your repository again or delete the repository if you no longer need the source data. diff --git a/translations/pt-BR/content/rest/oauth-authorizations.md b/translations/pt-BR/content/rest/oauth-authorizations.md new file mode 100644 index 0000000000..2f6e8fab75 --- /dev/null +++ b/translations/pt-BR/content/rest/oauth-authorizations.md @@ -0,0 +1,17 @@ +--- +title: OAuth Authorizations +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/oauth-authorizations +--- + +You can use this API to manage the access OAuth applications have to your account. You can only access this API via [Basic Authentication](/rest/overview/other-authentication-methods#basic-authentication) using your username and password, not tokens. + +If you or your users have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication). \ No newline at end of file diff --git a/translations/pt-BR/content/rest/orgs/blocking.md b/translations/pt-BR/content/rest/orgs/blocking.md new file mode 100644 index 0000000000..9e0982fa5d --- /dev/null +++ b/translations/pt-BR/content/rest/orgs/blocking.md @@ -0,0 +1,13 @@ +--- +title: Blocking users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +The token used to authenticate the call must have the `admin:org` scope in order to make any blocking calls for an organization. Otherwise, the response returns `HTTP 404`. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/orgs/custom-roles.md b/translations/pt-BR/content/rest/orgs/custom-roles.md new file mode 100644 index 0000000000..6944dff7d0 --- /dev/null +++ b/translations/pt-BR/content/rest/orgs/custom-roles.md @@ -0,0 +1,14 @@ +--- +title: Custom Repository Roles +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/orgs/custom_roles +--- diff --git a/translations/pt-BR/content/rest/orgs/index.md b/translations/pt-BR/content/rest/orgs/index.md new file mode 100644 index 0000000000..917eba0b84 --- /dev/null +++ b/translations/pt-BR/content/rest/orgs/index.md @@ -0,0 +1,23 @@ +--- +title: Organizations +intro: 'The Organizations API gives you access to control and manage all your {% data variables.product.product_name %} organizations.' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/orgs + - /rest/reference/orgs +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /blocking + - /custom-roles + - /members + - /outside-collaborators + - /webhooks +--- diff --git a/translations/pt-BR/content/rest/orgs/members.md b/translations/pt-BR/content/rest/orgs/members.md new file mode 100644 index 0000000000..40c46bda07 --- /dev/null +++ b/translations/pt-BR/content/rest/orgs/members.md @@ -0,0 +1,12 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/orgs/orgs.md b/translations/pt-BR/content/rest/orgs/orgs.md new file mode 100644 index 0000000000..d9d89ac9cb --- /dev/null +++ b/translations/pt-BR/content/rest/orgs/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/translations/pt-BR/content/rest/orgs/outside-collaborators.md b/translations/pt-BR/content/rest/orgs/outside-collaborators.md new file mode 100644 index 0000000000..8975f3a093 --- /dev/null +++ b/translations/pt-BR/content/rest/orgs/outside-collaborators.md @@ -0,0 +1,12 @@ +--- +title: Outside Collaborators +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/orgs/webhooks.md b/translations/pt-BR/content/rest/orgs/webhooks.md new file mode 100644 index 0000000000..97ae08ff1c --- /dev/null +++ b/translations/pt-BR/content/rest/orgs/webhooks.md @@ -0,0 +1,35 @@ +--- +title: Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in an organization. {% data reusables.webhooks.webhooks-rest-api-links %} + +For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)." + +### Scopes & Restrictions + +All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require the `admin:org_hook` scope. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." + +In order to protect sensitive data which may be present in webhook configurations, we also enforce the following access control rules: + +- OAuth applications cannot list, view, or edit webhooks which they did not create. +- Users cannot list, view, or edit webhooks which were created by OAuth applications. + +### Receiving Webhooks + +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +For more best practices, [see our guide](/guides/best-practices-for-integrators/). + +#### Webhook headers + +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/webhooks/event-payloads/#delivery-headers) for details. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/overview/api-previews.md b/translations/pt-BR/content/rest/overview/api-previews.md index c43360b191..899fc605d7 100644 --- a/translations/pt-BR/content/rest/overview/api-previews.md +++ b/translations/pt-BR/content/rest/overview/api-previews.md @@ -4,7 +4,7 @@ intro: Você pode usar pré-visualizações da API para testar novos recursos e redirect_from: - /v3/previews versions: - ghes: '*' + ghes: <3.4 ghae: '*' topics: - API @@ -47,14 +47,6 @@ Obter uma [lista de eventos](/rest/reference/issues#timeline) para um problema o {% endif %} -{% ifversion ghes %} -## Ambientes pre-receive - -Cria, lista, atualiza e exclui ambientes para hooks pre-receive. - -**Tipo de mídia personalizada:** `eye-scream-preview` **Anunciado em:** [2015-07-29](/rest/reference/enterprise-admin#pre-receive-environments) -{% endif %} - {% ifversion ghes < 3.3 %} ## Projetos @@ -88,7 +80,7 @@ Veja todos os [códigos de conduta](/rest/reference/codes-of-conduct) ou obtenha {% endif %} -{% ifversion ghae or ghes %} +{% ifversion ghes < 3.3 %} ## Webhooks globais diff --git a/translations/pt-BR/content/rest/overview/permissions-required-for-github-apps.md b/translations/pt-BR/content/rest/overview/permissions-required-for-github-apps.md index 6c734805da..91310ac947 100644 --- a/translations/pt-BR/content/rest/overview/permissions-required-for-github-apps.md +++ b/translations/pt-BR/content/rest/overview/permissions-required-for-github-apps.md @@ -909,7 +909,7 @@ _Equipes_ - [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (:write) {% endif %} -{% ifversion fpt or ghes > 3.0 or ghec %} +{% ifversion ghes > 3.0 or ghec %} ### Permissão em "alertas de varredura de segredo" - [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) diff --git a/translations/pt-BR/content/rest/packages.md b/translations/pt-BR/content/rest/packages.md new file mode 100644 index 0000000000..32204571ad --- /dev/null +++ b/translations/pt-BR/content/rest/packages.md @@ -0,0 +1,23 @@ +--- +title: Packages +intro: 'With the {% data variables.product.prodname_registry %} API, you can manage packages for your {% data variables.product.prodname_dotcom %} repositories and organizations.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/packages +--- + +The {% data variables.product.prodname_registry %} API enables you to manage packages using the REST API.{% ifversion fpt or ghec or ghes > 3.1 or ghae %} To learn more about restoring or deleting packages, see "[Restoring and deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)."{% endif %} + +To use this API, you must authenticate using a personal access token. + - To access package metadata, your token must include the `read:packages` scope. + - To delete packages and package versions, your token must include the `read:packages` and `delete:packages` scopes. + - To restore packages and package versions, your token must include the `read:packages` and `write:packages` scopes. + +If your `package_type` is `npm`, `maven`, `rubygems`, or `nuget`, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. If your package is in the {% data variables.product.prodname_container_registry %}, then your `package_type` is `container` and your token does not need the `repo` scope to access or manage this `package_type`. `container` packages offer granular permissions separate from a repository. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)." + +If you want to use the {% data variables.product.prodname_registry %} API to access resources in an organization with SSO enabled, then you must enable SSO for your personal access token. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} diff --git a/translations/pt-BR/content/rest/pages.md b/translations/pt-BR/content/rest/pages.md new file mode 100644 index 0000000000..2864c8aae6 --- /dev/null +++ b/translations/pt-BR/content/rest/pages.md @@ -0,0 +1,14 @@ +--- +title: Pages +intro: 'The GitHub Pages API allows you to interact with GitHub Pages sites and build information.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/pages +--- \ No newline at end of file diff --git a/translations/pt-BR/content/rest/projects/cards.md b/translations/pt-BR/content/rest/projects/cards.md new file mode 100644 index 0000000000..f92c719935 --- /dev/null +++ b/translations/pt-BR/content/rest/projects/cards.md @@ -0,0 +1,12 @@ +--- +title: Cards +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/projects/collaborators.md b/translations/pt-BR/content/rest/projects/collaborators.md new file mode 100644 index 0000000000..a68e1809bc --- /dev/null +++ b/translations/pt-BR/content/rest/projects/collaborators.md @@ -0,0 +1,13 @@ +--- +title: Collaborators +intro: "This API allows you to interact with an organization's projects." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/translations/pt-BR/content/rest/projects/columns.md b/translations/pt-BR/content/rest/projects/columns.md new file mode 100644 index 0000000000..e3c0985574 --- /dev/null +++ b/translations/pt-BR/content/rest/projects/columns.md @@ -0,0 +1,12 @@ +--- +title: Columns +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/projects/index.md b/translations/pt-BR/content/rest/projects/index.md new file mode 100644 index 0000000000..7afcf086c6 --- /dev/null +++ b/translations/pt-BR/content/rest/projects/index.md @@ -0,0 +1,20 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +redirect_from: + - /v3/projects + - /rest/reference/projects +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /projects + - /cards + - /collaborators + - /columns +--- diff --git a/translations/pt-BR/content/rest/projects/projects.md b/translations/pt-BR/content/rest/projects/projects.md new file mode 100644 index 0000000000..ff85668198 --- /dev/null +++ b/translations/pt-BR/content/rest/projects/projects.md @@ -0,0 +1,12 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/pt-BR/content/rest/pulls/comments.md b/translations/pt-BR/content/rest/pulls/comments.md new file mode 100644 index 0000000000..c18aa3d812 --- /dev/null +++ b/translations/pt-BR/content/rest/pulls/comments.md @@ -0,0 +1,26 @@ +--- +title: Review Comments +intro: 'Pull request review comments are comments on a portion of the unified diff made during a pull request review.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Commit comments and issue comments are different from pull request review comments. You apply commit comments directly to a commit and you apply issue comments without referencing a portion of the unified diff. For more information, see "[Create a commit comment](/rest/reference/commits#create-a-commit-comment)" and "[Create an issue comment](/rest/reference/issues#create-an-issue-comment)." + +### Custom media types for pull request review comments + +These are the supported media types for pull request review comments. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/pt-BR/content/rest/pulls/index.md b/translations/pt-BR/content/rest/pulls/index.md new file mode 100644 index 0000000000..17a7f54a5d --- /dev/null +++ b/translations/pt-BR/content/rest/pulls/index.md @@ -0,0 +1,20 @@ +--- +title: Pulls +intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' +redirect_from: + - /v3/pulls + - /rest/reference/pulls +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /pulls + - /comments + - /review-requests + - /reviews +--- diff --git a/translations/pt-BR/content/rest/pulls/pulls.md b/translations/pt-BR/content/rest/pulls/pulls.md new file mode 100644 index 0000000000..7e094d8d90 --- /dev/null +++ b/translations/pt-BR/content/rest/pulls/pulls.md @@ -0,0 +1,46 @@ +--- +title: Pulls +intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](/rest/reference/issues#comments). + +Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like manipulating assignees, labels and milestones, are provided within [the Issues API](/rest/reference/issues). + +### Custom media types for pull requests + +These are the supported media types for pull requests. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + application/vnd.github.VERSION.diff + application/vnd.github.VERSION.patch + +For more information, see "[Custom media types](/rest/overview/media-types)." + +If a diff is corrupt, contact {% data variables.contact.contact_support %}. Include the repository name and pull request ID in your message. + +### Link Relations + +Pull Requests have these possible link relations: + +Name | Description +-----|-----------| +`self`| The API location of this Pull Request. +`html`| The HTML location of this Pull Request. +`issue`| The API location of this Pull Request's [Issue](/rest/reference/issues). +`comments`| The API location of this Pull Request's [Issue comments](/rest/reference/issues#comments). +`review_comments`| The API location of this Pull Request's [Review comments](/rest/reference/pulls#comments). +`review_comment`| The [URL template](/rest#hypermedia) to construct the API location for a [Review comment](/rest/reference/pulls#comments) in this Pull Request's repository. +`commits`|The API location of this Pull Request's [commits](#list-commits-on-a-pull-request). +`statuses`| The API location of this Pull Request's [commit statuses](/rest/reference/commits#commit-statuses), which are the statuses of its `head` branch. diff --git a/translations/pt-BR/content/rest/pulls/review-requests.md b/translations/pt-BR/content/rest/pulls/review-requests.md new file mode 100644 index 0000000000..dc43b989bb --- /dev/null +++ b/translations/pt-BR/content/rest/pulls/review-requests.md @@ -0,0 +1,14 @@ +--- +title: Review Requests +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/pulls/reviews.md b/translations/pt-BR/content/rest/pulls/reviews.md new file mode 100644 index 0000000000..8912d09ecb --- /dev/null +++ b/translations/pt-BR/content/rest/pulls/reviews.md @@ -0,0 +1,13 @@ +--- +title: Reviews +intro: 'Pull Request Reviews are groups of Pull Request Review Comments on the Pull Request, grouped together with a state and optional body comment.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/translations/pt-BR/content/rest/rate-limit.md b/translations/pt-BR/content/rest/rate-limit.md new file mode 100644 index 0000000000..502ba87c86 --- /dev/null +++ b/translations/pt-BR/content/rest/rate-limit.md @@ -0,0 +1,33 @@ +--- +title: Rate limit +intro: 'With the Rate Limit API, you can check the current rate limit status of various REST APIs.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/rate-limit +--- + +The REST API overview documentation describes the [rate limit rules](/rest/overview/resources-in-the-rest-api#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below. + +### Understanding your rate limit status + +The Search API has a [custom rate limit](/rest/reference/search#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations#rate-limit) that is separate from and calculated differently than rate limits in the REST API. + +For these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four +objects: + +* The `core` object provides your rate limit status for all non-search-related resources in the REST API. + +* The `search` object provides your rate limit status for the [Search API](/rest/reference/search). + +* The `graphql` object provides your rate limit status for the [GraphQL API]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql). + +* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint. + +For more information on the headers and values in the rate limit response, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limit-http-headers)." diff --git a/translations/pt-BR/content/rest/reactions.md b/translations/pt-BR/content/rest/reactions.md new file mode 100644 index 0000000000..6ba29b6b1d --- /dev/null +++ b/translations/pt-BR/content/rest/reactions.md @@ -0,0 +1,20 @@ +--- +title: Reactions +intro: 'The Reactions API enables you to create, list and delete the reactions on comments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/reactions +--- + +### Reaction types + +When creating a reaction, the allowed values for the `content` parameter are as follows (with the corresponding emoji for reference): + +{% data reusables.repositories.reaction_list %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/reference/actions.md b/translations/pt-BR/content/rest/reference/actions.md deleted file mode 100644 index 691ef80d14..0000000000 --- a/translations/pt-BR/content/rest/reference/actions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Ações -intro: 'Com a API de ações, você pode gerenciar e controlar {% data variables.product.prodname_actions %} para uma organização ou repositório.' -redirect_from: - - /v3/actions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/activity.md b/translations/pt-BR/content/rest/reference/activity.md deleted file mode 100644 index 4cd50bbf17..0000000000 --- a/translations/pt-BR/content/rest/reference/activity.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Atividade -intro: 'A API de atividade permite que você liste eventos, alimenta e gerencia notificações, favoritos e inspeciona o usuário autenticado.' -redirect_from: - - /v3/activity -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/apps.md b/translations/pt-BR/content/rest/reference/apps.md deleted file mode 100644 index 4d7fcd8aa1..0000000000 --- a/translations/pt-BR/content/rest/reference/apps.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Aplicativos -intro: 'A API dos aplicativos GitHub permite que você recupere as informações sobre a instalação, bem como informações específicas sobre os aplicativos GitHub.' -redirect_from: - - /v3/apps -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/billing.md b/translations/pt-BR/content/rest/reference/billing.md deleted file mode 100644 index 9edb8371d6..0000000000 --- a/translations/pt-BR/content/rest/reference/billing.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Cobrança -intro: 'Com a API de cobrança você pode monitorar as cobranças e uso {% data variables.product.prodname_actions %} e {% data variables.product.prodname_registry %} para um usuário ou organização.' -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.4' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/branches.md b/translations/pt-BR/content/rest/reference/branches.md deleted file mode 100644 index 59241aa880..0000000000 --- a/translations/pt-BR/content/rest/reference/branches.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Branches -intro: A API de branches permite que você modifique os branches e as configurações de proteção. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/checks.md b/translations/pt-BR/content/rest/reference/checks.md deleted file mode 100644 index 0188f9d766..0000000000 --- a/translations/pt-BR/content/rest/reference/checks.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Verificações -intro: 'Com a API de verificações, você pode criar {% data variables.product.prodname_github_apps %} que executa verificações poderosas para as alterações de código em um repositório.' -redirect_from: - - /v3/checks -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/code-scanning.md b/translations/pt-BR/content/rest/reference/code-scanning.md deleted file mode 100644 index 50021c48d5..0000000000 --- a/translations/pt-BR/content/rest/reference/code-scanning.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Varredura de código -intro: A API de digitalização de código permite recuperar e atualizar os alertas de verificação de código e análises de um repositório. -redirect_from: - - /v3/code-scanning -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: reference -topics: - - API - - Code scanning - - REST -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/codes-of-conduct.md b/translations/pt-BR/content/rest/reference/codes-of-conduct.md deleted file mode 100644 index 1b2304f094..0000000000 --- a/translations/pt-BR/content/rest/reference/codes-of-conduct.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Códigos de conduta -intro: O código de conduta da API permite que você recupere as informações sobre o código de conduta de um repositório em particular. -redirect_from: - - /v3/codes_of_conduct - - /v3/codes-of-conduct -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/codespaces.md b/translations/pt-BR/content/rest/reference/codespaces.md deleted file mode 100644 index 2db1a5092f..0000000000 --- a/translations/pt-BR/content/rest/reference/codespaces.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Codespaces -intro: 'A API de {% data variables.product.prodname_codespaces %} permite que você gerencie seus codespaces usando a API REST.' -product: '{% data reusables.gated-features.codespaces %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/collaborators.md b/translations/pt-BR/content/rest/reference/collaborators.md deleted file mode 100644 index dd57a139e3..0000000000 --- a/translations/pt-BR/content/rest/reference/collaborators.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Colaboradores -intro: 'A API dos colaboradores permite que você adicione, convide e remova os colaboradores de um repositório.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/commits.md b/translations/pt-BR/content/rest/reference/commits.md deleted file mode 100644 index 2420044d34..0000000000 --- a/translations/pt-BR/content/rest/reference/commits.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Commits -intro: 'A API de commits permite que você liste, visualize e compare commits em um repositório. Você também pode interagir com os comentários do commit e com os status do commit.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/dependabot.md b/translations/pt-BR/content/rest/reference/dependabot.md deleted file mode 100644 index c04bd78881..0000000000 --- a/translations/pt-BR/content/rest/reference/dependabot.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Dependabot -intro: 'Com a API de segredos do {% data variables.product.prodname_dependabot %}, você pode gerenciar e controlar segredos de {% data variables.product.prodname_dependabot %} para uma organização ou repositório.' -versions: - fpt: '*' - ghes: '>=3.4' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/deploy_keys.md b/translations/pt-BR/content/rest/reference/deploy_keys.md deleted file mode 100644 index 03aca4d663..0000000000 --- a/translations/pt-BR/content/rest/reference/deploy_keys.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Chave de implantação -intro: A API das chaves de implantação permite criar uma chave de SSH que é armazenada no seu servidor e permite acesso a um repositório do GitHub. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/deployments.md b/translations/pt-BR/content/rest/reference/deployments.md deleted file mode 100644 index 4a1aaf921c..0000000000 --- a/translations/pt-BR/content/rest/reference/deployments.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Implantações -intro: A API de implantações permite que você crie e exclua implantações e ambientes de implantação. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/emojis.md b/translations/pt-BR/content/rest/reference/emojis.md deleted file mode 100644 index be8029dfda..0000000000 --- a/translations/pt-BR/content/rest/reference/emojis.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Emojis -intro: 'Com a API de Emojis, você pode listar e visualizar todos os emojis disponíveis para uso em {% data variables.product.product_name %}.' -redirect_from: - - /v3/emojis - - /v3/misc -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/enterprise-admin.md b/translations/pt-BR/content/rest/reference/enterprise-admin.md deleted file mode 100644 index c68a10d42d..0000000000 --- a/translations/pt-BR/content/rest/reference/enterprise-admin.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: GitHub Enterprise administration -intro: You can use these endpoints to administer your enterprise. -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/enterprise-admin - - /v3/enterprise -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 -shortTitle: Enterprise administration ---- - - diff --git a/translations/pt-BR/content/rest/reference/git.md b/translations/pt-BR/content/rest/reference/git.md deleted file mode 100644 index 1be4a836b9..0000000000 --- a/translations/pt-BR/content/rest/reference/git.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Banco de dados do Git -intro: 'A API de banco de dados do Git permite ler e escrever objetos do Git não processados no seu banco de dados do Git em {% data variables.product.product_name %} e anunciar e atualizar referências do Git (cabeçalhos de branch e tags).' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/git -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/gitignore.md b/translations/pt-BR/content/rest/reference/gitignore.md deleted file mode 100644 index 2e14f392e1..0000000000 --- a/translations/pt-BR/content/rest/reference/gitignore.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Gitignore -intro: A API do Gitignore busca modelos `.gitignore` que podem ser usados para ignorar arquivos e diretórios. -redirect_from: - - /v3/gitignore -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/index.md b/translations/pt-BR/content/rest/reference/index.md deleted file mode 100644 index 76295a03d3..0000000000 --- a/translations/pt-BR/content/rest/reference/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Referência -shortTitle: Referência -intro: Veja documentação de referência para aprender os recursos disponíveis na API REST do GitHub. -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -children: - - /actions - - /activity - - /apps - - /billing - - /branches - - /checks - - /codes-of-conduct - - /code-scanning - - /codespaces - - /collaborators - - /commits - - /dependabot - - /dependency-graph - - /deploy_keys - - /deployments - - /emojis - - /enterprise-admin - - /gists - - /git - - /gitignore - - /interactions - - /issues - - /licenses - - /markdown - - /meta - - /metrics - - /migrations - - /oauth-authorizations - - /orgs - - /packages - - /pages - - /projects - - /pulls - - /rate-limit - - /reactions - - /releases - - /repos - - /scim - - /search - - /secret-scanning - - /teams - - /users - - /webhooks ---- - diff --git a/translations/pt-BR/content/rest/reference/interactions.md b/translations/pt-BR/content/rest/reference/interactions.md deleted file mode 100644 index 69705267a6..0000000000 --- a/translations/pt-BR/content/rest/reference/interactions.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Interações -intro: 'Com a API de interações, as pessoas com acesso de proprietário ou administrador podem definir o limite de interação para os usuários nas suas organizações e repositórios.' -redirect_from: - - /v3/interactions -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/issues.md b/translations/pt-BR/content/rest/reference/issues.md deleted file mode 100644 index 38a3571f1a..0000000000 --- a/translations/pt-BR/content/rest/reference/issues.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Problemas -intro: 'A API de Problemas permite que você visualize e gerencie problemas, incluindo responsáveis de problemas, comentários, etiquetas e marcos.' -redirect_from: - - /v3/issues -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/licenses.md b/translations/pt-BR/content/rest/reference/licenses.md deleted file mode 100644 index 770a3d97c2..0000000000 --- a/translations/pt-BR/content/rest/reference/licenses.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Licenças -intro: A API de Licenças permite recuperar as licenças populares de código aberto e informações sobre o arquivo de licença do projeto em particular. -redirect_from: - - /v3/licenses -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/markdown.md b/translations/pt-BR/content/rest/reference/markdown.md deleted file mode 100644 index 963b93f428..0000000000 --- a/translations/pt-BR/content/rest/reference/markdown.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: markdown -intro: A API de Markdown permite que você interprete um documento de markdown como uma página HTML ou como texto não processado. -redirect_from: - - /v3/markdown -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/meta.md b/translations/pt-BR/content/rest/reference/meta.md deleted file mode 100644 index fc77dde138..0000000000 --- a/translations/pt-BR/content/rest/reference/meta.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Meta -intro: 'A API de Meta retorna meta informações sobre {% data variables.product.product_name %} incluindo o endereço IP dos serviços de {% data variables.product.product_name %}.' -redirect_from: - - /v3/meta -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/metrics.md b/translations/pt-BR/content/rest/reference/metrics.md deleted file mode 100644 index 325b7baff4..0000000000 --- a/translations/pt-BR/content/rest/reference/metrics.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Métricas -intro: 'A API de métricas do repositório permite que você recupere o perfil da comunidade, estatísticas e tráfego para seu repositório.' -allowTitleToDifferFromFilename: true -redirect_from: - - /rest/reference/repository-metrics -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/migrations.md b/translations/pt-BR/content/rest/reference/migrations.md deleted file mode 100644 index 6c1fd90fe8..0000000000 --- a/translations/pt-BR/content/rest/reference/migrations.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Migrações -intro: 'A API de migração permite que você faça a migração dos repositórios e usuários da sua organização de {% data variables.product.prodname_dotcom_the_website %} para {% data variables.product.prodname_ghe_server %}.' -redirect_from: - - /v3/migrations - - /v3/migration - - /v3/migration/migrations -versions: - fpt: '*' - ghec: '*' - ghes: '>3.3' - ghae: issue-6184 -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/oauth-authorizations.md b/translations/pt-BR/content/rest/reference/oauth-authorizations.md deleted file mode 100644 index 270e607c92..0000000000 --- a/translations/pt-BR/content/rest/reference/oauth-authorizations.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Autorizações do OAuth -redirect_from: - - /v3/oauth_authorizations - - /v3/oauth-authorizations -versions: - ghes: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/orgs.md b/translations/pt-BR/content/rest/reference/orgs.md deleted file mode 100644 index d7b3719e77..0000000000 --- a/translations/pt-BR/content/rest/reference/orgs.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Organizações -intro: 'A API de organizações concede acesso para controlar e gerenciar todas as suas organizações de {% data variables.product.product_name %}.' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/orgs -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/packages.md b/translations/pt-BR/content/rest/reference/packages.md deleted file mode 100644 index 8337307add..0000000000 --- a/translations/pt-BR/content/rest/reference/packages.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Packages -intro: 'Com a API do {% data variables.product.prodname_registry %}, você pode gerenciar pacotes para seus repositórios e organizações de {% data variables.product.prodname_dotcom %}.' -product: '{% data reusables.gated-features.packages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/pages.md b/translations/pt-BR/content/rest/reference/pages.md deleted file mode 100644 index a5aad5c76a..0000000000 --- a/translations/pt-BR/content/rest/reference/pages.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Pages -intro: A API do GitHub Pages permite que você interaja com sites do GitHub Pages e crie informações. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/projects.md b/translations/pt-BR/content/rest/reference/projects.md deleted file mode 100644 index 9b23ff6c0f..0000000000 --- a/translations/pt-BR/content/rest/reference/projects.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Projetos -intro: 'A API dos Projetos permite que você crie, liste, atualize, exclua e personalize projetos em um repositório.' -redirect_from: - - /v3/projects -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/pulls.md b/translations/pt-BR/content/rest/reference/pulls.md deleted file mode 100644 index 336753c633..0000000000 --- a/translations/pt-BR/content/rest/reference/pulls.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Pulls -intro: 'A API Pulls permite que você liste, veja, edite, crie e até mesmo faça merge de pull requests.' -redirect_from: - - /v3/pulls -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/rate-limit.md b/translations/pt-BR/content/rest/reference/rate-limit.md deleted file mode 100644 index 876a13775e..0000000000 --- a/translations/pt-BR/content/rest/reference/rate-limit.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Limite de taxa -intro: 'Com a API de limite de taxa, você pode verificar o status atual da taxa limite de várias APIs REST.' -redirect_from: - - /v3/rate_limit - - /v3/rate-limit -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/reactions.md b/translations/pt-BR/content/rest/reference/reactions.md deleted file mode 100644 index 144bab4499..0000000000 --- a/translations/pt-BR/content/rest/reference/reactions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Reações -intro: 'A API de Reações permite que você crie, liste e exclua as reações nos comentários.' -redirect_from: - - /v3/reactions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/releases.md b/translations/pt-BR/content/rest/reference/releases.md deleted file mode 100644 index bdd25fffcf..0000000000 --- a/translations/pt-BR/content/rest/reference/releases.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Versões -intro: 'A API de versões permite que você crie, modifique e exclua versões e ativos de versões.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/scim.md b/translations/pt-BR/content/rest/reference/scim.md deleted file mode 100644 index beab0ce904..0000000000 --- a/translations/pt-BR/content/rest/reference/scim.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: SCIM -intro: 'Você pode controlar e gerenciar seu acesso dos integrantes de {% data variables.product.product_name %} da organização usando a API SCIM.' -redirect_from: - - /v3/scim -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/search.md b/translations/pt-BR/content/rest/reference/search.md deleted file mode 100644 index 7c65683cee..0000000000 --- a/translations/pt-BR/content/rest/reference/search.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Pesquisar -intro: 'A API de pesquisa de {% data variables.product.product_name %} permite que você procure o item específico de forma eficiente.' -redirect_from: - - /v3/search -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/secret-scanning.md b/translations/pt-BR/content/rest/reference/secret-scanning.md deleted file mode 100644 index cb5b1f5801..0000000000 --- a/translations/pt-BR/content/rest/reference/secret-scanning.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Varredura secreta -intro: Use a API a digitalização de segredo para recuperar e atualizar alertas de segredos de um repositório. -versions: - fpt: '*' - ghes: '*' - ghec: '*' - ghae: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/teams.md b/translations/pt-BR/content/rest/reference/teams.md deleted file mode 100644 index 037c457dae..0000000000 --- a/translations/pt-BR/content/rest/reference/teams.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Equipes -intro: 'Com a API de Equipes, você pode criar e gerenciar equipes na sua organização {% data variables.product.product_name %}.' -redirect_from: - - /v3/teams -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/users.md b/translations/pt-BR/content/rest/reference/users.md deleted file mode 100644 index 724375934b..0000000000 --- a/translations/pt-BR/content/rest/reference/users.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Usuários -intro: A API de Usuários permite obter informações públicas e privadas sobre o usuário autenticado. -redirect_from: - - /v3/users -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/reference/webhooks.md b/translations/pt-BR/content/rest/reference/webhooks.md deleted file mode 100644 index d7d2a3911c..0000000000 --- a/translations/pt-BR/content/rest/reference/webhooks.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Webhooks -intro: A API de webhooks permite que você crie e gerencie webhooks para seus repositórios. -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/pt-BR/content/rest/releases/assets.md b/translations/pt-BR/content/rest/releases/assets.md new file mode 100644 index 0000000000..44956c13a1 --- /dev/null +++ b/translations/pt-BR/content/rest/releases/assets.md @@ -0,0 +1,13 @@ +--- +title: Release Assets +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/releases/index.md b/translations/pt-BR/content/rest/releases/index.md new file mode 100644 index 0000000000..c3447b9110 --- /dev/null +++ b/translations/pt-BR/content/rest/releases/index.md @@ -0,0 +1,18 @@ +--- +title: Releases +intro: 'The releases API allows you to create, modify, and delete releases and release assets.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /releases + - /assets +redirect_from: + - /rest/reference/releases +--- diff --git a/translations/pt-BR/content/rest/releases/releases.md b/translations/pt-BR/content/rest/releases/releases.md new file mode 100644 index 0000000000..fa1cb398fc --- /dev/null +++ b/translations/pt-BR/content/rest/releases/releases.md @@ -0,0 +1,19 @@ +--- +title: Releases +intro: 'The Releases API allows you to create, modify, and delete releases and release assets. +' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% note %} + +**Note:** The Releases API replaces the Downloads API. You can retrieve the download count and browser download URL from the endpoints in this API that return releases and release assets. + +{% endnote %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/repos/autolinks.md b/translations/pt-BR/content/rest/repos/autolinks.md new file mode 100644 index 0000000000..ba9b5afafd --- /dev/null +++ b/translations/pt-BR/content/rest/repos/autolinks.md @@ -0,0 +1,16 @@ +--- +title: Autolinks +intro: 'To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets.' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." + +{% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/repos/contents.md b/translations/pt-BR/content/rest/repos/contents.md new file mode 100644 index 0000000000..a402506eeb --- /dev/null +++ b/translations/pt-BR/content/rest/repos/contents.md @@ -0,0 +1,34 @@ +--- +title: Contents +intro: 'These API endpoints let you create, modify, and delete Base64 encoded content in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +To request the raw format or rendered HTML (when supported), use custom media types for repository contents. + +### Custom media types for repository contents + +[READMEs](/rest/reference/repos#get-a-repository-readme), [files](/rest/reference/repos#get-repository-content), and [symlinks](/rest/reference/repos#get-repository-content) support the following custom media types: + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.html + +Use the `.raw` media type to retrieve the contents of the file. + +For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). + +[All objects](/rest/reference/repos#get-repository-content) support the following custom media type: + + application/vnd.github.VERSION.object + +Use the `object` media type parameter to retrieve the contents in a consistent object format regardless of the content type. For example, instead of an array of objects +for a directory, the response will be an object with an `entries` attribute containing the array of objects. + +You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/translations/pt-BR/content/rest/repos/forks.md b/translations/pt-BR/content/rest/repos/forks.md new file mode 100644 index 0000000000..5a7928f9aa --- /dev/null +++ b/translations/pt-BR/content/rest/repos/forks.md @@ -0,0 +1,12 @@ +--- +title: Forks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/repos/index.md b/translations/pt-BR/content/rest/repos/index.md new file mode 100644 index 0000000000..7232e7da73 --- /dev/null +++ b/translations/pt-BR/content/rest/repos/index.md @@ -0,0 +1,23 @@ +--- +title: Repositories +intro: 'The Repos API allows to create, manage and control the workflow of public and private {% data variables.product.product_name %} repositories.' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/repos + - /rest/reference/repos +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /repos + - /autolinks + - /contents + - /forks + - /lfs + - /tags +--- diff --git a/translations/pt-BR/content/rest/repos/lfs.md b/translations/pt-BR/content/rest/repos/lfs.md new file mode 100644 index 0000000000..3b11137030 --- /dev/null +++ b/translations/pt-BR/content/rest/repos/lfs.md @@ -0,0 +1,13 @@ +--- +title: Git LFS +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/repos/repos.md b/translations/pt-BR/content/rest/repos/repos.md new file mode 100644 index 0000000000..8941c62602 --- /dev/null +++ b/translations/pt-BR/content/rest/repos/repos.md @@ -0,0 +1,13 @@ +--- +title: Repositories +intro: 'The Repos API allows to create, manage and control the workflow of public and private GitHub Enterprise Server repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/repos/tags.md b/translations/pt-BR/content/rest/repos/tags.md new file mode 100644 index 0000000000..7685300da2 --- /dev/null +++ b/translations/pt-BR/content/rest/repos/tags.md @@ -0,0 +1,10 @@ +--- +title: Tags +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/pt-BR/content/rest/scim.md b/translations/pt-BR/content/rest/scim.md new file mode 100644 index 0000000000..8f63ea1bb9 --- /dev/null +++ b/translations/pt-BR/content/rest/scim.md @@ -0,0 +1,54 @@ +--- +title: SCIM +intro: 'You can control and manage your GitHub organization members access using SCIM API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/scim +--- + +### SCIM Provisioning for Organizations + +The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.product_name %} organization membership. The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). The {% data variables.product.product_name %} SCIM endpoint that an IdP should use is: `{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`. + +{% note %} + +**Notes:** + - The SCIM API is available only to organizations on [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. {% data reusables.scim.enterprise-account-scim %} For more information about SCIM, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." + - The SCIM API cannot be used with {% data variables.product.prodname_emus %}. + +{% endnote %} + +### Authenticating calls to the SCIM API + +You must authenticate as an owner of a {% data variables.product.product_name %} organization to use its SCIM API. The API expects an [OAuth 2.0 Bearer](/developers/apps/authenticating-with-github-apps) token to be included in the `Authorization` header. You may also use a personal access token, but you must first [authorize it for use with your SAML SSO organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). + +### Mapping of SAML and SCIM data + +{% data reusables.scim.nameid-and-username-must-match %} + +### Supported SCIM User attributes + +Name | Type | Description +-----|------|-------------- +`userName`|`string` | The username for the user. +`name.givenName`|`string` | The first name of the user. +`name.familyName`|`string` | The last name of the user. +`emails` | `array` | List of user emails. +`externalId` | `string` | This identifier is generated by the SAML provider, and is used as a unique ID by the SAML provider to match against a GitHub user. You can find the `externalID` for a user either at the SAML provider, or using the [List SCIM provisioned identities](#list-scim-provisioned-identities) endpoint and filtering on other known attributes, such as a user's GitHub username or email address. +`id` | `string` | Identifier generated by the GitHub SCIM endpoint. +`active` | `boolean` | Used to indicate whether the identity is active (true) or should be deprovisioned (false). + +{% note %} + +**Note:** Endpoint URLs for the SCIM API are case sensitive. For example, the first letter in the `Users` endpoint must be capitalized: + +```shell +GET /scim/v2/organizations/{org}/Users/{scim_user_id} +``` + +{% endnote %} diff --git a/translations/pt-BR/content/rest/search.md b/translations/pt-BR/content/rest/search.md new file mode 100644 index 0000000000..a463da9363 --- /dev/null +++ b/translations/pt-BR/content/rest/search.md @@ -0,0 +1,175 @@ +--- +title: Search +intro: 'The GitHub Search API lets you to search for the specific item efficiently.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/search +--- + +The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. + +You can narrow your search using queries. To learn more about the search query syntax, see "[Constructing a search query](/rest/reference/search#constructing-a-search-query)." + +### Ranking search results + +Unless another sort option is provided as a query parameter, results are sorted by best match in descending order. Multiple factors are combined to boost the most relevant item to the top of the result list. + +### Rate limit + +{% data reusables.enterprise.rate_limit %} + +The Search API has a custom rate limit. For requests using [Basic +Authentication](/rest#authentication), [OAuth](/rest#authentication), or [client +ID and secret](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to +30 requests per minute. For unauthenticated requests, the rate limit allows you +to make up to 10 requests per minute. + +See the [rate limit documentation](/rest/reference/rate-limit) for details on +determining your current rate limit status. + +### Constructing a search query + +Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoint in the Search API for an example that includes the endpoint and query parameters. + +A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: + +``` +SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N +``` + +For example, if you wanted to search for all _repositories_ owned by `defunkt` that +contained the word `GitHub` and `Octocat` in the README file, you would use the +following query with the _search repositories_ endpoint: + +``` +GitHub Octocat in:readme user:defunkt +``` + +**Note:** Be sure to use your language's preferred HTML-encoder to construct your query strings. For example: +```javascript +// JavaScript +const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); +``` + +See "[Searching on GitHub](/search-github/searching-on-github)" +for a complete list of available qualifiers, their format, and an example of +how to use them. For information about how to use operators to match specific +quantities, dates, or to exclude results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)." + +### Limitations on query length + +The Search API does not support queries that: +- are longer than 256 characters (not including operators or qualifiers). +- have more than five `AND`, `OR`, or `NOT` operators. + +These search queries will return a "Validation failed" error message. + +### Timeouts and incomplete results + +To keep the Search API fast for everyone, we limit how long any individual query +can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), +the API returns the matches that were already found prior to the timeout, and +the response has the `incomplete_results` property set to `true`. + +Reaching a timeout does not necessarily mean that search results are incomplete. +More results might have been found, but also might not. + +### Access errors or missing search results + +You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a `422 Unprocessable Entry` error with a "Validation Failed" message. For example, your search will fail if your query includes `repo:`, `user:`, or `org:` qualifiers that request resources that you don't have access to when you sign in on {% data variables.product.prodname_dotcom %}. + +When your search query requests multiple resources, the response will only contain the resources that you have access to and will **not** provide an error message listing the resources that were not returned. + +For example, if your search query searches for the `octocat/test` and `codertocat/test` repositories, but you only have access to `octocat/test`, your response will show search results for `octocat/test` and nothing for `codertocat/test`. This behavior mimics how search works on {% data variables.product.prodname_dotcom %}. + +### Text match metadata + +On GitHub, you can use the context provided by code snippets and highlights in search results. The Search API offers additional metadata that allows you to highlight the matching search terms when displaying search results. + +![code-snippet-highlighting](/assets/images/text-match-search-api.png) + +Requests can opt to receive those text fragments in the response, and every fragment is accompanied by numeric offsets identifying the exact location of each matching search term. + +To get this metadata in your search results, specify the `text-match` media type in your `Accept` header. + +```shell +application/vnd.github.v3.text-match+json +``` + +When you provide the `text-match` media type, you will receive an extra key in the JSON payload called `text_matches` that provides information about the position of your search terms within the text and the `property` that includes the search term. Inside the `text_matches` array, each object includes +the following attributes: + +Name | Description +-----|-----------| +`object_url` | The URL for the resource that contains a string property matching one of the search terms. +`object_type` | The name for the type of resource that exists at the given `object_url`. +`property` | The name of a property of the resource that exists at `object_url`. That property is a string that matches one of the search terms. (In the JSON returned from `object_url`, the full content for the `fragment` will be found in the property with this name.) +`fragment` | A subset of the value of `property`. This is the text fragment that matches one or more of the search terms. +`matches` | An array of one or more search terms that are present in `fragment`. The indices (i.e., "offsets") are relative to the fragment. (They are not relative to the _full_ content of `property`.) + +#### Example + +Using cURL, and the [example issue search](#search-issues-and-pull-requests) above, our API +request would look like this: + +``` shell +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ +'{% data variables.product.api_url_pre %}/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' +``` + +The response will include a `text_matches` array for each search result. In the JSON below, we have two objects in the `text_matches` array. + +The first text match occurred in the `body` property of the issue. We see a fragment of text from the issue body. The search term (`windows`) appears twice within that fragment, and we have the indices for each occurrence. + +The second text match occurred in the `body` property of one of the issue's comments. We have the URL for the issue comment. And of course, we see a fragment of text from the comment body. The search term (`windows`) appears once within that fragment. + +```json +{ + "text_matches": [ + { + "object_url": "https://api.github.com/repositories/215335/issues/132", + "object_type": "Issue", + "property": "body", + "fragment": "comprehensive windows font I know of).\n\nIf we can find a commonly distributed windows font that supports them then no problem (we can use html font tags) but otherwise the '(21)' style is probably better.\n", + "matches": [ + { + "text": "windows", + "indices": [ + 14, + 21 + ] + }, + { + "text": "windows", + "indices": [ + 78, + 85 + ] + } + ] + }, + { + "object_url": "https://api.github.com/repositories/215335/issues/comments/25688", + "object_type": "IssueComment", + "property": "body", + "fragment": " right after that are a bit broken IMHO :). I suppose we could have some hack that maxes out at whatever the font does...\n\nI'll check what the state of play is on Windows.\n", + "matches": [ + { + "text": "Windows", + "indices": [ + 163, + 170 + ] + } + ] + } + ] +} +``` diff --git a/translations/pt-BR/content/rest/secret-scanning.md b/translations/pt-BR/content/rest/secret-scanning.md new file mode 100644 index 0000000000..fad846994e --- /dev/null +++ b/translations/pt-BR/content/rest/secret-scanning.md @@ -0,0 +1,23 @@ +--- +title: Secret Scanning +intro: 'Use the Secret Scanning API to retrieve and update secret alerts from a repository.' +versions: + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/secret-scanning +--- + +{% data reusables.secret-scanning.api-beta %} + +The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae %}: + +- Enable or disable {% data variables.product.prodname_secret_scanning %}{% if secret-scanning-push-protection %} and push protection{% endif %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" and expand the "Properties of the `security_and_analysis` object" section in the REST API documentation. +- Retrieve and update {% data variables.product.prodname_secret_scanning_GHAS %} alerts from a repository. For further details, see the sections below. +{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a repository.{% endif %} + +For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." diff --git a/translations/pt-BR/content/rest/teams/discussion-comments.md b/translations/pt-BR/content/rest/teams/discussion-comments.md new file mode 100644 index 0000000000..0dde5647e0 --- /dev/null +++ b/translations/pt-BR/content/rest/teams/discussion-comments.md @@ -0,0 +1,14 @@ +--- +title: Discussion Comments +intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/teams/discussions.md b/translations/pt-BR/content/rest/teams/discussions.md new file mode 100644 index 0000000000..1a6cc51805 --- /dev/null +++ b/translations/pt-BR/content/rest/teams/discussions.md @@ -0,0 +1,14 @@ +--- +title: Discussions +intro: "The Team Discussions API allows you to get, create, edit, and delete discussion posts on a team's page." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/teams/external-groups.md b/translations/pt-BR/content/rest/teams/external-groups.md new file mode 100644 index 0000000000..ab172bd084 --- /dev/null +++ b/translations/pt-BR/content/rest/teams/external-groups.md @@ -0,0 +1,24 @@ +--- +title: External Groups +intro: 'The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.' +versions: + fpt: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. + +{% ifversion ghec %} +{% note %} + +**Notes:** + +- The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." +- If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/teams/index.md b/translations/pt-BR/content/rest/teams/index.md new file mode 100644 index 0000000000..fc2c3a44cb --- /dev/null +++ b/translations/pt-BR/content/rest/teams/index.md @@ -0,0 +1,22 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your {% data variables.product.product_name %} organization.' +redirect_from: + - /v3/teams + - /rest/reference/teams +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /teams + - /discussion-comments + - /discussions + - /external-groups + - /members + - /team-sync +--- diff --git a/translations/pt-BR/content/rest/teams/members.md b/translations/pt-BR/content/rest/teams/members.md new file mode 100644 index 0000000000..fdcee06601 --- /dev/null +++ b/translations/pt-BR/content/rest/teams/members.md @@ -0,0 +1,23 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + +{% ifversion fpt or ghes or ghec %} +{% note %} + +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% endnote %} + +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/teams/team-sync.md b/translations/pt-BR/content/rest/teams/team-sync.md new file mode 100644 index 0000000000..3b6dfa15dd --- /dev/null +++ b/translations/pt-BR/content/rest/teams/team-sync.md @@ -0,0 +1,21 @@ +--- +title: Team Synchronization +intro: 'The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." + +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% note %} + +**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". + +{% endnote %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/teams/teams.md b/translations/pt-BR/content/rest/teams/teams.md new file mode 100644 index 0000000000..fa741a215e --- /dev/null +++ b/translations/pt-BR/content/rest/teams/teams.md @@ -0,0 +1,14 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your GitHub organization.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. diff --git a/translations/pt-BR/content/rest/users/blocking.md b/translations/pt-BR/content/rest/users/blocking.md new file mode 100644 index 0000000000..297347554f --- /dev/null +++ b/translations/pt-BR/content/rest/users/blocking.md @@ -0,0 +1,11 @@ +--- +title: Blocking Users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/users/emails.md b/translations/pt-BR/content/rest/users/emails.md new file mode 100644 index 0000000000..1526e6e0a6 --- /dev/null +++ b/translations/pt-BR/content/rest/users/emails.md @@ -0,0 +1,13 @@ +--- +title: Emails +intro: '' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Management of email addresses via the API requires that you authenticate through basic auth, or through OAuth with a correct scope for the endpoint. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/users/followers.md b/translations/pt-BR/content/rest/users/followers.md new file mode 100644 index 0000000000..b93b9303cd --- /dev/null +++ b/translations/pt-BR/content/rest/users/followers.md @@ -0,0 +1,12 @@ +--- +title: Followers +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/pt-BR/content/rest/users/gpg-keys.md b/translations/pt-BR/content/rest/users/gpg-keys.md new file mode 100644 index 0000000000..8cc12ab55d --- /dev/null +++ b/translations/pt-BR/content/rest/users/gpg-keys.md @@ -0,0 +1,14 @@ +--- +title: GPG Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The data returned in the `public_key` response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what is returned by the APIs on this page. This key is not suitable to be used directly by programs like GPG. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/users/index.md b/translations/pt-BR/content/rest/users/index.md new file mode 100644 index 0000000000..22145785f5 --- /dev/null +++ b/translations/pt-BR/content/rest/users/index.md @@ -0,0 +1,22 @@ +--- +title: Users +intro: The Users API allows to get public and private information about the authenticated user. +redirect_from: + - /v3/users + - /rest/reference/users +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /users + - /blocking + - /emails + - /followers + - /gpg-keys + - /keys +--- diff --git a/translations/pt-BR/content/rest/users/keys.md b/translations/pt-BR/content/rest/users/keys.md new file mode 100644 index 0000000000..ac61f9554f --- /dev/null +++ b/translations/pt-BR/content/rest/users/keys.md @@ -0,0 +1,13 @@ +--- +title: Git SSH Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/translations/pt-BR/content/rest/users/users.md b/translations/pt-BR/content/rest/users/users.md new file mode 100644 index 0000000000..e299587e74 --- /dev/null +++ b/translations/pt-BR/content/rest/users/users.md @@ -0,0 +1,14 @@ +--- +title: Users +intro: 'The Users API allows to get public and private information about the authenticated user.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a `{username}` parameter then the response will be for the logged in user (and you must pass [authentication information](/rest/overview/resources-in-the-rest-api#authentication) with your request).{% ifversion fpt or ghes or ghec %} Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the `user` scope.{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/content/rest/webhooks/index.md b/translations/pt-BR/content/rest/webhooks/index.md new file mode 100644 index 0000000000..fb833f3c0b --- /dev/null +++ b/translations/pt-BR/content/rest/webhooks/index.md @@ -0,0 +1,79 @@ +--- +title: Webhooks +intro: The webhooks API allows you to create and manage webhooks for your repositories. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /repo-config + - /repo-deliveries + - /repos +redirect_from: + - /rest/reference/webhooks +--- + +Repository webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in a repository. {% data reusables.webhooks.webhooks-rest-api-links %} + +If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks). + +In addition to the REST API, {% data variables.product.prodname_dotcom %} can also serve as a [PubSubHubbub](#pubsubhubbub) hub for repositories. + +## Receiving Webhooks + +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +### Webhook headers + +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers) for details. + +## PubSubHubbub + +GitHub can also serve as a [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) hub for all repositories. PSHB is a simple publish/subscribe protocol that lets servers register to receive updates when a topic is updated. The updates are sent with an HTTP POST request to a callback URL. +Topic URLs for a GitHub repository's pushes are in this format: + +`https://github.com/{owner}/{repo}/events/{event}` + +The event can be any available webhook event. For more information, see "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads)." + +### Response format + +The default format is what [existing post-receive hooks should expect](/post-receive-hooks/): A JSON body sent as the `payload` parameter in a POST. You can also specify to receive the raw JSON body with either an `Accept` header, or a `.json` extension. + + Accept: application/json + https://github.com/{owner}/{repo}/events/push.json + +### Callback URLs + +Callback URLs can use the `http://` protocol. + + # Send updates to postbin.org + http://postbin.org/123 + +### Subscribing + +The GitHub PubSubHubbub endpoint is: `{% data variables.product.api_url_code %}/hub`. A successful request with curl looks like: + +``` shell +curl -u "user" -i \ + {% data variables.product.api_url_pre %}/hub \ + -F "hub.mode=subscribe" \ + -F "hub.topic=https://github.com/{owner}/{repo}/events/push" \ + -F "hub.callback=http://postbin.org/123" +``` + +PubSubHubbub requests can be sent multiple times. If the hook already exists, it will be modified according to the request. + +#### Parameters + +Name | Type | Description +-----|------|-------------- +``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. +``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. +``hub.callback``|`string` | The URI to receive the updates to the topic. +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 3.0 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. \ No newline at end of file diff --git a/translations/pt-BR/content/rest/webhooks/repo-config.md b/translations/pt-BR/content/rest/webhooks/repo-config.md new file mode 100644 index 0000000000..5653146886 --- /dev/null +++ b/translations/pt-BR/content/rest/webhooks/repo-config.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Configuration +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/webhooks/repo-deliveries.md b/translations/pt-BR/content/rest/webhooks/repo-deliveries.md new file mode 100644 index 0000000000..ee3f49cc36 --- /dev/null +++ b/translations/pt-BR/content/rest/webhooks/repo-deliveries.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Deliveries +intro: '' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/rest/webhooks/repos.md b/translations/pt-BR/content/rest/webhooks/repos.md new file mode 100644 index 0000000000..51d4dd89a8 --- /dev/null +++ b/translations/pt-BR/content/rest/webhooks/repos.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index c10e6d63ed..75927abdd6 100644 --- a/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -35,6 +35,8 @@ Você pode usar um cartão de crédito para patrocinar uma conta em {% data vari Ao patrocinar uma conta usando um cartão de crédito, a alteração entrará em vigor imediatamente. {% data reusables.sponsors.prorated-sponsorship %} +We may share certain limited tax information with sponsored accounts. For more information, see "[Tax information](#tax-information)." + {% data reusables.sponsors.manage-updates-for-orgs %} Você pode escolher se deseja mostrar seu patrocínio publicamente. Patrocínios únicos permanecem visíveis por um mês. @@ -51,6 +53,17 @@ Se a conta que você deseja patrocinar não tiver um perfil em {% data variables {% endnote %} +## Informações fiscais + +As a sponsor, you acknowledge that we may disclose to the owner of each account you sponsor the following limited information about your sponsorship payments to the account, since the inception of the Sponsors Program: + +- Transaction date +- Amount paid +- The country, state, and province from where payment was made +- Whether payment was made by a business or individual + +This information is necessary to enable payment and reporting of any taxes arising from such sponsorship payments. + ## Patrocinar uma conta Antes de poder patrocinar uma conta, você deve ter um endereço de e-mail verificado. Para obter mais informações, consulte "[Verificar o endereço de e-mail](/github/getting-started-with-github/verifying-your-email-address)". diff --git a/translations/pt-BR/data/features/codeql-runner-supported.yml b/translations/pt-BR/data/features/codeql-runner-supported.yml index fe641fe55a..80338055ad 100644 --- a/translations/pt-BR/data/features/codeql-runner-supported.yml +++ b/translations/pt-BR/data/features/codeql-runner-supported.yml @@ -1,7 +1,5 @@ --- #Tracking deprecation of CodeQL runner +#https://github.blog/changelog/2022-04-05-codeql-runner-is-now-deprecated/ versions: - fpt: '*' - ghec: '*' - ghes: '*' - ghae: '*' + ghes: '<=3.3' diff --git a/translations/pt-BR/data/features/org-profile-pin-private.yml b/translations/pt-BR/data/features/org-profile-pin-private.yml new file mode 100644 index 0000000000..ebd6681081 --- /dev/null +++ b/translations/pt-BR/data/features/org-profile-pin-private.yml @@ -0,0 +1,8 @@ +--- +#Issue #6171 +#Documentation for the "Org profile pin private/internal repos" +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.6' + ghae: 'issue-6171' diff --git a/translations/pt-BR/data/reusables/actions/reusable-workflow-calling-syntax.md b/translations/pt-BR/data/reusables/actions/reusable-workflow-calling-syntax.md index dc5018fc5b..97f3b2a38a 100644 --- a/translations/pt-BR/data/reusables/actions/reusable-workflow-calling-syntax.md +++ b/translations/pt-BR/data/reusables/actions/reusable-workflow-calling-syntax.md @@ -1,4 +1,4 @@ -* `{owner}/{repo}/{path}/{filename}@{ref}`{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %} para fluxos de trabalho nos repositórios públicos {% ifversion ghes or ghec or ghae %}or internos{% endif %}. -* `./{path}/{filename}` para fluxos de trabalho reutilizáveis no mesmo repositório.{% endif %} +* `{owner}/{repo}/.github/workflows/{filename}@{ref}`{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %} for reusable workflows in public {% ifversion ghes or ghec or ghae %}or internal{% endif %} repositories. +* `./.github/workflows/{filename}` for reusable workflows in the same repository.{% endif %} `{ref}` pode ser um SHA, uma tag de de versão ou um nome de branch. Usar o commit SHA é o mais seguro para a estabilidade e segurança. Para obter mais informações, consulte "[Enrijecimento de segurança para o GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#reusing-third-party-workflows)". {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %}se você usar a segunda opção de sintaxe (sem `{owner}/{repo}` e `@{ref}`), o fluxo de trabalho chamado é do mesmo commit que o fluxo de trabalho de chamada.{% endif %} diff --git a/translations/pt-BR/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md b/translations/pt-BR/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md new file mode 100644 index 0000000000..213699f2ff --- /dev/null +++ b/translations/pt-BR/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md @@ -0,0 +1 @@ +If you use ephemeral runners and have disabled automatic updates, before you upgrade {% data variables.product.product_location %}, you should first upgrade your self-hosted runners to the version of the runner application that your upgraded instance will run. Upgrading {% data variables.product.product_location %} before you upgrade ephemeral runners may result in your runners going offline. Para obter mais informações, consulte "[Atualizar o {% data variables.product.product_name %}](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)." \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md b/translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md index 23152122d3..1e5f15386b 100644 --- a/translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md +++ b/translations/pt-BR/data/reusables/audit_log/audit-log-action-categories.md @@ -26,7 +26,7 @@ {%- endif %} | `commit_comment` | Contains activities related to updating or deleting commit comments. {%- ifversion ghes %} -| `config_entry` | Contains activities related to configuration settings. These events are only visible in the site admin audit log. +| `config_entry` | Contains activities related to configuration settings. Esses eventos só são visíveis no log de auditoria do administrador do site. {%- endif %} {%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-4864 %} | `dependabot_alerts` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in existing repositories. Para obter mais informações, consulte "[Sobre alertas para dependências vulneráveis](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" | `dependabot_alerts_new_repos` | Contains organization-level configuration activities for {% data variables.product.prodname_dependabot_alerts %} in new repositories created in the organization. | `dependabot_repository_access` | Contains activities related to which private repositories in an organization {% data variables.product.prodname_dependabot %} is allowed to access. diff --git a/translations/pt-BR/data/reusables/code-scanning/alerts-found-in-generated-code.md b/translations/pt-BR/data/reusables/code-scanning/alerts-found-in-generated-code.md new file mode 100644 index 0000000000..8035c8a826 --- /dev/null +++ b/translations/pt-BR/data/reusables/code-scanning/alerts-found-in-generated-code.md @@ -0,0 +1,3 @@ +Para linguagens compiladas como Java, C, C++ e C#, o {% data variables.product.prodname_codeql %} analisa todo o código construído durante a execução do fluxo de trabalho. Para limitar a quantidade de código em análise, crie apenas o código que você deseja analisar especificando suas próprias etapas de criação em um bloco `Executar`. Você pode combinar a especificação das suas próprias etapas de criação ao usar os filtros `caminhos` ou `paths-ignore` nos eventos `pull_request` e `push` para garantir que o seu fluxo de trabalho só será executado quando o código específico for alterado. Para obter mais informações, consulte "[Sintaxe de fluxo de trabalho para o {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)". + +Para linguagens como Go, JavaScript, Python e TypeScript, que {% data variables.product.prodname_codeql %} analisa sem compilar o código-fonte, você pode especificar as opções de configuração adicionais para limitar a quantidade de código a ser analisado. Para obter mais informações, consulte "[Especificar diretórios a serem varridos](/code-security/secure-coding/configuring-code-scanning#specifying-directories-to-scan)". \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/codespaces/billing-for-prebuilds.md b/translations/pt-BR/data/reusables/codespaces/billing-for-prebuilds.md index bd357c1244..0fe589a98d 100644 --- a/translations/pt-BR/data/reusables/codespaces/billing-for-prebuilds.md +++ b/translations/pt-BR/data/reusables/codespaces/billing-for-prebuilds.md @@ -2,6 +2,6 @@ By default, a {% data variables.product.prodname_actions %} workflow is triggere If you are an organization owner, you can track usage of prebuild workflows by downloading a {% data variables.product.prodname_actions %} usage report for your organization. You can identify workflow runs for prebuilds by filtering the CSV output to only include the workflow called "Create Codespaces Prebuilds." Para obter mais informações, consulte "[Visualizar o uso do seu {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions/viewing-your-github-actions-usage#viewing-github-actions-usage-for-your-organization)". -To reduce consumption of Actions minutes, you can set a prebuild template to be updated only when you make a change to your dev container configuration files, or only on a custom schedule. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." +To reduce consumption of Actions minutes, you can set a prebuild template to be updated only when you make a change to your dev container configuration files, or only on a custom schedule. Para obter mais informações, consulte "[Configurando pré-criações](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)". While {% data variables.product.prodname_codespaces %} prebuilds is in beta there is no charge for storage of templates. When prebuilds become generally available, you will be billed for storing prebuild templates for each prebuild configuration in each region selected for that configuration. diff --git a/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md b/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md index 66cf06829c..53b5154270 100644 --- a/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md +++ b/translations/pt-BR/data/reusables/codespaces/concurrent-codespace-limit.md @@ -1 +1 @@ -Você pode criar mais de um código de espaço por repositório ou até mesmo por branch. However, each personal account has a limit of 10 codespaces. Se você atingiu o limite e deseja criar um novo espaço de código, você deve primeiro excluir um código. +Você pode criar mais de um código de espaço por repositório ou até mesmo por branch. No entanto, cada conta pessoal tem um limite de 10 codespaces. Se você atingiu o limite e deseja criar um novo espaço de código, você deve primeiro excluir um código. diff --git a/translations/pt-BR/data/reusables/codespaces/creating-a-codespace-in-vscode.md b/translations/pt-BR/data/reusables/codespaces/creating-a-codespace-in-vscode.md index f66002dac8..a858083c27 100644 --- a/translations/pt-BR/data/reusables/codespaces/creating-a-codespace-in-vscode.md +++ b/translations/pt-BR/data/reusables/codespaces/creating-a-codespace-in-vscode.md @@ -2,7 +2,7 @@ After you connect your account on {% data variables.product.product_location %} {% note %} -**Note**: Currently, {% data variables.product.prodname_vscode %} doesn't allow you to choose a dev container configuration when you create a codespace. If you want to choose a specific dev container configuration, use the {% data variables.product.prodname_dotcom %} web interface to create your codespace. For more information, click the **Web browser** tab at the top of this page. +**Note**: Currently, {% data variables.product.prodname_vscode %} doesn't allow you to choose a dev container configuration when you create a codespace. Se você quiser escolher uma configuração de contêiner de desenvolvimento específica, use a interface web do {% data variables.product.prodname_dotcom %} para criar o seu codespace. For more information, click the **Web browser** tab at the top of this page. {% endnote %} diff --git a/translations/pt-BR/data/reusables/sponsors/sponsorship-details.md b/translations/pt-BR/data/reusables/sponsors/sponsorship-details.md index 4875c5ea63..6f48b1d376 100644 --- a/translations/pt-BR/data/reusables/sponsors/sponsorship-details.md +++ b/translations/pt-BR/data/reusables/sponsors/sponsorship-details.md @@ -1 +1 @@ -You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your personal account or an organization. Você pode escolher entre várias camadas de patrocínio, com um único valor de pagamento ou um mensal que é definido pela conta patrocinada. O seu patrocínio compartilhará a data de cobrança existente da sua conta, o método de pagamento e o recibo. +You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your personal account or an organization. Você pode escolher entre várias camadas de patrocínio, com um único valor de pagamento ou um mensal que é definido pela conta patrocinada. Your sponsorship will share your account’s existing billing date, payment method, and receipt. diff --git a/translations/pt-BR/data/reusables/webhooks/pull_request_review_thread_short_desc.md b/translations/pt-BR/data/reusables/webhooks/pull_request_review_thread_short_desc.md new file mode 100644 index 0000000000..7d835cbe5a --- /dev/null +++ b/translations/pt-BR/data/reusables/webhooks/pull_request_review_thread_short_desc.md @@ -0,0 +1 @@ +Activity related to a comment thread on a pull request being marked as resolved or unresolved. {% data reusables.webhooks.action_type_desc %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/webhooks/pull_request_thread_properties.md b/translations/pt-BR/data/reusables/webhooks/pull_request_thread_properties.md new file mode 100644 index 0000000000..ada064c1a1 --- /dev/null +++ b/translations/pt-BR/data/reusables/webhooks/pull_request_thread_properties.md @@ -0,0 +1,5 @@ +| Tecla | Tipo | Descrição | +| -------------- | -------- | ----------------------------------------------------------------------------------- | +| `Ação` | `string` | A ação que foi executada. Pode ser uma das ações a seguir:
    • `resolved` - A comment thread on a pull request was marked as resolved.
    • `unresolved` - A previously resolved comment thread on a pull request was marked as unresolved.
    | +| `pull_request` | `objeto` | The [pull request](/rest/reference/pulls) the thread pertains to. | +| `thread` | `objeto` | The thread that was affected. | diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md index 56cfbbdbd8..fb71b12bbc 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md @@ -18,7 +18,11 @@ shortTitle: 组织资料 您可以选择为组织添加描述、位置、网站和电子邮件地址，以及固定重要存储库。{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4749 %} 您可以通过添加 README.md 文件来自定义组织的配置文件。 更多信息请参阅“[自定义组织的配置文件](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)”。{% endif %} -{% ifversion fpt or ghec %}要确认组织的身份并在组织资料页面显示“验证的”徽章，必须向 {% data variables.product.product_name %} 验证组织的域。 更多信息请参阅“[验证或批准组织的域](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)”。{% endif %} +{% ifversion fpt %} +Organizations that use {% data variables.product.prodname_ghe_cloud %} can confirm their organization's identity and display a "Verified" badge on their organization's profile page by verifying the organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)" in the {% data variables.product.prodname_ghe_cloud %} documenatation. +{% elsif ghec or ghes > 3.1 %} +To confirm your organization's identity and display a "Verified" badge on your organization profile page, you can verify your organization's domains with {% data variables.product.prodname_dotcom %}. 更多信息请参阅“[验证或批准组织的域](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)”。 +{% endif %} {% ifversion fpt or ghes > 3.2 or ghec %} ![组织资料页面示例](/assets/images/help/organizations/org_profile_with_overview.png) diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 9426b2ff4b..7adf2c01fc 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -45,7 +45,7 @@ For more information about installing and using self-hosted runners, see "[Addin - Use free minutes on your {% data variables.product.prodname_dotcom %} plan, with per-minute rates applied after surpassing the free minutes. **Self-hosted runners:**{% endif %} -- Receive automatic updates for the self-hosted runner application only{% ifversion fpt or ghec or ghes > 3.2 %}, though you may disable automatic updates of the runner. For more information about controlling runner software updates on self-hosted runners, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)."{% else %}.{% endif %} You are responsible for updating the operating system and all other software. +- Receive automatic updates for the self-hosted runner application only{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6143 %}, though you may disable automatic updates of the runner. For more information about controlling runner software updates on self-hosted runners, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#controlling-runner-software-updates-on-self-hosted-runners)."{% else %}.{% endif %} You are responsible for updating the operating system and all other software. - Can use cloud services or local machines that you already pay for. - Are customizable to your hardware, operating system, software, and security requirements. - Don't need to have a clean instance for every job execution. diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/translations/zh-CN/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index 7cba4e26c8..a0bb72ec3b 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -54,6 +54,8 @@ type: overview {% endnote %} +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6143 %} + ## 控制自托管运行器上的运行器软件更新 默认情况下，每当有新版本的运行器软件可用时，自托管运行器将自动执行软件更新。 如果在容器中使用临时运行器，则当发布新的运行器版本时，这可能会导致重复的软件更新。 关闭自动更新允许你按照自己的计划直接更新容器映像上的运行器版本。 @@ -76,6 +78,8 @@ type: overview {% endnote %} +{% endif %} + ## 使用 web 挂钩进行自动缩放 可以使用从 [`workflow_job`](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job) web 挂钩接收的有效负载创建自己的自动缩放环境。 此 web 挂钩在存储库、组织和企业级别可用，此事件的有效负载包含与工作流程作业生命周期的各个阶段相对应的 `action` 键；例如，当作业为 `queued`、`in_progress` 和 `completed` 时。 然后，您必须创建自己的缩放自动化以响应这些 web 挂钩有效负载。 diff --git a/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md b/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md index a84aeee4e3..bc33eb639b 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md @@ -111,7 +111,7 @@ _操作_是 {% data variables.product.prodname_actions %} 平台的自定义应 ``` 1. 提交这些更改并将其推送到您的 {% data variables.product.prodname_dotcom %} 仓库。 -您的新 {% data variables.product.prodname_actions %} 工作流程文件现在安装在您的仓库中，每次有人推送更改到仓库时都会自动运行。 有关作业的执行历史记录的详细信息，请参阅“[查看工作流程的活动](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-jobs-activity)”。 +您的新 {% data variables.product.prodname_actions %} 工作流程文件现在安装在您的仓库中，每次有人推送更改到仓库时都会自动运行。 有关工作流程的执行历史记录的详细信息，请参阅“[查看工作流程的活动](/actions/learn-github-actions/introduction-to-github-actions#viewing-the-workflows-activity)”。 ## 了解工作流程文件 diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/deploying-github-ae.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/deploying-github-ae.md index 2e264c08cc..6b90d7a924 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/deploying-github-ae.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/deploying-github-ae.md @@ -1,24 +1,24 @@ --- -title: 部署 GitHub AE -intro: '可以将 {% data variables.product.product_name %} 部署到可用的 Azure 区域。' +title: Deploying GitHub AE +intro: 'You can deploy {% data variables.product.product_name %} to an available Azure region.' versions: ghae: '*' topics: - Accounts - Enterprise type: how_to -shortTitle: 部署 GitHub AE +shortTitle: Deploy GitHub AE redirect_from: - /get-started/signing-up-for-github/setting-up-a-trial-of-github-ae --- -## 关于 {% data variables.product.product_name %} 的部署 +## About deployment of {% data variables.product.product_name %} -{% data reusables.github-ae.github-ae-enables-you %} 更多信息请参阅“[关于 {% data variables.product.prodname_ghe_managed %}](/admin/overview/about-github-ae)”。 +{% data reusables.github-ae.github-ae-enables-you %} For more information, see "[About {% data variables.product.prodname_ghe_managed %}](/admin/overview/about-github-ae)." -购买或开始试用 {% data variables.product.product_name %} 后，可以将 {% data variables.product.product_name %} 部署到可用的 Azure 区域。 This guide refers to the Azure resource that contains the deployment of {% data variables.product.product_name %} as the {% data variables.product.product_name %} account. You'll use the Azure portal at [https://portal.azure.com](https://portal.azure.com) to deploy the {% data variables.product.product_name %} account. +After you purchase or start a trial of {% data variables.product.product_name %}, you can deploy {% data variables.product.product_name %} to an available Azure region. This guide refers to the Azure resource that contains the deployment of {% data variables.product.product_name %} as the {% data variables.product.product_name %} account. You'll use the Azure portal at [https://portal.azure.com](https://portal.azure.com) to deploy the {% data variables.product.product_name %} account. -## 基本要求 +## Prerequisites - Before you can deploy {% data variables.product.product_name %}, you must request access from your {% data variables.product.company_short %} account team. {% data variables.product.company_short %} will enable deployment of {% data variables.product.product_name %} for your Azure subscription. If you haven't already purchased {% data variables.product.product_name %}, you can contact {% data variables.contact.contact_enterprise_sales %} to check your eligibility for a trial. @@ -29,18 +29,19 @@ redirect_from: The {% data variables.actions.azure_portal %} allows you to deploy the {% data variables.product.product_name %} account in your Azure resource group. 1. Click one of the following two links to begin deployment of {% data variables.product.product_name %}. The link you should click depends on the Azure cloud where you plan to deploy {% data variables.product.product_name %}. For more information about Azure Government, see [What is Azure Government?](https://docs.microsoft.com/en-us/azure/azure-government/documentation-government-welcome) in the Microsoft documentation. - + - [Deploy {% data variables.product.product_name %} to Azure Commercial](https://aka.ms/create-github-ae-instance) - [Deploy {% data variables.product.product_name %} to Azure Government](https://aka.ms/create-github-ae-instance-gov) 1. To begin the process of adding a new {% data variables.product.product_name %} account, click **Create GitHub AE account**. -1. Complete the "Project details" and "Instance details" fields. ![{% data variables.actions.azure_portal %} search result](/assets/images/azure/github-ae-azure-portal-form.png) +1. Complete the "Project details" and "Instance details" fields. + ![{% data variables.actions.azure_portal %} search result](/assets/images/azure/github-ae-azure-portal-form.png) - **Account name:** The hostname for your enterprise - **Administrator username:** A username for the initial enterprise owner that will be created in {% data variables.product.product_name %} - **Administrator email:** The email address that will receive the login information 1. To review a summary of the proposed changes, click **Review + create**. 1. After the validation process has completed, click **Create**. -The email address you entered above will receive instructions on how to access your enterprise. After you have access, you can get started by following the initial setup steps. 更多信息请参阅“[初始化 {% data variables.product.product_name %}](/admin/configuration/initializing-github-ae)。” +The email address you entered above will receive instructions on how to access your enterprise. After you have access, you can get started by following the initial setup steps. For more information, see "[Initializing {% data variables.product.product_name %}](/admin/configuration/initializing-github-ae)." {% note %} @@ -53,14 +54,15 @@ The email address you entered above will receive instructions on how to access y You can use the {% data variables.actions.azure_portal %} to navigate to your {% data variables.product.product_name %} deployment. The resulting list includes all the {% data variables.product.product_name %} deployments in your Azure region. 1. On the {% data variables.actions.azure_portal %}, in the left panel, click **All resources**. -1. From the available filters, click **All types**, then deselect **Select all** and select **GitHub AE**: ![{% data variables.actions.azure_portal %} search result](/assets/images/azure/github-ae-azure-portal-type-filter.png) +1. From the available filters, click **All types**, then deselect **Select all** and select **GitHub AE**: + ![{% data variables.actions.azure_portal %} search result](/assets/images/azure/github-ae-azure-portal-type-filter.png) -## 后续步骤 +## Next steps -- Once your deployment has been provisioned, the next step is to initialize {% data variables.product.product_name %}. 更多信息请参阅“[初始化 {% data variables.product.product_name %}](/github-ae@latest/admin/configuration/configuring-your-enterprise/initializing-github-ae)。” -- If you're trying {% data variables.product.product_name %}, you can upgrade to a full license at any time during the trial period by contacting contact {% data variables.contact.contact_enterprise_sales %}. If you haven't upgraded by the last day of your trial, then the deployment is automatically deleted. 如果需要更多时间来评估 {% data variables.product.product_name %}，请联系 {% data variables.contact.contact_enterprise_sales %} 申请延期。 +- Once your deployment has been provisioned, the next step is to initialize {% data variables.product.product_name %}. For more information, see "[Initializing {% data variables.product.product_name %}](/github-ae@latest/admin/configuration/configuring-your-enterprise/initializing-github-ae)." +- If you're trying {% data variables.product.product_name %}, you can upgrade to a full license at any time during the trial period by contacting contact {% data variables.contact.contact_enterprise_sales %}. If you haven't upgraded by the last day of your trial, then the deployment is automatically deleted. If you need more time to evaluate {% data variables.product.product_name %}, contact {% data variables.contact.contact_enterprise_sales %} to request an extension. -## 延伸阅读 +## Further reading - "[Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %}](/github/getting-started-with-github/about-github-advanced-security#enabling-advanced-security-features-on-github-ae)" - "[{% data variables.product.product_name %} release notes](/github-ae@latest/admin/overview/github-ae-release-notes)" diff --git a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 86d017c2c4..792c2c0661 100644 --- a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -100,9 +100,7 @@ shortTitle: 仓库管理策略 {% data reusables.enterprise-accounts.repo-creation-policy %} {% data reusables.enterprise-accounts.repo-creation-types %} {% else %} -6. 在“Repository creation（仓库创建）”下，使用下拉菜单并选择策略。 - - ![包含仓库创建策略的下拉菜单](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) +6. 在“Repository creation（仓库创建）”下，使用下拉菜单并选择策略。 ![包含仓库创建策略的下拉菜单](/assets/images/enterprise/site-admin-settings/repository-creation-drop-down.png) {% endif %} ## 实施有关复刻私有或内部仓库的策略 @@ -113,16 +111,7 @@ shortTitle: 仓库管理策略 {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.repositories-tab %} 3. 在“Repository forking”（仓库复刻）下，审查有关更改设置的信息。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -4. 在“Repository forking（仓库复刻）”下，使用下拉菜单并选择策略。 - - ![带有仓库复刻策略选项的下拉菜单](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) - -{% if innersource-fork-policies %} -5. 如果启用了复刻，则可以指定允许用户复刻存储库的位置。 查看有关更改设置的信息并选择策略。 - - ![显示存储库复刻策略选项列表的屏幕截图](/assets/images/help/business-accounts/repository-forking-policy-settings.png) -{% endif %} - +4. 在“Repository forking（仓库复刻）”下，使用下拉菜单并选择策略。 ![带有仓库复刻策略选项的下拉菜单](/assets/images/help/business-accounts/repository-forking-policy-drop-down.png) ## 执行邀请{% ifversion ghec %} 外部{% endif %} 协作者参与仓库的策略 @@ -133,7 +122,6 @@ shortTitle: 仓库管理策略 {% data reusables.enterprise-accounts.repositories-tab %} 3. 在“仓库 {% ifversion ghec %}外部协作者{% elsif ghes or ghae %}邀请{% endif %}”下，请查看有关更改设置的信息。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 4. 在“仓库 {% ifversion ghec %}外部协作者{% elsif ghes or ghae %}邀请{% endif %}”下，使用下拉菜单并选择策略。 - {% ifversion ghec %} ![带有外部协作者邀请策略选项的下拉菜单](/assets/images/help/business-accounts/repository-invitation-policy-drop-down.png) {% elsif ghes or ghae %} @@ -185,9 +173,7 @@ shortTitle: 仓库管理策略 {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} 3. 在 **Repository policies（仓库策略）**选项卡中的“Repository issue deletion（仓库议题删除）”下，审查有关更改设置的信息。 {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} -4. 在“Repository issue deletion（仓库议题删除）”下，使用下拉菜单并选择策略。 - - ![带有议题删除策略选项的下拉菜单](/assets/images/help/business-accounts/repository-issue-deletion-policy-drop-down.png) +4. 在“Repository issue deletion（仓库议题删除）”下，使用下拉菜单并选择策略。 ![带有议题删除策略选项的下拉菜单](/assets/images/help/business-accounts/repository-issue-deletion-policy-drop-down.png) {% ifversion ghes or ghae %} diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index f82d63b6a1..1fda1d6562 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md @@ -1,6 +1,6 @@ --- -title: Configuring notifications for Dependabot alerts -shortTitle: Configure notifications +title: 配置 Dependabot 警报的通知 +shortTitle: 配置通知 intro: '优化接收 {% data variables.product.prodname_dependabot_alerts %} 相关通知的方式。' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies @@ -60,7 +60,7 @@ topics: ## 如何减少有漏洞依赖项通知的干扰 -如果您想要收到太多 {% data variables.product.prodname_dependabot_alerts %} 的通知，我们建议您选择加入每周的电子邮件摘要，或者在保持 {% data variables.product.prodname_dependabot_alerts %} 启用时关闭通知。 您仍可导航到仓库的 Security（安全性）选项卡查看 {% data variables.product.prodname_dependabot_alerts %}。 For more information, see "[Viewing {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)." +如果您想要收到太多 {% data variables.product.prodname_dependabot_alerts %} 的通知，我们建议您选择加入每周的电子邮件摘要，或者在保持 {% data variables.product.prodname_dependabot_alerts %} 启用时关闭通知。 您仍可导航到仓库的 Security（安全性）选项卡查看 {% data variables.product.prodname_dependabot_alerts %}。 更多信息请参阅“[查看有漏洞依赖项的 {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)”。 ## 延伸阅读 diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md index 4de0302510..0071a11075 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md @@ -1,6 +1,6 @@ --- -title: Editing security advisories in the GitHub Advisory Database -intro: 'You can submit improvements to any advisory published in the {% data variables.product.prodname_advisory_database %}.' +title: 在 GitHub Advisory 数据库中编辑安全通告 +intro: '您可以对 {% data variables.product.prodname_advisory_database %} 中发布的任何公告提出改进建议。' redirect_from: - /code-security/security-advisories/editing-security-advisories-in-the-github-advisory-database - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database @@ -14,14 +14,14 @@ topics: - Dependabot - Vulnerabilities - CVEs -shortTitle: Edit Advisory Database +shortTitle: 编辑公告数据库 --- -## About editing advisories in the {% data variables.product.prodname_advisory_database %} -Security advisories in the {% data variables.product.prodname_advisory_database %} at [github.com/advisories](https://github.com/advisories) are considered global advisories. Anyone can suggest improvements on any global security advisory in the {% data variables.product.prodname_advisory_database %}. You can edit or add any detail, including additionally affected ecosystems, severity level or description of who is impacted. The {% data variables.product.prodname_security %} curation team will review the submitted improvements and publish them onto the {% data variables.product.prodname_advisory_database %} if accepted. +## 关于在 {% data variables.product.prodname_advisory_database %} 中编辑公告 +[github.com/advisories](https://github.com/advisories) {% data variables.product.prodname_advisory_database %} 中的安全公告被视为全局公告。 任何人都可以在 {% data variables.product.prodname_advisory_database %} 中对任何全局安全公告提出改进建议。 您可以编辑或添加任何详细信息，包括其他受影响的生态系统、严重性级别或受影响者的描述。 {% data variables.product.prodname_security %} 管理团队将审查提交的改进，并在接受时将其发布到 {% data variables.product.prodname_advisory_database %} 上。 -Only repository owners and administrators can edit repository-level security advisories. For more information, see "[Editing a repository security advisory](/code-security/security-advisories/editing-a-security-advisory)." -## Editing advisories in the GitHub Advisory Database +只有存储库所有者和管理员才能编辑存储库级别的安全公告。 更多信息请参阅“[编辑存储库安全通告](/code-security/security-advisories/editing-a-security-advisory)”。 +## 在 GitHub Advisory 数据库中编辑通告 1. 导航到 https://github.com/advisories。 2. Select the security advisory you would like to contribute to. diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/index.md b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/index.md index 8f91a3d801..50226097a9 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/index.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/index.md @@ -1,7 +1,7 @@ --- -title: Identifying vulnerabilities in your project's dependencies with Dependabot alerts +title: 使用 Dependabot 警报识别项目依赖项中的漏洞 shortTitle: Dependabot 警报 -intro: '{% data variables.product.prodname_dependabot %} generates {% data variables.product.prodname_dependabot_alerts %} when known vulnerabilites are detected in dependencies that your project uses.' +intro: '{% data variables.product.prodname_dependabot %} 会在项目使用的依赖项中检测到已知漏洞时生成 {% data variables.product.prodname_dependabot_alerts %}。' allowTitleToDifferFromFilename: true versions: fpt: '*' diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index a40c6159ff..64b4137800 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -1,5 +1,5 @@ --- -title: Viewing and updating Dependabot alerts +title: 查看和更新 Dependabot 警报 intro: '如果 {% data variables.product.product_name %} 发现项目中存在有漏洞的依赖项，您可以在仓库的 Dependabot 警报选项卡中查看它们。 然后，您可以更新项目以解决或忽略漏洞。' redirect_from: - /articles/viewing-and-updating-vulnerable-dependencies-in-your-repository @@ -7,7 +7,7 @@ redirect_from: - /code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository permissions: 'Repository administrators and organization owners can view and update dependencies, as well as users and teams with explicit access.' -shortTitle: View Dependabot alerts +shortTitle: 查看 Dependabot 警报 versions: fpt: '*' ghes: '*' @@ -45,36 +45,36 @@ topics: {% endif %} {% if dependabot-alerts-vulnerable-calls %} -## About the detection of calls to vulnerable functions +## 关于检测对有漏洞函数的调用 {% data reusables.dependabot.vulnerable-calls-beta %} -When {% data variables.product.prodname_dependabot %} tells you that your repository uses a vulnerable dependency, you need to determine what the vulnerable functions are and check whether you are using them. Once you have this information, then you can determine how urgently you need to upgrade to a secure version of the dependency. +当 {% data variables.product.prodname_dependabot %} 告诉您存储库使用有漏洞的依赖项时，您需要确定有漏洞的功能是什么，并检查是否正在使用它们。 获得此信息后，可以确定升级到依赖项的安全版本的迫切程度。 -For supported languages, {% data variables.product.prodname_dependabot %} automatically detects whether you use a vulnerable function and adds the label "Vulnerable call" to affected alerts. You can use this information in the {% data variables.product.prodname_dependabot_alerts %} view to triage and prioritize remediation work more effectively. +对于支持的语言，{% data variables.product.prodname_dependabot %} 会自动检测您是否使用有漏洞的函数，并为受影响的警报添加“有漏洞的调用”标签。 您可以在 {% data variables.product.prodname_dependabot_alerts %} 视图中使用此信息来更有效地分流修正工作并确定其优先级。 {% note %} -**Note:** During the beta release, this feature is available only for new Python advisories created *after* April 14, 2022, and for a subset of historical Python advisories. GitHub is working to backfill data across additional historical Python advisories, which are added on a rolling basis. Vulnerable calls are highlighted only on the {% data variables.product.prodname_dependabot_alerts %} pages. +**注意：** 在测试版期间，此功能仅适用于在 2022 年 4 月 14 日*之后*创建的新 Python 公告，以及历史 Python 公告的子集。 GitHub 正在努力回填其他历史 Python 公告的数据，这些公告是滚动添加的。 有漏洞的调用仅在 {% data variables.product.prodname_dependabot_alerts %} 页面上突出显示。 {% endnote %} -![Screenshot showing an alert with the "Vulnerable call" label](/assets/images/help/repository/dependabot-alerts-vulnerable-call-label.png) +![显示带有"有漏洞的调用"标签的警报屏幕截图](/assets/images/help/repository/dependabot-alerts-vulnerable-call-label.png) -You can filter the view to show only alerts where {% data variables.product.prodname_dependabot %} detected at least one call to a vulnerable function using the `has:vulnerable-calls` filter in the search field. +您可以在搜索字段中使用 `has:vulnerable-calls` 筛选视图，仅显示 {% data variables.product.prodname_dependabot %} 检测到至少一次调用有漏洞函数的警报。 -For alerts where vulnerable calls are detected, the alert details page shows additional information: +对于检测到有漏洞的调用的警报，警报详细信息页面将显示其他信息： -- A code block showing where the function is used or, where there are multiple calls, the first call to the function. -- An annotation listing the function itself, with a link to the line where the function is called. +- 显示函数使用位置或者在有多个调用时显示对函数的第一次调用的代码块。 +- 列出函数本身以及指向调用函数的行的链接的注释。 -![Screenshot showing the alert details page for an alert with a "Vulnerable call" label](/assets/images/help/repository/review-calls-to-vulnerable-functions.png) +![显示警报的并带有"有漏洞的调用"标签的警报详细信息页面屏幕截图](/assets/images/help/repository/review-calls-to-vulnerable-functions.png) -For more information, see "[Reviewing and fixing vulnerable dependencies](#reviewing-and-fixing-vulnerable-dependencies)" below. +更多信息请参阅下面的“[查看和修复有漏洞的依赖项](#reviewing-and-fixing-vulnerable-dependencies)”。 {% endif %} -## Viewing vulnerable dependencies +## 查看有漏洞的依赖项 {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5638 %} {% data reusables.repositories.navigate-to-repo %} @@ -90,28 +90,28 @@ For more information, see "[Reviewing and fixing vulnerable dependencies](#revie 1. 单击您想要查看的警报。 ![在警报列表中选择的警报](/assets/images/help/graphs/click-alert-in-alerts-list.png) {% endif %} -## Reviewing and fixing vulnerable dependencies +## 查看和修复有漏洞的依赖项 -It’s important to ensure that all of your dependencies are clean of any security weaknesses. When {% data variables.product.prodname_dependabot %} discovers vulnerabilities in your dependencies, you should assess your project’s level of exposure and determine what remediation steps to take to secure your application. +请务必确保所有依赖项都没有任何安全漏洞。 当 {% data variables.product.prodname_dependabot %} 发现依赖项中的漏洞时，应评估项目的暴露水平，并确定要采取哪些补救措施来保护应用程序。 -If a patched version is available, you can generate a {% data variables.product.prodname_dependabot %} pull request to update this dependency directly from a {% data variables.product.prodname_dependabot %} alert. If you have {% data variables.product.prodname_dependabot_security_updates %} enabled, the pull request may be linked will in the Dependabot alert. +如果有修补的版本可用，则可以生成 {% data variables.product.prodname_dependabot %} 请求，以直接从 {% data variables.product.prodname_dependabot %} 警报更新此依赖项。 如果您启用了 {% data variables.product.prodname_dependabot_security_updates %}，则拉取请求可能会在 Dependabot 警报中链接。 -In cases where a patched version is not available, or you can’t update to the secure version, {% data variables.product.prodname_dependabot %} shares additional information to help you determine next steps. When you click through to view a {% data variables.product.prodname_dependabot %} alert, you can see the full details of the security advisory for the dependency including the affected functions. You can then check whether your code calls the impacted functions. This information can help you further assess your risk level, and determine workarounds or if you’re able to accept the risk represented by the security vulnerability. +如果修补的版本不可用，或者您无法更新到安全版本，{% data variables.product.prodname_dependabot %} 会共享其他信息，以帮助您确定后续步骤。 单击以查看 {% data variables.product.prodname_dependabot %} 警报时，可以看到依赖项的安全通告的完整详细信息，包括受影响的功能。 然后，可以检查代码是否调用受影响的函数。 此信息可以帮助您进一步评估风险级别，并确定解决方法或是否能够接受安全漏洞所代表的风险。 {% if dependabot-alerts-vulnerable-calls %} -For supported languages, {% data variables.product.prodname_dependabot %} detects calls to vulnerable functions for you. When you view an alert labeled as "Vulnerable call", the details include the name of the function and a link to the code that calls it. Often you will be able to take decisions based on this information, without exploring further. +对于支持的语言，{% data variables.product.prodname_dependabot %} 为您检测对有漏洞函数的调用。 当您查看标记为“有漏洞的调用”的警报时，详细信息包括函数的名称以及指向调用该函数的代码的链接。 通常，您将能够根据此信息做出决策，而无需进一步探索。 {% endif %} -### Fixing vulnerable dependencies +### 修复有漏洞的依赖项 -1. View the details for an alert. For more information, see "[Viewing vulnerable dependencies](#viewing-vulnerable-dependencies)" (above). +1. 查看警报的详细信息。 更多信息请参阅“[查看有漏洞的依赖项](#viewing-vulnerable-dependencies)”（上文）。 {% ifversion fpt or ghec or ghes > 3.2 %} -1. If you have {% data variables.product.prodname_dependabot_security_updates %} enabled, there may be a link to a pull request that will fix the dependency. Alternatively, you can click **Create {% data variables.product.prodname_dependabot %} security update** at the top of the alert details page to create a pull request. ![创建 {% data variables.product.prodname_dependabot %} 安全更新按钮](/assets/images/help/repository/create-dependabot-security-update-button-ungrouped.png) -1. Optionally, if you do not use {% data variables.product.prodname_dependabot_security_updates %}, you can use the information on the page to decide which version of the dependency to upgrade to and create a pull request to update the dependency to a secure version. +1. 如果启用了 {% data variables.product.prodname_dependabot_security_updates %} ，则可能存在指向将修复依赖项的拉取请求的链接。 或者，可以单击警报详细信息页面顶部的 **创建 {% data variables.product.prodname_dependabot %} 安全更新**以创建拉取请求。 ![创建 {% data variables.product.prodname_dependabot %} 安全更新按钮](/assets/images/help/repository/create-dependabot-security-update-button-ungrouped.png) +1. （可选）如果不使用 {% data variables.product.prodname_dependabot_security_updates %}，则可以使用页面上的信息来决定要升级到的依赖项版本，并创建拉取请求以将依赖项更新到安全版本。 {% elsif ghes < 3.3 or ghae %} -1. You can use the information on the page to decide which version of the dependency to upgrade to and create a pull request to the manifest or lock file to a secure version. +1. 可以使用页面上的信息来决定要升级到的依赖项版本，并创建对清单的拉取请求或将文件锁定到安全版本。 {% endif %} 1. 当您准备好更新依赖项并解决漏洞时，合并拉取请求。 @@ -119,12 +119,12 @@ For supported languages, {% data variables.product.prodname_dependabot %} detect {% data variables.product.prodname_dependabot %} 提出的每个拉取请求都包含可用于控制 {% data variables.product.prodname_dependabot %} 的命令的相关信息。 更多信息请参阅“[管理依赖项更新的拉取请求](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)”。 {% endif %} -### Dismissing {% data variables.product.prodname_dependabot_alerts %} +### 忽略 {% data variables.product.prodname_dependabot_alerts %} -If you schedule extensive work to upgrade a dependency, or decide that an alert does not need to be fixed, you can dismiss the alert. Dismissing alerts that you have already assessed makes it easier to triage new alerts as they appear. +如果计划大量工作来升级依赖项，或者决定不需要修复警报，则可以忽略警报。 通过忽略已评估的警报，可以更轻松地在新警报出现时对其进行分类。 -1. View the details for an alert. For more information, see "[Viewing vulnerable dependencies](#viewing-vulnerable-dependencies)" (above). -1. Select the "Dismiss" dropdown, and click a reason for dismissing the alert.{% if reopen-dependabot-alerts %} Unfixed dismissed alerts can be reopened later.{% endif %} ![选择通过 "Dismiss（忽略）"下拉菜单忽略警报的原因](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) +1. 查看警报的详细信息。 更多信息请参阅“[查看有漏洞的依赖项](#viewing-vulnerable-dependencies)”（上文）。 +1. 选择“Dismiss（忽略）”下拉列表，然后单击忽略警报的原因。{% if reopen-dependabot-alerts %} 未修复的已忽略警报可以稍后重新打开。{% endif %} ![选择通过 "Dismiss（忽略）"下拉菜单忽略警报的原因](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png) {% if reopen-dependabot-alerts %} diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-security-updates/index.md b/translations/zh-CN/content/code-security/dependabot/dependabot-security-updates/index.md index 13456e36d9..c1e9860b56 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-security-updates/index.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-security-updates/index.md @@ -1,6 +1,6 @@ --- -title: Automatically updating dependencies with known vulnerabilities with Dependabot security updates -intro: '{% data variables.product.prodname_dependabot %} can help you fix vulnerable dependencies by automatically raising pull requests to update dependencies to secure versions.' +title: 使用 Dependabot 安全更新自动更新具有已知漏洞的依赖项 +intro: '{% data variables.product.prodname_dependabot %} 可以通过自动提出拉取请求将依赖项更新到安全版本，来帮助您修复有漏洞的依赖项。' allowTitleToDifferFromFilename: true versions: fpt: '*' diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index ccd397a29f..9db3d4fa91 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -1,5 +1,5 @@ --- -title: Configuration options for the dependabot.yml file +title: dependabot.yml 文件的配置选项 intro: '可用于自定义 {% data variables.product.prodname_dependabot %} 如何维护仓库的所有选项的详细信息。' permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_dependabot %} for the repository.' allowTitleToDifferFromFilename: true @@ -19,7 +19,7 @@ topics: - Repositories - Dependencies - Pull requests -shortTitle: Configure dependabot.yml +shortTitle: 配置 dependabot.yml --- {% data reusables.dependabot.beta-security-and-version-updates %} @@ -29,41 +29,41 @@ shortTitle: Configure dependabot.yml {% data variables.product.prodname_dependabot %} 配置文件 *dependabot.yml* 使用 YAML 语法。 如果您是 YAML 的新用户并想要了解更多信息，请参阅“[五分钟了解 YAML](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)”。 -必须将此文件存储在仓库的 `.github` 目录中。 添加或更新 *dependabot.yml* 文件时，这将触发对版本更新的立即检查。 For more information and an example, see "[Configuring {% data variables.product.prodname_dependabot %} version updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-dependabot-version-updates)." +必须将此文件存储在仓库的 `.github` 目录中。 添加或更新 *dependabot.yml* 文件时，这将触发对版本更新的立即检查。 更多信息和示例请参阅“[配置 {% data variables.product.prodname_dependabot %} 版本更新](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates#enabling-dependabot-version-updates)”。 下次安全警报触发安全更新的拉取请求时将使用所有同时影响安全更新的选项。 更多信息请参阅“[配置 {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)。” -*dependabot.yml* 文件有两个必需的顶级密钥：`version` 和 `updates`。 You can, optionally, include a top-level `registries` key{% ifversion fpt or ghec or ghes > 3.4 %} and/or a `enable-beta-ecosystems` key{% endif %}. 该文件必须以 `version: 2` 开头。 +*dependabot.yml* 文件有两个必需的顶级密钥：`version` 和 `updates`。 您可以选择包括顶级 `registries` 密钥{% ifversion fpt or ghec or ghes > 3.4 %} 和/或 `enable-beta-ecosystems` 密钥{% endif %}。 该文件必须以 `version: 2` 开头。 ## 更新的配置选项 顶级 `updates` 密钥是必需的。 您使用它来配置 {% data variables.product.prodname_dependabot %} 如何更新版本或项目的依赖项。 每个条目都为特定的包管理器配置更新设置。 您可以使用以下选项。 -| 选项 | 必选 | 描述 | -|:-------------------------------------------------------------------------- |:-----:|:-------------------------------------------------------------------------------------- | -| [`package-ecosystem`](#package-ecosystem) | **X** | 要使用的包管理器 | -| [`目录`](#directory) | **X** | 包清单位置 | -| [`schedule.interval`](#scheduleinterval) | **X** | 检查更新的频率 | -| [`allow`](#allow) | | 自定义允许的更新 | -| [`assignees`](#assignees) | | 要在拉取请求上设置的受让人 | -| [`commit-message`](#commit-message) | | Commit message preferences |{% ifversion fpt or ghec or ghes > 3.4 %} -| [`enable-beta-ecosystems`](#enable-beta-ecosystems) | | Enable ecosystems that have beta-level support +| 选项 | 必选 | 描述 | +|:-------------------------------------------------------------------------- |:-----:|:------------------------------------------------------------------- | +| [`package-ecosystem`](#package-ecosystem) | **X** | 要使用的包管理器 | +| [`目录`](#directory) | **X** | 包清单位置 | +| [`schedule.interval`](#scheduleinterval) | **X** | 检查更新的频率 | +| [`allow`](#allow) | | 自定义允许的更新 | +| [`assignees`](#assignees) | | 要在拉取请求上设置的受让人 | +| [`commit-message`](#commit-message) | | 提交消息首选项 |{% ifversion fpt or ghec or ghes > 3.4 %} +| [`enable-beta-ecosystems`](#enable-beta-ecosystems) | | 启用具有测试版级支持的生态系统 {% endif %} -| [`ignore`](#ignore) | | 忽略某些依赖项或版本 | -| [`insecure-external-code-execution`](#insecure-external-code-execution) | | 允许或拒绝清单文件中的代码执行 | -| [`labels`](#labels) | | 要在拉取请求上设置的标签 | -| [`里程碑`](#milestone) | | 要在拉取请求上设置的里程碑 | -| [`open-pull-requests-limit`](#open-pull-requests-limit) | | 限制对版本更新打开的拉取请求数 | -| [`pull-request-branch-name.separator`](#pull-request-branch-nameseparator) | | 更改拉取请求分支名称的分隔符 | -| [`rebase-strategy`](#rebase-strategy) | | 禁用自动变基 | -| [`registries`](#registries) | | {% data variables.product.prodname_dependabot %} 可以访问的私有注册表 | -| [`reviewers`](#reviewers) | | 要在拉取请求上设置的审查者 | -| [`schedule.day`](#scheduleday) | | 检查更新的周日期 | -| [`schedule.time`](#scheduletime) | | 每天检查更新的时间 (hh:mm) | -| [`schedule.timezone`](#scheduletimezone) | | 一天中时间的时区（区域标识符） | -| [`target-branch`](#target-branch) | | 对其创建拉取请求的分支 | -| [`vendor`](#vendor) | | 更新供应或缓存的依赖项 | -| [`versioning-strategy`](#versioning-strategy) | | 如何更新清单版本要求 | +| [`ignore`](#ignore) | | 忽略某些依赖项或版本 | +| [`insecure-external-code-execution`](#insecure-external-code-execution) | | 允许或拒绝清单文件中的代码执行 | +| [`labels`](#labels) | | 要在拉取请求上设置的标签 | +| [`里程碑`](#milestone) | | 要在拉取请求上设置的里程碑 | +| [`open-pull-requests-limit`](#open-pull-requests-limit) | | 限制对版本更新打开的拉取请求数 | +| [`pull-request-branch-name.separator`](#pull-request-branch-nameseparator) | | 更改拉取请求分支名称的分隔符 | +| [`rebase-strategy`](#rebase-strategy) | | 禁用自动变基 | +| [`registries`](#registries) | | {% data variables.product.prodname_dependabot %} 可以访问的私有注册表 | +| [`reviewers`](#reviewers) | | 要在拉取请求上设置的审查者 | +| [`schedule.day`](#scheduleday) | | 检查更新的周日期 | +| [`schedule.time`](#scheduletime) | | 每天检查更新的时间 (hh:mm) | +| [`schedule.timezone`](#scheduletimezone) | | 一天中时间的时区（区域标识符） | +| [`target-branch`](#target-branch) | | 对其创建拉取请求的分支 | +| [`vendor`](#vendor) | | 更新供应或缓存的依赖项 | +| [`versioning-strategy`](#versioning-strategy) | | 如何更新清单版本要求 | 这些选项大致分为以下类别。 @@ -174,7 +174,7 @@ updates: {% note %} -**注意**：`时间表` 定义 {% data variables.product.prodname_dependabot %} 尝试更新的时间。 但是，这不是您可收到拉取请求的唯一时间。 更新可基于 `dependabot.yml` 文件的更改、更新失败后清单文件的更改或 {% data variables.product.prodname_dependabot_security_updates %} 触发。 For more information, see "[Frequency of {% data variables.product.prodname_dependabot %} pull requests](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates#frequency-of-dependabot-pull-requests)" and "[About {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)." +**注意**：`时间表` 定义 {% data variables.product.prodname_dependabot %} 尝试更新的时间。 但是，这不是您可收到拉取请求的唯一时间。 更新可基于 `dependabot.yml` 文件的更改、更新失败后清单文件的更改或 {% data variables.product.prodname_dependabot_security_updates %} 触发。 更多信息请参阅“[{% data variables.product.prodname_dependabot %} 拉取请求的频率](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates#frequency-of-dependabot-pull-requests)”和“[关于 {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates)”。 {% endnote %} @@ -260,7 +260,7 @@ updates: {% note %} -**Note:** The `prefix` and the `prefix-development` options have a 15 character limit. +**注意**：`prefix` 和 `prefix-development` 选项限于 15 个字符。 {% endnote %} @@ -360,7 +360,7 @@ updates: {% ifversion fpt or ghec or ghes > 3.4 %} {% note %} -**Note**: For the `pub` ecosystem, {% data variables.product.prodname_dependabot %} won't perform an update when the version that it tries to update to is ignored, even if an earlier version is available. +**注意**：对于 `pub` 生态系统，当 {% data variables.product.prodname_dependabot %} 尝试更新的版本被忽略时，即使早期版本可用，也不会执行更新。 {% endnote %} @@ -984,11 +984,11 @@ registries: {% endraw %} {% ifversion fpt or ghec or ghes > 3.4 %} -## Enabling support for beta-level ecosystems +## 启用对测试版级生态系统的支持 ### `enable-beta-ecosystems` -By default, {% data variables.product.prodname_dependabot %} updates the dependency manifests and lock files only for fully supported ecosystems. Use the `enable-beta-ecosystems` flag to opt in to updates for ecosystems that are not yet generally available. +默认情况下，{% data variables.product.prodname_dependabot %} 仅为完全支持的生态系统更新依赖项清单和锁定文件。 使用 `enable-beta-ecosystems` 标志，选择加入尚未正式发布的生态系统的更新。 ```yaml # Configure beta ecosystem diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md index 6ab566601b..a8abfb5602 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md @@ -1,5 +1,5 @@ --- -title: Configuring Dependabot version updates +title: 配置 Dependabot 版本更新 intro: '您可以配置仓库，以便 {% data variables.product.prodname_dependabot %} 自动更新您使用的包。' permissions: 'People with write permissions to a repository can enable or disable {% data variables.product.prodname_dependabot_version_updates %} for the repository.' redirect_from: @@ -18,7 +18,7 @@ topics: - Repositories - Dependencies - Pull requests -shortTitle: Configure version updates +shortTitle: 配置版本更新 --- @@ -35,7 +35,7 @@ shortTitle: Configure version updates ## 启用 {% data variables.product.prodname_dependabot_version_updates %} -{% data reusables.dependabot.create-dependabot-yml %} For information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates)." +{% data reusables.dependabot.create-dependabot-yml %} 有关信息，请参阅“[dependabot.yml 文件的配置选项](/github/administering-a-repository/configuration-options-for-dependency-updates)”。 1. 添加 `version`。 1. （可选）如果您在私人注册表中包含依赖项，请添加包含身份验证详细信息的 `registries` 部分。 1. 添加 `updates` 部分，并输入您希望 {% data variables.product.prodname_dependabot %} 监控的每个包管理器的条目。 @@ -88,7 +88,7 @@ updates: ## 检查版本更新的状态 -After you enable version updates, the **Dependabot** tab in the dependency graph for the repository is populated. 此选项卡显示配置了哪些要监视的包管理器 {% data variables.product.prodname_dependabot %} 以及 {% data variables.product.prodname_dependabot %} 上次检查新版本的时间。 +启用版本更新后，将填充存储库的依赖关系图中的 **Dependabot** 选项卡。 此选项卡显示配置了哪些要监视的包管理器 {% data variables.product.prodname_dependabot %} 以及 {% data variables.product.prodname_dependabot %} 上次检查新版本的时间。 ![仓库洞察选项卡，依赖关系图，Dependabot 选项卡](/assets/images/help/dependabot/dependabot-tab-view.png) @@ -139,4 +139,4 @@ updates: update-types: ["version-update:semver-patch"] ``` -For more information about checking for existing ignore preferences, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#ignore)." +有关检查现有忽略首选项的详细信息，请参阅“[dependabot.yml 文件的配置选项](/github/administering-a-repository/configuration-options-for-dependency-updates#ignore)”。 diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md index 6bff12e745..755565487a 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md @@ -35,7 +35,7 @@ shortTitle: 自定义更新 - 更改为版本更新打开的拉取请求默认最大数 5：`open-pull-requests-limit` - 打开版本更新的拉取请求以定位特定分支，而不是默认分支：`target-branch` -For more information about the configuration options, see "[Configuration options for the dependabot.yml file](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)." +有关配置选项的详细信息，请参阅“[dependabot.yml 文件的配置选项](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)”。 更新仓库中的 *dependabot.yml* 文件时，{% data variables.product.prodname_dependabot %} 使用新配置即刻进行检查。 几分钟内，您将在 **{% data variables.product.prodname_dependabot %}** 选项卡上看到更新的依赖项列表，如果仓库有很多依赖项，可能需要更长时间。 您可能还会看到针对版本更新的新拉取请求。 更多信息请参阅“[列出为版本更新配置的依赖项](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates)”。 @@ -141,4 +141,4 @@ updates: ## 更多示例 -For more examples, see "[Configuration options for the dependabot.yml file](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)." +有关更多示例，请参阅“[dependabot.yml 文件的配置选项](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)”。 diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/index.md b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/index.md index 84e6ced50b..fb50c14bcb 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/index.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/index.md @@ -1,6 +1,6 @@ --- -title: Keeping your dependencies updated automatically with Dependabot version updates -intro: 'You can use {% data variables.product.prodname_dependabot %} to automatically keep the dependencies and packages used in your repository updated to the latest version, even when they don’t have any known vulnerabilities.' +title: 使用 Dependabot 版本更新自动更新依赖项 +intro: '您可以使用 {% data variables.product.prodname_dependabot %} 自动将存储库中使用的依赖项和包更新到最新版本，即使它们没有任何已知的漏洞。' allowTitleToDifferFromFilename: true redirect_from: - /github/administering-a-repository/keeping-your-dependencies-updated-automatically diff --git a/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/index.md b/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/index.md index 2ff0dbc0da..4d15872af4 100644 --- a/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/index.md +++ b/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/index.md @@ -1,7 +1,7 @@ --- -title: Working with Dependabot -shortTitle: Work with Dependabot -intro: 'Guidance and recommendations for working with {% data variables.product.prodname_dependabot %}, such as managing pull requests raised by {% data variables.product.prodname_dependabot %}, using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_dependabot %}, and troubleshooting {% data variables.product.prodname_dependabot %} errors.' +title: 使用 Dependabot +shortTitle: 使用 Dependabot +intro: '使用 {% data variables.product.prodname_dependabot %} 的指导和建议，例如管理 {% data variables.product.prodname_dependabot %} 提出的拉取请求，使用 {% data variables.product.prodname_actions %} 与 {% data variables.product.prodname_dependabot %}，以及排除 {% data variables.product.prodname_dependabot %} 错误。' versions: fpt: '*' ghec: '*' diff --git a/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/managing-encrypted-secrets-for-dependabot.md b/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/managing-encrypted-secrets-for-dependabot.md index f55ca00d33..7340ffee7f 100644 --- a/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/managing-encrypted-secrets-for-dependabot.md +++ b/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/managing-encrypted-secrets-for-dependabot.md @@ -34,7 +34,7 @@ password: ${{secrets.MY_ARTIFACTORY_PASSWORD}} ``` {% endraw %} -For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)." +更多信息请参阅“[dependabot.yml 文件的配置选项](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)。” ### 命名您的密码 diff --git a/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md b/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md index 87103c4b1f..79a5f478ca 100644 --- a/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md +++ b/translations/zh-CN/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md @@ -42,7 +42,7 @@ shortTitle: 管理 Dependabot PR ## 更改 {% data variables.product.prodname_dependabot %} 拉取请求的变基策略 -默认情况下，{% data variables.product.prodname_dependabot %} 会自动为拉取请求变基，以解决各种冲突。 如果您喜欢手动处理合并冲突，可以使用 `rebase-strategy` 选项禁用此功能。 For details, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#rebase-strategy)." +默认情况下，{% data variables.product.prodname_dependabot %} 会自动为拉取请求变基，以解决各种冲突。 如果您喜欢手动处理合并冲突，可以使用 `rebase-strategy` 选项禁用此功能。 有关详细信息，请参阅“[dependabot.yml 文件的配置选项](/github/administering-a-repository/configuration-options-for-dependency-updates#rebase-strategy)”。 ## 管理带注释命令的 {% data variables.product.prodname_dependabot %} 拉取请求 @@ -63,4 +63,4 @@ shortTitle: 管理 Dependabot PR {% data variables.product.prodname_dependabot %} 将用“竖起大拇指”表情符号来确认命令，并可能对拉取请求发表评论。 {% data variables.product.prodname_dependabot %} 通常快速响应，但如果 {% data variables.product.prodname_dependabot %} 正在忙于处理其他更新或命令，一些命令可能需要几分钟才能完成。 -如果您通过运行任何命令来忽略依赖项或版本，{% data variables.product.prodname_dependabot %} 将集中存储仓库的首选项。 虽然这是一种快速解决方案，但对于拥有多个参与者的仓库而言，最好是显式定义要在配置文件中忽略的依赖项和版本。 这样可以让所有参与者都能轻松了解某个特定依赖项为什么无法自动更新。 For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#ignore)." +如果您通过运行任何命令来忽略依赖项或版本，{% data variables.product.prodname_dependabot %} 将集中存储仓库的首选项。 虽然这是一种快速解决方案，但对于拥有多个参与者的仓库而言，最好是显式定义要在配置文件中忽略的依赖项和版本。 这样可以让所有参与者都能轻松了解某个特定依赖项为什么无法自动更新。 有关详细信息，请参阅“[dependabot.yml 文件的配置选项](/github/administering-a-repository/configuration-options-for-dependency-updates#ignore)。” diff --git a/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md b/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md index a7fff35eeb..d20b34c366 100644 --- a/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md +++ b/translations/zh-CN/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema.md @@ -101,7 +101,8 @@ topics: ```YAML{:copy} body: - type: markdown - value: "## Thank you for contributing to our project!" + attributes: + value: "## Thank you for contributing to our project!" - type: markdown attributes: value: | diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md b/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md index 90b5519f56..1a909a7f90 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md @@ -83,7 +83,7 @@ shortTitle: 应用程序创建查询参数 | `plan` | 授予使用“[获取用户](/rest/reference/users#get-a-user)”端点获取有关用户 GitHub 计划的信息的权限。 可以是以下项之一：`none` 或 `read`。 | | [`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | 授予对各种拉取请求端点的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | | [`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | 授予对[仓库 web 挂钩 API](/rest/reference/repos#hooks) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | -| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | 授予对[项目 API](/rest/reference/projects) 的访问权限。 可以是以下项之一：`none`、`read`、`write` 或 `admin`。{% ifversion fpt or ghes or ghec %} +| [`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | 授予对[项目 API](/rest/reference/projects) 的访问权限。 可以是以下项之一：`none`、`read`、`write` 或 `admin`。{% ifversion ghes or ghec %} | [`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | 授予对[密钥扫描 API](/rest/reference/secret-scanning) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% endif %}{% ifversion fpt or ghes or ghec %} | [`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | 授予对[代码扫描 API](/rest/reference/code-scanning/) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。{% endif %} | [`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | 授予对[内容 API](/rest/reference/repos#contents) 的访问权限。 可以是以下项之一：`none`、`read` 或 `write`。 | diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 7ee95a7438..3beae4bb20 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -39,43 +39,43 @@ X-Accepted-OAuth-Scopes: user ## 可用作用域 -| 名称 | 描述 | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} +| 名称 | 描述 | +| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |{% ifversion not ghae %} | **`（无作用域）`** | 授予对公共信息的只读访问权限（包括用户个人资料信息、公共仓库信息和 gist）{% endif %}{% ifversion ghes or ghae %} | **`site_admin`** | 授予站点管理员对 [{% data variables.product.prodname_ghe_server %} 管理 API 端点](/rest/reference/enterprise-admin)的访问权限。{% endif %} -| **`repo`** | 授予对仓库（包括私有仓库）的完全访问权限。 这包括对仓库和组织的代码、提交状态、仓库和组织项目、邀请、协作者、添加团队成员身份、部署状态以及仓库 web 挂钩的读取/写入权限。 还授予管理用户项目的权限。 | -|  `repo:status` | 授予对{% ifversion fpt %}公共和私有{% elsif ghec or ghes %}公共、私有和内部{% elsif ghae %}私有和内部{% endif %}仓库中的提交状态的读/写访问权限。 仅在授予其他用户或服务对私有仓库提交状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。 | +| **`repo`** | 授予对仓库（包括私有仓库）的完全访问权限。 这包括对仓库和组织的代码、提交状态、仓库和组织项目、邀请、协作者、添加团队成员身份、部署状态以及仓库 web 挂钩的读取/写入权限。 还授予管理用户项目的权限。 | +|  `repo:status` | 授予对{% ifversion fpt %}公共和私有{% elsif ghec or ghes %}公共、私有和内部{% elsif ghae %}私有和内部{% endif %}仓库中的提交状态的读/写访问权限。 仅在授予其他用户或服务对私有仓库提交状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。 | |  `repo_deployment` | 授予对{% ifversion not ghae %}公共{% else %}内部{% endif %}和私有仓库的[部署状态](/rest/reference/repos#deployments)的访问权限。 仅在授予其他用户或服务对部署状态的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% ifversion not ghae %} |  `public_repo` | 将访问权限限制为公共仓库。 这包括对公共仓库和组织的代码、提交状态、仓库项目、协作者以及部署状态的读取/写入权限。 标星公共仓库也需要此权限。{% endif %} |  `repo:invite` | 授予接受/拒绝仓库协作邀请的权限。 仅在授予其他用户或服务对邀请的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% ifversion fpt or ghes or ghec %} -|  `security_events` | 授予：
    对 [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) 中安全事件的读取和写入权限
    对 [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning) 中安全事件的读取和写入权限
    仅在授予其他用户或服务对安全事件的访问权限而*不*授予对代码的访问权限时，才需要此作用域。{% endif %} -| **`admin:repo_hook`** | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中仓库挂钩的读取、写入、ping 和删除访问权限。 `repo` {% ifversion fpt or ghec or ghes %}和 `public_repo` 范围授予{% else %}范围授予{% endif %}对仓库（包括仓库挂钩）的完全访问权限。 使用 `admin:repo_hook` 作用域将访问权限限制为仅仓库挂钩。 | -|  `write:repo_hook` | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中挂钩的读取、写入和 ping 访问权限。 | -|  `read:repo_hook` | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中挂钩的读取和 ping 访问权限。 | -| **`admin:org`** | 全面管理组织及其团队、项目和成员。 | -|  `write:org` | 对组织成员身份、组织项目和团队成员身份的读取和写入权限。 | -|  `read:org` | 对组织成员身份、组织项目和团队成员身份的只读权限。 | -| **`admin:public_key`** | 全面管理公钥。 | -|  `write:public_key` | 创建、列出和查看公钥的详细信息。 | -|  `read:public_key` | 列出和查看公钥的详细信息。 | -| **`admin:org_hook`** | 授予对组织挂钩的读取、写入、ping 和删除权限。 **注：**OAuth 令牌只能对由 OAuth 应用程序创建的组织挂钩执行这些操作。 个人访问令牌只能对用户创建的组织挂钩执行这些操作。 | -| **`gist`** | 授予对 gist 的写入权限。 | -| **`通知`** | 授予：
    * 对用户通知的读取权限
    * 对线程的标记读取权限
    * 对仓库的关注和取消关注权限，以及
    * 对线程订阅的读取、写入和删除权限。 | -| **`用户`** | 仅授予对个人资料的读取/写入权限。 请注意，此作用域包括 `user:email` 和 `user:follow`。 | -|  `read:user` | 授予读取用户个人资料数据的权限。 | -|  `user:email` | 授予对用户电子邮件地址的读取权限。 | -|  `user:follow` | 授予关注或取消关注其他用户的权限。 | -| **`delete_repo`** | 授予删除可管理仓库的权限。 | -| **`write:discussion`** | 授予对团队讨论的读取和写入权限。 | +|  `security_events` | Grants:
    read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning) {%- ifversion ghec %}
    read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning){%- endif %}
    This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} +| **`admin:repo_hook`** | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中仓库挂钩的读取、写入、ping 和删除访问权限。 `repo` {% ifversion fpt or ghec or ghes %}和 `public_repo` 范围授予{% else %}范围授予{% endif %}对仓库（包括仓库挂钩）的完全访问权限。 使用 `admin:repo_hook` 作用域将访问权限限制为仅仓库挂钩。 | +|  `write:repo_hook` | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中挂钩的读取、写入和 ping 访问权限。 | +|  `read:repo_hook` | 授予对{% ifversion fpt %}公共或私有{% elsif ghec or ghes %}公共、私有或内部{% elsif ghae %}私有或内部{% endif %}仓库中挂钩的读取和 ping 访问权限。 | +| **`admin:org`** | 全面管理组织及其团队、项目和成员。 | +|  `write:org` | 对组织成员身份、组织项目和团队成员身份的读取和写入权限。 | +|  `read:org` | 对组织成员身份、组织项目和团队成员身份的只读权限。 | +| **`admin:public_key`** | 全面管理公钥。 | +|  `write:public_key` | 创建、列出和查看公钥的详细信息。 | +|  `read:public_key` | 列出和查看公钥的详细信息。 | +| **`admin:org_hook`** | 授予对组织挂钩的读取、写入、ping 和删除权限。 **注：**OAuth 令牌只能对由 OAuth 应用程序创建的组织挂钩执行这些操作。 个人访问令牌只能对用户创建的组织挂钩执行这些操作。 | +| **`gist`** | 授予对 gist 的写入权限。 | +| **`通知`** | 授予：
    * 对用户通知的读取权限
    * 对线程的标记读取权限
    * 对仓库的关注和取消关注权限，以及
    * 对线程订阅的读取、写入和删除权限。 | +| **`用户`** | 仅授予对个人资料的读取/写入权限。 请注意，此作用域包括 `user:email` 和 `user:follow`。 | +|  `read:user` | 授予读取用户个人资料数据的权限。 | +|  `user:email` | 授予对用户电子邮件地址的读取权限。 | +|  `user:follow` | 授予关注或取消关注其他用户的权限。 | +| **`delete_repo`** | 授予删除可管理仓库的权限。 | +| **`write:discussion`** | 授予对团队讨论的读取和写入权限。 | |  `read:discussion` | 授予对团队讨论的读取权限。{% ifversion fpt or ghae or ghec %} -| **`write:packages`** | 授予在 {% data variables.product.prodname_registry %} 中上传或发布包的权限。 更多信息请参阅“[发布包](/github/managing-packages-with-github-packages/publishing-a-package)”。 | -| **`read:packages`** | 授予从 {% data variables.product.prodname_registry %} 下载或安装包的权限。 更多信息请参阅“[安装包](/github/managing-packages-with-github-packages/installing-a-package)”。 | +| **`write:packages`** | 授予在 {% data variables.product.prodname_registry %} 中上传或发布包的权限。 更多信息请参阅“[发布包](/github/managing-packages-with-github-packages/publishing-a-package)”。 | +| **`read:packages`** | 授予从 {% data variables.product.prodname_registry %} 下载或安装包的权限。 更多信息请参阅“[安装包](/github/managing-packages-with-github-packages/installing-a-package)”。 | | **`delete:packages`** | 授予从 {% data variables.product.prodname_registry %} 删除包的权限。 更多信息请参阅“[删除和恢复软件包](/packages/learn-github-packages/deleting-and-restoring-a-package)”。{% endif %} -| **`admin:gpg_key`** | 全面管理 GPG 密钥。 | -|  `write:gpg_key` | 创建、列出和查看 GPG 密钥的详细信息。 | +| **`admin:gpg_key`** | 全面管理 GPG 密钥。 | +|  `write:gpg_key` | 创建、列出和查看 GPG 密钥的详细信息。 | |  `read:gpg_key` | 列出和查看 GPG 密钥的详细信息。{% ifversion fpt or ghec %} | **`代码空间`** | 授予创建和管理代码空间的能力。 Codespaces 可以暴露可能有不同范围集的 GITHUB_TOKEN。 更多信息请参阅“[Codespaces 中的安全性](/codespaces/codespaces-reference/security-in-codespaces#authentication)”。{% endif %} -| **`工作流程`** | 授予添加和更新 {% data variables.product.prodname_actions %} 工作流程文件的权限。 如果在同一仓库中的另一个分支上存在相同的文件(具有相同的路径和内容)，则工作流程文件可以在没有此作用域的情况下提交。 工作流程文件可以暴露可能有不同范围集的 `GITHUB_TOKEN`。 更多信息请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)。 | +| **`工作流程`** | 授予添加和更新 {% data variables.product.prodname_actions %} 工作流程文件的权限。 如果在同一仓库中的另一个分支上存在相同的文件(具有相同的路径和内容)，则工作流程文件可以在没有此作用域的情况下提交。 工作流程文件可以暴露可能有不同范围集的 `GITHUB_TOKEN`。 更多信息请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)。 | {% note %} diff --git a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index fd9a2a196c..362eeec17d 100644 --- a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1216,7 +1216,7 @@ Web 挂钩事件是基于您注册的域的特异性而触发的。 例如，如 {% endif %} -{% ifversion fpt or ghes or ghec %} +{% ifversion ghes or ghec %} ## secret_scanning_alert @@ -1241,7 +1241,7 @@ Web 挂钩事件是基于您注册的域的特异性而触发的。 例如，如 {{ webhookPayloadsForCurrentVersion.secret_scanning_alert.reopened }} {% endif %} -{% ifversion fpt or ghes > 3.4 or ghec or ghae-issue-6581 %} +{% ifversion ghes > 3.4 or ghec or ghae-issue-6581 %} ## secret_scanning_alert_location {% data reusables.webhooks.secret_scanning_alert_location_event_short_desc %} diff --git a/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md b/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md index c1765c669b..81650321cd 100644 --- a/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md +++ b/translations/zh-CN/content/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud.md @@ -56,7 +56,9 @@ Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be ## Exploring {% data variables.product.prodname_ghe_cloud %} -After setting up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the [Enterprise Onboarding Guide](https://resources.github.com/enterprise-onboarding/). +After you set up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the suggested tasks on the "Overview" tab of your organization. If you've previously dismissed the tasks, you can access them again by clicking **Get started with suggested tasks** at the top of the page. + +!["Get started with suggested tasks" button](/assets/images/help/organizations/suggested-tasks-button.png) {% data reusables.docs.you-can-read-docs-for-your-product %} diff --git a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md index 653de529f3..48331281c7 100644 --- a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md +++ b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization.md @@ -1,7 +1,6 @@ --- title: 限制组织的电子邮件通知 intro: 为防止组织信息泄露到个人电子邮件帐户，您可以限制成员可以接收有关组织活动的电子邮件通知的域。 -product: '{% data reusables.gated-features.restrict-email-domain %}' permissions: Organization owners can restrict email notifications for an organization. redirect_from: - /articles/restricting-email-notifications-about-organization-activity-to-an-approved-email-domain @@ -10,7 +9,6 @@ redirect_from: - /organizations/keeping-your-organization-secure/restricting-email-notifications-to-an-approved-domain - /organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization versions: - fpt: '*' ghes: '>=3.2' ghec: '*' type: how_to @@ -26,11 +24,7 @@ shortTitle: 限制电子邮件通知 当在组织中启用受限制的电子邮件通知时，成员只能使用与已验证或批准的域关联的电子邮件地址接收有关组织活动的电子邮件通知。 更多信息请参阅“[验证或批准组织的域](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)”。 -{% data reusables.enterprise-accounts.approved-domains-beta-note %} - -{% data reusables.notifications.email-restrictions-verification %} - -{% ifversion fpt or ghec %} +{% ifversion ghec %} {% note %} **注意：** 若要限制电子邮件通知，您的组织必须使用 {% data variables.product.prodname_ghe_cloud %}。 {% data reusables.enterprise.link-to-ghec-trial %} @@ -38,6 +32,8 @@ shortTitle: 限制电子邮件通知 {% endnote %} {% endif %} +{% data reusables.notifications.email-restrictions-verification %} + 外部协作者不受限于已验证或批准域的电子邮件通知。 有关外部协作者的更多信息，请参阅“[组织中的角色](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators)”。 如果您的组织由企业帐户拥有，则组织成员除了能够接收来自组织的任何已验证或批准域的通知之外，还能够接收来自企业帐户的任何已验证或批准域的通知。 更多信息请参阅“[验证或批准企业的域](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)”。 diff --git a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index 265289d743..b712fd998e 100644 --- a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -132,9 +132,15 @@ Using the qualifier `country`, you can filter events in the audit log based on t ## Using the audit log API +{% ifversion fpt %} + +Organizations that use {% data variables.product.prodname_ghe_cloud %} can interact with the audit log using the GraphQL API and REST API. For more information, see [the {% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#using-the-audit-log-api). + +{% else %} + You can interact with the audit log using the GraphQL API{% ifversion fpt or ghec %} or the REST API{% endif %}. -{% ifversion fpt or ghec %} +{% ifversion ghec %} {% note %} @@ -149,7 +155,7 @@ You can interact with the audit log using the GraphQL API{% ifversion fpt or ghe To ensure your intellectual property is secure, and you maintain compliance for your organization, you can use the audit log GraphQL API to keep copies of your audit log data and monitor: {% data reusables.audit_log.audit-log-api-info %} -{% ifversion fpt or ghec %} +{% ifversion ghec %} Note that you can't retrieve Git events using the GraphQL API. To retrieve Git events, use the REST API instead. For more information, see "[`git` category actions](#git-category-actions)." {% endif %} @@ -157,7 +163,7 @@ The GraphQL response can include data for up to 90 to 120 days. For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/reference/interfaces#auditentry/)." -{% ifversion fpt or ghec %} +{% ifversion ghec %} ### Using the REST API @@ -170,6 +176,7 @@ By default, only events from the past three months are returned. To include olde For more information about the audit log REST API, see "[Organizations](/rest/reference/orgs#get-the-audit-log-for-an-organization)." +{% endif %} {% endif %} ## Audit log actions diff --git a/translations/zh-CN/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md b/translations/zh-CN/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md index 280fffbcc0..407a3ee05c 100644 --- a/translations/zh-CN/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md +++ b/translations/zh-CN/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md @@ -1,7 +1,6 @@ --- title: 验证或批准您组织的域 intro: '您可以通过 {% data variables.product.company_short %} 验证您对域的所有权，确认您的组织身份。 您也可以批准 {% data variables.product.company_short %} 可以为您的组织成员发送电子邮件通知的域名。' -product: '{% data reusables.gated-features.verify-and-approve-domain %}' redirect_from: - /articles/verifying-your-organization-s-domain - /articles/verifying-your-organizations-domain @@ -9,7 +8,6 @@ redirect_from: - /organizations/managing-organization-settings/verifying-your-organizations-domain permissions: Organization owners can verify or approve a domain for an organization. versions: - fpt: '*' ghes: '>=3.2' ghec: '*' type: how_to @@ -23,15 +21,25 @@ shortTitle: 验证或批准域 ## 关于域验证 -验证组织域的所有权后，将在组织的资料中显示“Verified（已验证）”徽章。 {% ifversion fpt or ghec %}如果您的组织位于 {% data variables.product.prodname_ghe_cloud %} 上并且已同意公司服务条款，则组织所有者将能够通过查看验证域内每个成员的电子邮件地址来验证组织成员的身份。 更多信息请参阅“[关于组织的资料页面](/articles/about-your-organization-s-profile/)”和“升级到公司服务条款”。{% endif %} +验证组织域的所有权后，将在组织的资料中显示“Verified（已验证）”徽章。 {% ifversion ghec %}If your organization has agreed to the Corporate Terms of Service, organization owners will be able to verify the identity of organization members by viewing each member's email address within the verified domain. 更多信息请参阅“[关于组织的资料页面](/articles/about-your-organization-s-profile/)”和“升级到公司服务条款”。{% endif %} -{% ifversion fpt or ghec %}如果您的组织由企业帐户拥有，则{% elsif ghes %}{% endif %}“已验证”徽章将显示在组织的基本资料上，除了显示组织的任何已验证域之外，还能够显示企业帐户的任何已验证域。 组织所有者可以查看企业所有者已验证或批准的任何域，如果组织所有者也是企业所有者，则可以编辑域名。 {% ifversion fpt or ghec %}更多信息请参阅“[验证或批准企业的域](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)”。{% endif %}{% ifversion ghes > 3.1 %}更多信息请参阅“[验证或批准企业的域](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)”。{% endif %} +{% ifversion ghec %}如果您的组织由企业帐户拥有，则{% elsif ghes %}{% endif %}“已验证”徽章将显示在组织的基本资料上，除了显示组织的任何已验证域之外，还能够显示企业帐户的任何已验证域。 组织所有者可以查看企业所有者已验证或批准的任何域，如果组织所有者也是企业所有者，则可以编辑域名。 更多信息请参阅“[验证或批准企业的域](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)”。 + +{% ifversion ghec %} +{% note %} + +**Note:** To verify or approve domains, your organization must use {% data variables.product.prodname_ghe_cloud %}. {% data reusables.enterprise.link-to-ghec-trial %} + +{% endnote %} +{% endif %} {% data reusables.organizations.verified-domains-details %} -{% ifversion fpt or ghec %}在 {% data variables.product.prodname_ghe_cloud %} 上，验证组织域的所有权后，您可以将组织的电子邮件通知限制为该域。 更多信息请参阅“[限制组织的电子邮件通知](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)”。 {% ifversion fpt %}{% data reusables.enterprise.link-to-ghec-trial %}{% endif %}{% endif %} +{% ifversion ghec or ghes > 3.1 %} +After verifying ownership of your organization's domain, you can restrict email notifications for the organization to that domain. 更多信息请参阅“[限制组织的电子邮件通知](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)”。 +{% endif %} -{% ifversion fpt or ghec %}您还可以验证用于 {% data variables.product.prodname_pages %} 的自定义域，以防止在自定义域保持配置状态但您的 {% data variables.product.prodname_pages %} 站点被禁用或不再使用该域时域接管。 更多信息请参阅“[验证 {% data variables.product.prodname_pages %} 的自定义域](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)”。{% endif %} +{% ifversion ghec %}您还可以验证用于 {% data variables.product.prodname_pages %} 的自定义域，以防止在自定义域保持配置状态但您的 {% data variables.product.prodname_pages %} 站点被禁用或不再使用该域时域接管。 更多信息请参阅“[验证 {% data variables.product.prodname_pages %} 的自定义域](/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages)”。{% endif %} ## 关于域批准 @@ -43,7 +51,7 @@ shortTitle: 验证或批准域 企业所有者无法看到哪个组织成员或电子邮件地址在已批准的域内接收通知。 -企业所有者也可以批准企业拥有的其他组织的域名。 {% ifversion fpt or ghec %}更多信息请参阅“[验证或批准企业的域](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)”。{% endif %}{% ifversion ghes > 3.1 %}更多信息请参阅“[验证或批准企业的域](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)”。{% endif %} +企业所有者也可以批准企业拥有的其他组织的域名。 {% ifversion ghec %}更多信息请参阅“[验证或批准企业的域](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)”。{% endif %}{% ifversion ghes > 3.1 %}更多信息请参阅“[验证或批准企业的域](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)”。{% endif %} ## 验证组织的域 @@ -65,12 +73,8 @@ shortTitle: 验证或批准域 ## Approving a domain for your organization -{% ifversion fpt or ghes > 3.1 or ghec %} - {% data reusables.enterprise-accounts.approved-domains-beta-note %} -{% endif %} - {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.verified-domains %} diff --git a/translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md b/translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md index 115d3689f7..8ab947f4f8 100644 --- a/translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md +++ b/translations/zh-CN/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md @@ -92,9 +92,10 @@ shortTitle: 组织中的角色 | 设置预定提醒（请参阅“[管理拉取请求的预定提醒](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests)”） | **X** | | | | | | 添加协作者到**所有仓库** | **X** | | | | | | 访问组织审核日志 | **X** | | | | | -| 编辑组织的资料页面（请参阅“[关于组织的资料](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile)”） | **X** | | | | | +| 编辑组织的资料页面（请参阅“[关于组织的资料](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile)”） | **X** | | | | |{% ifversion ghec %} | 验证组织的域（请参阅“[验证组织的域](/articles/verifying-your-organization-s-domain)”） | **X** | | | | | -| 将电子邮件通知限于已经验证或批准的域名（请参阅“[限制组织的电子邮件通知](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)”） | **X** | | | | | +| 将电子邮件通知限于已经验证或批准的域名（请参阅“[限制组织的电子邮件通知](/organizations/keeping-your-organization-secure/restricting-email-notifications-for-your-organization)”） | **X** | | | | +{% endif %} | 删除**所有团队** | **X** | | | | | | 删除组织帐户，包括所有仓库 | **X** | | | | | | 创建团队（请参阅“[在组织中设置团队创建权限](/articles/setting-team-creation-permissions-in-your-organization)”） | **X** | **X** | **X** | | **X** | diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md index 2623012b10..53c29dde25 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork.md @@ -17,7 +17,7 @@ topics: shortTitle: 从复刻创建 PR --- -您也可以授权上游仓库的维护员将提交推送到用户拥有的复刻。 如果您的拉取请求将上游仓库中的分支作为与主题分支进行比较的基本分支，则您的主题分支也称为该拉取请求的比较分支 。 有关拉取请求分支的更多信息，包括示例，请参阅“[创建拉取请求](/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository)”。 +如果您的拉取请求将上游仓库中的分支作为与主题分支进行比较的基本分支，则您的主题分支也称为该拉取请求的比较分支 。 有关拉取请求分支的更多信息，包括示例，请参阅“[创建拉取请求](/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository)”。 {% data reusables.pull_requests.perms-to-open-pull-request %} diff --git a/translations/zh-CN/content/rest/actions/artifacts.md b/translations/zh-CN/content/rest/actions/artifacts.md new file mode 100644 index 0000000000..50728ce183 --- /dev/null +++ b/translations/zh-CN/content/rest/actions/artifacts.md @@ -0,0 +1,15 @@ +--- +title: Artifacts +intro: 'The Artifacts API allows you to download, delete, and retrieve information about workflow artifacts.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-artifacts %} For more information, see "[Persisting workflow data using artifacts](/actions/automating-your-workflow-with-github-actions/persisting-workflow-data-using-artifacts)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/actions/cache.md b/translations/zh-CN/content/rest/actions/cache.md new file mode 100644 index 0000000000..227622ec99 --- /dev/null +++ b/translations/zh-CN/content/rest/actions/cache.md @@ -0,0 +1,11 @@ +--- +title: Cache +intro: 'The Cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories.' +topics: + - API +versions: + fpt: '*' + ghec: '*' +--- + +The cache API allows you to query and manage the {% data variables.product.prodname_actions %} cache for repositories. For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)." diff --git a/translations/zh-CN/content/rest/actions/index.md b/translations/zh-CN/content/rest/actions/index.md new file mode 100644 index 0000000000..1eef306da9 --- /dev/null +++ b/translations/zh-CN/content/rest/actions/index.md @@ -0,0 +1,26 @@ +--- +title: Actions +intro: 'With the Actions API, you can manage and control {% data variables.product.prodname_actions %} for an organization or repository.' +redirect_from: + - /v3/actions + - /rest/reference/actions +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /artifacts + - /cache + - /permissions + - /secrets + - /self-hosted-runner-groups + - /self-hosted-runners + - /workflow-jobs + - /workflow-runs + - /workflows +--- +The {% data variables.product.prodname_actions %} API enables you to manage {% data variables.product.prodname_actions %} using the REST API. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/actions/permissions.md b/translations/zh-CN/content/rest/actions/permissions.md new file mode 100644 index 0000000000..250824f7dd --- /dev/null +++ b/translations/zh-CN/content/rest/actions/permissions.md @@ -0,0 +1,15 @@ +--- +title: Permissions +intro: 'The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Permissions + +The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/actions/secrets.md b/translations/zh-CN/content/rest/actions/secrets.md new file mode 100644 index 0000000000..bb9cdca350 --- /dev/null +++ b/translations/zh-CN/content/rest/actions/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. ' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/actions/self-hosted-runner-groups.md b/translations/zh-CN/content/rest/actions/self-hosted-runner-groups.md new file mode 100644 index 0000000000..77b15aa36f --- /dev/null +++ b/translations/zh-CN/content/rest/actions/self-hosted-runner-groups.md @@ -0,0 +1,17 @@ +--- +title: Self-hosted runner groups +intro: 'The Self-hosted Runners Groups API allows you manage groups of self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Self-hosted runner groups + +The Self-hosted Runners Groups API allows you manage groups of self-hosted runners. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/actions/self-hosted-runners.md b/translations/zh-CN/content/rest/actions/self-hosted-runners.md new file mode 100644 index 0000000000..61c8aa3d5a --- /dev/null +++ b/translations/zh-CN/content/rest/actions/self-hosted-runners.md @@ -0,0 +1,17 @@ +--- +title: Self-hosted runners +intro: 'The Self-hosted Runners API allows you to register, view, and delete self-hosted runners.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## Self-hosted runners + +The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use this API. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/actions/workflow-jobs.md b/translations/zh-CN/content/rest/actions/workflow-jobs.md new file mode 100644 index 0000000000..469ea0382f --- /dev/null +++ b/translations/zh-CN/content/rest/actions/workflow-jobs.md @@ -0,0 +1,15 @@ +--- +title: Workflow jobs +intro: 'The Workflow Jobs API allows you to view logs and workflow jobs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/actions/workflow-runs.md b/translations/zh-CN/content/rest/actions/workflow-runs.md new file mode 100644 index 0000000000..3fca12a420 --- /dev/null +++ b/translations/zh-CN/content/rest/actions/workflow-runs.md @@ -0,0 +1,15 @@ +--- +title: Workflow runs +intro: 'The Workflow Runs API allows you to view, re-run, cancel, and view logs for workflow runs.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/actions/workflows.md b/translations/zh-CN/content/rest/actions/workflows.md new file mode 100644 index 0000000000..55dad18cea --- /dev/null +++ b/translations/zh-CN/content/rest/actions/workflows.md @@ -0,0 +1,15 @@ +--- +title: Workflows +intro: 'The Workflows API allows you to view workflows for a repository.' +topics: + - API +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)." + +{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/activity/events.md b/translations/zh-CN/content/rest/activity/events.md new file mode 100644 index 0000000000..9b3f58527b --- /dev/null +++ b/translations/zh-CN/content/rest/activity/events.md @@ -0,0 +1,33 @@ +--- +title: Events +intro: 'The Events API is a read-only API to the {% data variables.product.prodname_dotcom %} events.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These events power the various activity streams on the site. + +The Events API can return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive from the Events API, see "[{% data variables.product.prodname_dotcom %} Event types](/developers/webhooks-and-events/github-event-types)." An events API for repository issues is also available. For more information, see the "[Issue Events API](/rest/reference/issues#events)." + +Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events +> HTTP/2 200 +> X-Poll-Interval: 60 +> ETag: "a18c3bded88eb5dbb5c849a489412bf3" + +# The quotes around the ETag value are important +$ curl -I {% data variables.product.api_url_pre %}/users/tater/events \ +$ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). \ No newline at end of file diff --git a/translations/zh-CN/content/rest/activity/feeds.md b/translations/zh-CN/content/rest/activity/feeds.md new file mode 100644 index 0000000000..e11e4cf1f4 --- /dev/null +++ b/translations/zh-CN/content/rest/activity/feeds.md @@ -0,0 +1,63 @@ +--- +title: Feeds +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Example of getting an Atom feed + +To get a feed in Atom format, you must specify the `application/atom+xml` type in the `Accept` header. For example, to get the Atom feed for GitHub security advisories: + + curl -H "Accept: application/atom+xml" https://github.com/security-advisories + +#### Response + +```shell +HTTP/2 200 +``` + +```xml + + + tag:github.com,2008:/security-advisories + + GitHub Security Advisory Feed + + GitHub + + 2019-01-14T19:34:52Z + + tag:github.com,2008:GHSA-abcd-12ab-23cd + 2018-07-26T15:14:52Z + 2019-01-14T19:34:52Z + [GHSA-abcd-12ab-23cd] Moderate severity vulnerability that affects Octoapp + + + <p>Octoapp node module before 4.17.5 suffers from a Modification of Assumed-Immutable Data (MAID) vulnerability via defaultsDeep, merge, and mergeWith functions, which allows a malicious user to modify the prototype of "Object" via <strong>proto</strong>, causing the addition or modification of an existing property that will exist on all objects.</p> + <p><strong>Affected Packages</strong></p> + + <dl> + <dt>Octoapp</dt> + <dd>Ecosystem: npm</dd> + <dd>Severity: moderate</dd> + <dd>Versions: &lt; 4.17.5</dd> + <dd>Fixed in: 4.17.5</dd> + </dl> + + <p><strong>References</strong></p> + + <ul> + <li>https://nvd.nist.gov/vuln/detail/CVE-2018-123</li> + </ul> + + + + +``` \ No newline at end of file diff --git a/translations/zh-CN/content/rest/activity/index.md b/translations/zh-CN/content/rest/activity/index.md new file mode 100644 index 0000000000..3f18631406 --- /dev/null +++ b/translations/zh-CN/content/rest/activity/index.md @@ -0,0 +1,21 @@ +--- +title: Activity +intro: 'The Activity API allows you to list events and feeds and manage notifications, starring, and watching for the authenticated user.' +redirect_from: + - /v3/activity + - /rest/reference/activity +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /events + - /feeds + - /notifications + - /starring + - /watching +--- diff --git a/translations/zh-CN/content/rest/activity/notifications.md b/translations/zh-CN/content/rest/activity/notifications.md new file mode 100644 index 0000000000..49678f8f9c --- /dev/null +++ b/translations/zh-CN/content/rest/activity/notifications.md @@ -0,0 +1,70 @@ +--- +title: Notifications +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Users receive notifications for conversations in repositories they watch including: + +* Issues and their comments +* Pull Requests and their comments +* Comments on any commits + +Notifications are also sent for conversations in unwatched repositories when the user is involved including: + +* **@mentions** +* Issue assignments +* Commits the user authors or commits +* Any discussion in which the user actively participates + +All Notification API calls require the `notifications` or `repo` API scopes. Doing this will give read-only access to some issue and commit content. You will still need the `repo` scope to access issues and commits from their respective endpoints. + +Notifications come back as "threads". A thread contains information about the current discussion of an issue, pull request, or commit. + +Notifications are optimized for polling with the `Last-Modified` header. If there are no new notifications, you will see a `304 Not Modified` response, leaving your current rate limit untouched. There is an `X-Poll-Interval` header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. + +``` shell +# Add authentication to your requests +$ curl -I {% data variables.product.api_url_pre %}/notifications +HTTP/2 200 +Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT +X-Poll-Interval: 60 + +# Pass the Last-Modified header exactly +$ curl -I {% data variables.product.api_url_pre %}/notifications +$ -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT" +> HTTP/2 304 +> X-Poll-Interval: 60 +``` + +### Notification reasons + +When retrieving responses from the Notifications API, each payload has a key titled `reason`. These correspond to events that trigger a notification. + +Here's a list of potential `reason`s for receiving a notification: + +Reason Name | Description +------------|------------ +`assign` | You were assigned to the issue. +`author` | You created the thread. +`comment` | You commented on the thread. +`ci_activity` | A {% data variables.product.prodname_actions %} workflow run that you triggered was completed. +`invitation` | You accepted an invitation to contribute to the repository. +`manual` | You subscribed to the thread (via an issue or pull request). +`mention` | You were specifically **@mentioned** in the content. +`review_requested` | You, or a team you're a member of, were requested to review a pull request.{% ifversion fpt or ghec %} +`security_alert` | {% data variables.product.prodname_dotcom %} discovered a [security vulnerability](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in your repository.{% endif %} +`state_change` | You changed the thread state (for example, closing an issue or merging a pull request). +`subscribed` | You're watching the repository. +`team_mention` | You were on a team that was mentioned. + +Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different. + +For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then **@mentioned** on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/activity/starring.md b/translations/zh-CN/content/rest/activity/starring.md new file mode 100644 index 0000000000..9c45ddad6f --- /dev/null +++ b/translations/zh-CN/content/rest/activity/starring.md @@ -0,0 +1,30 @@ +--- +title: Starring +intro: 'Repository starring is a feature that lets users bookmark repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. + +### Starring vs. Watching + +In August 2012, we [changed the way watching +works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Many API +client applications may be using the original "watcher" endpoints for accessing +this data. You can now start using the "star" endpoints instead (described +below). For more information, see the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) and the "[Repository Watching API](/rest/reference/activity#watching)." + +### Custom media types for starring + +There is one supported custom media type for the Starring REST API. When you use this custom media type, you will receive a response with the `starred_at` timestamp property that indicates the time the star was created. The response also has a second property that includes the resource that is returned when the custom media type is not included. The property that contains the resource will be either `user` or `repo`. + + application/vnd.github.v3.star+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/activity/watching.md b/translations/zh-CN/content/rest/activity/watching.md new file mode 100644 index 0000000000..10f078782e --- /dev/null +++ b/translations/zh-CN/content/rest/activity/watching.md @@ -0,0 +1,14 @@ +--- +title: Watching +intro: "Watching a repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For simple repository bookmarks, see "[Repository starring](/rest/reference/activity#starring)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/apps/apps.md b/translations/zh-CN/content/rest/apps/apps.md new file mode 100644 index 0000000000..7f7fa4b74f --- /dev/null +++ b/translations/zh-CN/content/rest/apps/apps.md @@ -0,0 +1,22 @@ +--- +title: Apps +intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +{% data reusables.apps.general-apps-restrictions %} + +This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more. + +When authenticated as a GitHub App, the GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of an app. + +You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user. + +A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints. diff --git a/translations/zh-CN/content/rest/apps/index.md b/translations/zh-CN/content/rest/apps/index.md new file mode 100644 index 0000000000..5bbc724e11 --- /dev/null +++ b/translations/zh-CN/content/rest/apps/index.md @@ -0,0 +1,21 @@ +--- +title: Apps +intro: The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps. +redirect_from: + - /v3/apps + - /rest/reference/apps +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /apps + - /installations + - /marketplace + - /oauth-applications + - /webhooks +--- diff --git a/translations/zh-CN/content/rest/apps/installations.md b/translations/zh-CN/content/rest/apps/installations.md new file mode 100644 index 0000000000..8e858caed4 --- /dev/null +++ b/translations/zh-CN/content/rest/apps/installations.md @@ -0,0 +1,16 @@ +--- +title: Installations +intro: 'The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations.' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." + +To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." diff --git a/translations/zh-CN/content/rest/apps/marketplace.md b/translations/zh-CN/content/rest/apps/marketplace.md new file mode 100644 index 0000000000..d49e3bed46 --- /dev/null +++ b/translations/zh-CN/content/rest/apps/marketplace.md @@ -0,0 +1,22 @@ +--- +title: Marketplace +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' +--- + +For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)." + +The {% data variables.product.prodname_marketplace %} API allows you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription. + +### Testing with stubbed endpoints + +This API includes endpoints that allow you to [test your {% data variables.product.prodname_github_app %}](/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/) with **stubbed data**. Stubbed data is hard-coded, fake data that will not change based on actual subscriptions. + +To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether API logic succeeds before listing {% data variables.product.prodname_github_apps %} on {% data variables.product.prodname_marketplace %}. + +Be sure to replace stubbed endpoints with production endpoints before deploying your {% data variables.product.prodname_github_app %}. diff --git a/translations/zh-CN/content/rest/apps/oauth-applications.md b/translations/zh-CN/content/rest/apps/oauth-applications.md new file mode 100644 index 0000000000..037850e51c --- /dev/null +++ b/translations/zh-CN/content/rest/apps/oauth-applications.md @@ -0,0 +1,14 @@ +--- +title: OAuth Applications +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. diff --git a/translations/zh-CN/content/rest/apps/webhooks.md b/translations/zh-CN/content/rest/apps/webhooks.md new file mode 100644 index 0000000000..c3cf61466f --- /dev/null +++ b/translations/zh-CN/content/rest/apps/webhooks.md @@ -0,0 +1,14 @@ +--- +title: Webhooks +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %} diff --git a/translations/zh-CN/content/rest/billing.md b/translations/zh-CN/content/rest/billing.md new file mode 100644 index 0000000000..6f9ccd86a6 --- /dev/null +++ b/translations/zh-CN/content/rest/billing.md @@ -0,0 +1,15 @@ +--- +title: Billing +intro: '' +topics: + - API +miniTocMaxHeadingLevel: 3 +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.4' +redirect_from: + - /rest/reference/billing +--- + +You can get billing information for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#billing)" REST API. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/branches/branch-protection.md b/translations/zh-CN/content/rest/branches/branch-protection.md new file mode 100644 index 0000000000..e831cd0fea --- /dev/null +++ b/translations/zh-CN/content/rest/branches/branch-protection.md @@ -0,0 +1,13 @@ +--- +title: Protected branches +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/branches/branches.md b/translations/zh-CN/content/rest/branches/branches.md new file mode 100644 index 0000000000..99f1050d0a --- /dev/null +++ b/translations/zh-CN/content/rest/branches/branches.md @@ -0,0 +1,12 @@ +--- +title: Branches +intro: 'The Branches API allows you to modify branches and their protection settings.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/zh-CN/content/rest/branches/index.md b/translations/zh-CN/content/rest/branches/index.md new file mode 100644 index 0000000000..6b13175895 --- /dev/null +++ b/translations/zh-CN/content/rest/branches/index.md @@ -0,0 +1,18 @@ +--- +title: Branches +intro: The branches API allows you to modify branches and their protection settings. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /branches + - /branch-protection +redirect_from: + - /rest/reference/branches +--- diff --git a/translations/zh-CN/content/rest/checks/index.md b/translations/zh-CN/content/rest/checks/index.md new file mode 100644 index 0000000000..6b0e064cb8 --- /dev/null +++ b/translations/zh-CN/content/rest/checks/index.md @@ -0,0 +1,20 @@ +--- +title: Checks +intro: 'With the Checks API, you can build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' +redirect_from: + - /v3/checks + - /rest/reference/checks +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /runs + - /suites +--- + +You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/checks/runs.md b/translations/zh-CN/content/rest/checks/runs.md new file mode 100644 index 0000000000..c49d26fd02 --- /dev/null +++ b/translations/zh-CN/content/rest/checks/runs.md @@ -0,0 +1,13 @@ +--- +title: Check Runs +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/checks/suites.md b/translations/zh-CN/content/rest/checks/suites.md new file mode 100644 index 0000000000..9aec42aad3 --- /dev/null +++ b/translations/zh-CN/content/rest/checks/suites.md @@ -0,0 +1,19 @@ +--- +title: Check Suites +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% note %} + + **Note:** A GitHub App only receives one [`check_suite`](/webhooks/event-payloads/#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks/event-payloads/#create) events. + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/code-scanning.md b/translations/zh-CN/content/rest/code-scanning.md new file mode 100644 index 0000000000..8c464645a9 --- /dev/null +++ b/translations/zh-CN/content/rest/code-scanning.md @@ -0,0 +1,32 @@ +--- +title: Code Scanning +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API + - Code scanning + - REST +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/code-scanning +--- + +{% data reusables.code-scanning.beta %} + +The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[Finding security vulnerabilities and errors in your code](/github/finding-security-vulnerabilities-and-errors-in-your-code)." + +{% ifversion fpt or ghes > 3.0 or ghae or ghec %} +### Custom media type for {% data variables.product.prodname_code_scanning %} + +There is one supported custom media type for the {% data variables.product.prodname_code_scanning %} REST API. + + application/sarif+json + +You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. For more information about this operation, see "[Get a {% data variables.product.prodname_code_scanning %} analysis for a repository](#get-a-code-scanning-analysis-for-a-repository)." When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than the summary of the analysis that's returned when you use the default media type. The response also includes additional data such as the `github/alertNumber` and `github/alertUrl` properties. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + +For more information, see "[Media types](/rest/overview/media-types)." +{% endif %} diff --git a/translations/zh-CN/content/rest/codes-of-conduct.md b/translations/zh-CN/content/rest/codes-of-conduct.md new file mode 100644 index 0000000000..dd96f59734 --- /dev/null +++ b/translations/zh-CN/content/rest/codes-of-conduct.md @@ -0,0 +1,16 @@ +--- +title: Codes of Conduct +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/codes-of-conduct +--- + +You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a repository's code of conduct, use the "[Get a repository](/rest/reference/repos#get-a-repository)" endpoint. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/codespaces/codespaces.md b/translations/zh-CN/content/rest/codespaces/codespaces.md new file mode 100644 index 0000000000..11d920b1c2 --- /dev/null +++ b/translations/zh-CN/content/rest/codespaces/codespaces.md @@ -0,0 +1,14 @@ +--- +title: Codespaces +intro: 'The Codespaces API enables you to manage your codespaces using the REST API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% data reusables.codespaces.codespaces-api-beta-note %} + +The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)." diff --git a/translations/zh-CN/content/rest/codespaces/index.md b/translations/zh-CN/content/rest/codespaces/index.md new file mode 100644 index 0000000000..d97a0755c0 --- /dev/null +++ b/translations/zh-CN/content/rest/codespaces/index.md @@ -0,0 +1,18 @@ +--- +title: Codespaces +intro: 'The {% data variables.product.prodname_codespaces %} API enables you to manage your codespaces using the REST API.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /codespaces + - /machines + - /repository-secrets + - /secrets +redirect_from: + - /rest/reference/codespaces +--- diff --git a/translations/zh-CN/content/rest/codespaces/machines.md b/translations/zh-CN/content/rest/codespaces/machines.md new file mode 100644 index 0000000000..b39416253f --- /dev/null +++ b/translations/zh-CN/content/rest/codespaces/machines.md @@ -0,0 +1,14 @@ +--- +title: Machines +intro: 'The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)." + +You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/codespaces/repository-secrets.md b/translations/zh-CN/content/rest/codespaces/repository-secrets.md new file mode 100644 index 0000000000..ccab41f36e --- /dev/null +++ b/translations/zh-CN/content/rest/codespaces/repository-secrets.md @@ -0,0 +1,15 @@ +--- +title: Repository Secrets +intro: 'The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.5' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +## Repository Secrets + +The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/codespaces/secrets.md b/translations/zh-CN/content/rest/codespaces/secrets.md new file mode 100644 index 0000000000..fb315dc8ce --- /dev/null +++ b/translations/zh-CN/content/rest/codespaces/secrets.md @@ -0,0 +1,15 @@ +--- +title: User Secrets +intro: 'The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +## User Secrets + +The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/collaborators/collaborators.md b/translations/zh-CN/content/rest/collaborators/collaborators.md new file mode 100644 index 0000000000..e2c617d39f --- /dev/null +++ b/translations/zh-CN/content/rest/collaborators/collaborators.md @@ -0,0 +1,12 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/collaborators/index.md b/translations/zh-CN/content/rest/collaborators/index.md new file mode 100644 index 0000000000..925f1ff4e9 --- /dev/null +++ b/translations/zh-CN/content/rest/collaborators/index.md @@ -0,0 +1,18 @@ +--- +title: Collaborators +intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /collaborators + - /invitations +redirect_from: + - /rest/reference/collaborators +--- diff --git a/translations/zh-CN/content/rest/collaborators/invitations.md b/translations/zh-CN/content/rest/collaborators/invitations.md new file mode 100644 index 0000000000..502e22608a --- /dev/null +++ b/translations/zh-CN/content/rest/collaborators/invitations.md @@ -0,0 +1,22 @@ +--- +title: Invitations +intro: 'The Repository Invitations API allows users or external services to invite other users to collaborate on a repo.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. + +Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted +access to invitations **without** also granting access to repository code, while the +`repo` scope grants permission to code as well as invitations. + +### Invite a user to a repository + +Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/collaborators/collaborators#add-a-repository-collaborator)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/commits/comments.md b/translations/zh-CN/content/rest/commits/comments.md new file mode 100644 index 0000000000..34ff1e9f90 --- /dev/null +++ b/translations/zh-CN/content/rest/commits/comments.md @@ -0,0 +1,25 @@ +--- +title: Commit comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Custom media types for commit comments + +These are the supported media types for commit comments. You can read more +about the use of media types in the API [here](/rest/overview/media-types). + + application/vnd.github-commitcomment.raw+json + application/vnd.github-commitcomment.text+json + application/vnd.github-commitcomment.html+json + application/vnd.github-commitcomment.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/commits/commits.md b/translations/zh-CN/content/rest/commits/commits.md new file mode 100644 index 0000000000..8b0fa3f792 --- /dev/null +++ b/translations/zh-CN/content/rest/commits/commits.md @@ -0,0 +1,12 @@ +--- +title: Commits +intro: 'The Commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/zh-CN/content/rest/commits/index.md b/translations/zh-CN/content/rest/commits/index.md new file mode 100644 index 0000000000..425b0999cf --- /dev/null +++ b/translations/zh-CN/content/rest/commits/index.md @@ -0,0 +1,19 @@ +--- +title: Commits +intro: 'The commits API allows you to list, view, and compare commits in a repository. You can also interact with commit comments and commit statuses.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /commits + - /comments + - /statuses +redirect_from: + - /rest/reference/commits +--- diff --git a/translations/zh-CN/content/rest/commits/statuses.md b/translations/zh-CN/content/rest/commits/statuses.md new file mode 100644 index 0000000000..27050e2439 --- /dev/null +++ b/translations/zh-CN/content/rest/commits/statuses.md @@ -0,0 +1,23 @@ +--- +title: Commit statuses +intro: 'The status API allows external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Statuses can also include an optional `description` and `target_url`, and we highly recommend providing them as they make statuses much more useful in the GitHub UI. + +As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The `target_url` would be the full URL to the build output, and the `description` would be the high level summary of what happened with the build. + +Statuses can include a `context` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of `ci`, and a security audit tool push statuses with a context of `security`. You can then use the [Get the combined status for a specific reference](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) to retrieve the whole status for a commit. + +Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the `repo` scope grants permission to code as well as statuses. + +If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the [Checks API](/rest/reference/checks). \ No newline at end of file diff --git a/translations/zh-CN/content/rest/dependabot/index.md b/translations/zh-CN/content/rest/dependabot/index.md new file mode 100644 index 0000000000..9de244ec7d --- /dev/null +++ b/translations/zh-CN/content/rest/dependabot/index.md @@ -0,0 +1,16 @@ +--- +title: Dependabot +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /secrets +redirect_from: + - /rest/reference/dependabot +--- diff --git a/translations/zh-CN/content/rest/dependabot/secrets.md b/translations/zh-CN/content/rest/dependabot/secrets.md new file mode 100644 index 0000000000..f57bff7358 --- /dev/null +++ b/translations/zh-CN/content/rest/dependabot/secrets.md @@ -0,0 +1,15 @@ +--- +title: Secrets +intro: 'With the Dependabot Secrets API, you can manage and control Dependabot secrets for an organization or repository.' +topics: + - API +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +allowTitleToDifferFromFilename: true +--- + +The {% data variables.product.prodname_dependabot %} Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Managing encrypted secrets for Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)." + +{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/dependency-graph/dependency-review.md b/translations/zh-CN/content/rest/dependency-graph/dependency-review.md new file mode 100644 index 0000000000..b08e657b46 --- /dev/null +++ b/translations/zh-CN/content/rest/dependency-graph/dependency-review.md @@ -0,0 +1,19 @@ +--- +title: Dependency Review +intro: 'The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment.' +versions: + fpt: '*' + ghes: '>=3.6' + ghec: '*' + ghae: 'issue-6396' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +## Dependency review + +{% data reusables.dependency-review.dependency-review-api-beta-note %} + +The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/dependency-graph/index.md b/translations/zh-CN/content/rest/dependency-graph/index.md new file mode 100644 index 0000000000..393c5eaa5c --- /dev/null +++ b/translations/zh-CN/content/rest/dependency-graph/index.md @@ -0,0 +1,16 @@ +--- +title: Dependency Graph +intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.' +versions: + fpt: '*' + ghes: '>=3.6' + ghec: '*' + ghae: 'issue-6396' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /dependency-review +redirect_from: + - /rest/reference/dependency-graph +--- diff --git a/translations/zh-CN/content/rest/deploy-keys.md b/translations/zh-CN/content/rest/deploy-keys.md new file mode 100644 index 0000000000..0158b1194b --- /dev/null +++ b/translations/zh-CN/content/rest/deploy-keys.md @@ -0,0 +1,19 @@ +--- +title: Deploy Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/deploy_keys +--- + +{% data reusables.repositories.deploy-keys %} + +Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/deployments/deployments.md b/translations/zh-CN/content/rest/deployments/deployments.md new file mode 100644 index 0000000000..84f4f9eea3 --- /dev/null +++ b/translations/zh-CN/content/rest/deployments/deployments.md @@ -0,0 +1,60 @@ +--- +title: Deployments +intro: 'The Deployments API allows you to create and delete deployments and deployment environments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Deployments are requests to deploy a specific ref (branch, SHA, tag). GitHub dispatches a [`deployment` event](/developers/webhooks-and-events/webhook-events-and-payloads#deployment) that external services can listen for and act on when new deployments are created. Deployments enable developers and organizations to build loosely coupled tooling around deployments, without having to worry about the implementation details of delivering different types of applications (e.g., web, native). + +Deployment statuses allow external services to mark deployments with an `error`, `failure`, `pending`, `in_progress`, `queued`, or `success` state that systems listening to [`deployment_status` events](/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status) can consume. + +Deployment statuses can also include an optional `description` and `log_url`, which are highly recommended because they make deployment statuses more useful. The `log_url` is the full URL to the deployment output, and +the `description` is a high-level summary of what happened with the deployment. + +GitHub dispatches `deployment` and `deployment_status` events when new deployments and deployment statuses are created. These events allows third-party integrations to receive respond to deployment requests and update the status of a deployment as progress is made. + +Below is a simple sequence diagram for how these interactions would work. + +``` ++---------+ +--------+ +-----------+ +-------------+ +| Tooling | | GitHub | | 3rd Party | | Your Server | ++---------+ +--------+ +-----------+ +-------------+ + | | | | + | Create Deployment | | | + |--------------------->| | | + | | | | + | Deployment Created | | | + |<---------------------| | | + | | | | + | | Deployment Event | | + | |---------------------->| | + | | | SSH+Deploys | + | | |-------------------->| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | + | | | Deploy Completed | + | | |<--------------------| + | | | | + | | Deployment Status | | + | |<----------------------| | + | | | | +``` + +Keep in mind that GitHub is never actually accessing your servers. It's up to your third-party integration to interact with deployment events. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether they're responsible for pushing the code out to your servers, building native code, etc. + +Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the {% ifversion not ghae %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well. + +### Inactive deployments + +When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status. + +You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. diff --git a/translations/zh-CN/content/rest/deployments/environments.md b/translations/zh-CN/content/rest/deployments/environments.md new file mode 100644 index 0000000000..1d90c1aa6b --- /dev/null +++ b/translations/zh-CN/content/rest/deployments/environments.md @@ -0,0 +1,16 @@ +--- +title: Environments +intro: 'The Environments API allows you to create, configure, and delete environments.' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." + +{% data reusables.gated-features.environments %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/deployments/index.md b/translations/zh-CN/content/rest/deployments/index.md new file mode 100644 index 0000000000..c92c19aec6 --- /dev/null +++ b/translations/zh-CN/content/rest/deployments/index.md @@ -0,0 +1,19 @@ +--- +title: Deployments +intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /deployments + - /environments + - /statuses +redirect_from: + - /rest/reference/deployments +--- diff --git a/translations/zh-CN/content/rest/deployments/statuses.md b/translations/zh-CN/content/rest/deployments/statuses.md new file mode 100644 index 0000000000..0896d48e75 --- /dev/null +++ b/translations/zh-CN/content/rest/deployments/statuses.md @@ -0,0 +1,13 @@ +--- +title: Deployment Statuses +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/emojis.md b/translations/zh-CN/content/rest/emojis.md new file mode 100644 index 0000000000..ca45960388 --- /dev/null +++ b/translations/zh-CN/content/rest/emojis.md @@ -0,0 +1,14 @@ +--- +title: Emojis +intro: 'With the Emojis API, you can list and view all the available emojis to use in {% data variables.product.product_name %}.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/emojis +--- diff --git a/translations/zh-CN/content/rest/enterprise-admin/admin-stats.md b/translations/zh-CN/content/rest/enterprise-admin/admin-stats.md new file mode 100644 index 0000000000..d18be10342 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/admin-stats.md @@ -0,0 +1,12 @@ +--- +title: Admin stats +intro: 'The Admin Stats API provides a variety of metrics about your installation.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/announcement.md b/translations/zh-CN/content/rest/enterprise-admin/announcement.md new file mode 100644 index 0000000000..05a248af24 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/announcement.md @@ -0,0 +1,14 @@ +--- +title: Announcement +intro: 'The Announcement API allows you to manage the global announcement banner in your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +## Announcement + +The Announcements API allows you to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/audit-log.md b/translations/zh-CN/content/rest/enterprise-admin/audit-log.md new file mode 100644 index 0000000000..7fa5096e21 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/audit-log.md @@ -0,0 +1,11 @@ +--- +title: Audit log +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/enterprise-admin/billing.md b/translations/zh-CN/content/rest/enterprise-admin/billing.md new file mode 100644 index 0000000000..15f8a05d8f --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/billing.md @@ -0,0 +1,11 @@ +--- +title: Billing +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/enterprise-admin/global-webhooks.md b/translations/zh-CN/content/rest/enterprise-admin/global-webhooks.md new file mode 100644 index 0000000000..b14fc8ab70 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/global-webhooks.md @@ -0,0 +1,14 @@ +--- +title: Global Webhooks +intro: 'Global Webhooks are installed on your enterprise. You can use global webhooks to automatically monitor, respond to, or enforce rules for users, organizations, teams, and repositories on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. + +*This API is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. To learn how to configure global webhooks, see [About global webhooks](/enterprise/admin/user-management/about-global-webhooks). \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/index.md b/translations/zh-CN/content/rest/enterprise-admin/index.md new file mode 100644 index 0000000000..2845bef7e0 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/index.md @@ -0,0 +1,82 @@ +--- +title: GitHub Enterprise administration +intro: You can use these endpoints to administer your enterprise. +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/enterprise-admin + - /v3/enterprise + - /rest/reference/enterprise-admin +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +shortTitle: Enterprise administration +children: + - /admin-stats + - /announcement + - /audit-log + - /billing + - /global-webhooks + - /ldap + - /license + - /management-console + - /org-pre-receive-hooks + - /orgs + - /pre-receive-environments + - /pre-receive-hooks + - /repo-pre-receive-hooks + - /users + - /scim +--- + +{% ifversion fpt or ghec %} + +{% note %} + +**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. + +{% endnote %} + +{% endif %} + +### Endpoint URLs + +REST API endpoints{% ifversion ghes %}—except [Management Console](#management-console) API endpoints—{% endif %} are prefixed with the following URL: + +```shell +{% data variables.product.api_url_pre %} +``` + +{% ifversion fpt or ghec %} +When endpoints include `{enterprise}`, replace `{enterprise}` with the handle for your enterprise account, which is included in the URL for your enterprise settings. For example, if your enterprise account is located at `https://github.com/enterprises/octo-enterprise`, replace `{enterprise}` with `octo-enterprise`. +{% endif %} + +{% ifversion ghes %} +[Management Console](#management-console) API endpoints are only prefixed with a hostname: + +```shell +http(s)://hostname/ +``` +{% endif %} +{% ifversion ghae or ghes %} +### Authentication + +Your {% data variables.product.product_name %} installation's API endpoints accept [the same authentication methods](/rest/overview/resources-in-the-rest-api#authentication) as the GitHub.com API. You can authenticate yourself with **[OAuth tokens](/apps/building-integrations/setting-up-and-registering-oauth-apps/)** {% ifversion ghes %}(which can be created using the [Authorizations API](/rest/reference/oauth-authorizations#create-a-new-authorization)) {% endif %}or **[basic authentication](/rest/overview/resources-in-the-rest-api#basic-authentication)**. {% ifversion ghes %} +OAuth tokens must have the `site_admin` [OAuth scope](/developers/apps/scopes-for-oauth-apps#available-scopes) when used with Enterprise-specific endpoints.{% endif %} + +Enterprise administration API endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators{% ifversion ghes %}, except for the [Management Console](#management-console) API, which requires the [Management Console password](/enterprise/admin/articles/accessing-the-management-console/){% endif %}. + +{% endif %} + +{% ifversion ghae or ghes %} +### Version information + +The current version of your enterprise is returned in the response header of every API: +`X-GitHub-Enterprise-Version: {{currentVersion}}.0` +You can also read the current version by calling the [meta endpoint](/rest/reference/meta/). + +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/ldap.md b/translations/zh-CN/content/rest/enterprise-admin/ldap.md new file mode 100644 index 0000000000..af2f31c0a7 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/ldap.md @@ -0,0 +1,11 @@ +--- +title: LDAP +intro: 'You can use the LDAP API to update account relationships between a {% data variables.product.product_name %} user or team and its linked LDAP entry or queue a new synchronization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +With the LDAP mapping endpoints, you're able to update the Distinguished Name (DN) that a user or team maps to. Note that the LDAP endpoints are generally only effective if your {% data variables.product.product_name %} appliance has [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap). The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/license.md b/translations/zh-CN/content/rest/enterprise-admin/license.md new file mode 100644 index 0000000000..2fd64bd48e --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/license.md @@ -0,0 +1,12 @@ +--- +title: License +intro: 'The License API provides information on your Enterprise license.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/management-console.md b/translations/zh-CN/content/rest/enterprise-admin/management-console.md new file mode 100644 index 0000000000..5e9f95ee02 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/management-console.md @@ -0,0 +1,35 @@ +--- +title: Management Console +intro: 'The Management Console API helps you manage your {% data variables.product.product_name %} installation.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% tip %} + +You must explicitly set the port number when making API calls to the Management Console. If TLS is enabled on your enterprise, the port number is `8443`; otherwise, the port number is `8080`. + +If you don't want to provide a port number, you'll need to configure your tool to automatically follow redirects. + +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/enterprise/admin/guides/installation/configuring-tls/). + +{% endtip %} + +### Authentication + +You need to pass your [Management Console password](/enterprise/admin/articles/accessing-the-management-console/) as an authentication token to every Management Console API endpoint except [`/setup/api/start`](#create-a-github-enterprise-server-license). + +Use the `api_key` parameter to send this token with each request. For example: + +```shell +$ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' +``` + +You can also use standard HTTP authentication to send this token. For example: + +```shell +$ curl -L -u "api_key:your-amazing-password" 'https://hostname:admin_port/setup/api' +``` \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/org-pre-receive-hooks.md b/translations/zh-CN/content/rest/enterprise-admin/org-pre-receive-hooks.md new file mode 100644 index 0000000000..bc8b8b31ea --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/org-pre-receive-hooks.md @@ -0,0 +1,23 @@ +--- +title: Organization Pre-receive Hooks +intro: 'The Organization Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to an organization.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Object attributes + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `allow_downstream_configuration` | `boolean` | Whether repositories can override enforcement. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this endpoint or this hook's global configuration. Only site admins are able to access the global configuration. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/orgs.md b/translations/zh-CN/content/rest/enterprise-admin/orgs.md new file mode 100644 index 0000000000..f8fdc559dc --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: 'The Organization Administration API allows you to create organizations on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/pre-receive-environments.md b/translations/zh-CN/content/rest/enterprise-admin/pre-receive-environments.md new file mode 100644 index 0000000000..feb2ce08b5 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/pre-receive-environments.md @@ -0,0 +1,34 @@ +--- +title: Pre-receive Environments +intro: 'The Pre-receive Environments API allows you to create, list, update and delete environments for pre-receive hooks.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Environment + +| Name | Type | Description | +|-----------------------|-----------|----------------------------------------------------------------------------| +| `name` | `string` | The name of the environment as displayed in the UI. | +| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. | +| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. | +| `download` | `object` | This environment's download status. | +| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. | + +#### Pre-receive Environment Download + +| Name | Type | Description | +|-----------------|----------|---------------------------------------------------------| +| `state` | `string` | The state of the most recent download. | +| `downloaded_at` | `string` | The time when the most recent download started. | +| `message` | `string` | On failure, this will have any error messages produced. | + +Possible values for `state` are `not_started`, `in_progress`, `success`, `failed`. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/pre-receive-hooks.md b/translations/zh-CN/content/rest/enterprise-admin/pre-receive-hooks.md new file mode 100644 index 0000000000..08d5c5f3ce --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/pre-receive-hooks.md @@ -0,0 +1,27 @@ +--- +title: Pre-receive Hooks +intro: 'The Pre-receive Hooks API allows you to create, list, update and delete pre-receive hooks.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `404` response if they try to access it. + +### Object attributes + +#### Pre-receive Hook + +| Name | Type | Description | +|----------------------------------|-----------|-----------------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `script` | `string` | The script that the hook runs. | +| `script_repository` | `object` | The GitHub repository where the script is kept. | +| `environment` | `object` | The pre-receive environment where the script is executed. | +| `enforcement` | `string` | The state of enforcement for this hook. | +| `allow_downstream_configuration` | `boolean` | Whether enforcement can be overridden at the org or repo level. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/repo-pre-receive-hooks.md b/translations/zh-CN/content/rest/enterprise-admin/repo-pre-receive-hooks.md new file mode 100644 index 0000000000..831ca1a06a --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/repo-pre-receive-hooks.md @@ -0,0 +1,22 @@ +--- +title: Repository Pre-receive Hooks +intro: 'The Repository Pre-receive Hooks API allows you to view and modify enforcement of the pre-receive hooks that are available to a repository.' +versions: + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +### Object attributes + +| Name | Type | Description | +|---------------------|----------|-----------------------------------------------------------| +| `name` | `string` | The name of the hook. | +| `enforcement` | `string` | The state of enforcement for the hook on this repository. | +| `configuration_url` | `string` | URL for the endpoint where enforcement is set. | + +Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + +`configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/enterprise-admin/scim.md b/translations/zh-CN/content/rest/enterprise-admin/scim.md new file mode 100644 index 0000000000..326d333cbf --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/scim.md @@ -0,0 +1,11 @@ +--- +title: SCIM +intro: '' +versions: + fpt: '*' + ghec: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/enterprise-admin/users.md b/translations/zh-CN/content/rest/enterprise-admin/users.md new file mode 100644 index 0000000000..6d9aea56c7 --- /dev/null +++ b/translations/zh-CN/content/rest/enterprise-admin/users.md @@ -0,0 +1,12 @@ +--- +title: Users +intro: 'The User Administration API allows you to suspend{% ifversion ghes %}, unsuspend, promote, and demote{% endif %}{% ifversion ghae %} and unsuspend{% endif %} users on your enterprise.' +versions: + ghes: '*' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +*It is only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators.* Normal users will receive a `403` response if they try to access it. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/gists/comments.md b/translations/zh-CN/content/rest/gists/comments.md new file mode 100644 index 0000000000..9b01fd1f71 --- /dev/null +++ b/translations/zh-CN/content/rest/gists/comments.md @@ -0,0 +1,21 @@ +--- +title: Comments +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Custom media types for Gist comments + +These are the supported media types for gist comments. + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.base64 + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/gists/gists.md b/translations/zh-CN/content/rest/gists/gists.md new file mode 100644 index 0000000000..5cb6fef354 --- /dev/null +++ b/translations/zh-CN/content/rest/gists/gists.md @@ -0,0 +1,35 @@ +--- +title: Gists +intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on GitHub.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Authentication + +You can read public gists {% ifversion ghae or ghes %}and create them for anonymous users without a token.{% else %} anonymously, but you must be signed into GitHub to create gists.{% endif %} To read or write gists on a user's behalf, you need the gist OAuth scope and a token. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." + + + +### Truncation + +The Gist API provides up to one megabyte of content for each file in the gist. Each file returned for a gist through the API has a key called `truncated`. If `truncated` is `true`, the file is too large and only a portion of the contents were returned in `content`. + +If you need the full contents of the file, you can make a `GET` request to the URL specified by `raw_url`. Be aware that for files larger than ten megabytes, you'll need to clone the gist via the URL provided by `git_pull_url`. + +In addition to a specific file's contents being truncated, the entire files list may be truncated if the total number exceeds 300 files. If the top level `truncated` key is `true`, only the first 300 files have been returned in the files list. If you need to fetch all of the gist's files, you'll need to clone the gist via the URL provided by `git_pull_url`. + +### Custom media types for gists + +These are the supported media types for fetching gist contents. + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.base64 + +For more information, see "[Media types](/rest/overview/media-types)." diff --git a/translations/zh-CN/content/rest/gists/index.md b/translations/zh-CN/content/rest/gists/index.md new file mode 100644 index 0000000000..7c9ddbab2c --- /dev/null +++ b/translations/zh-CN/content/rest/gists/index.md @@ -0,0 +1,18 @@ +--- +title: Gists +intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on {% data variables.product.product_name %}.' +redirect_from: + - /v3/gists + - /rest/reference/gists +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /gists + - /comments +--- diff --git a/translations/zh-CN/content/rest/git/blobs.md b/translations/zh-CN/content/rest/git/blobs.md new file mode 100644 index 0000000000..a4df5aca84 --- /dev/null +++ b/translations/zh-CN/content/rest/git/blobs.md @@ -0,0 +1,24 @@ +--- +title: Blobs +intro: 'A Git blob (binary large object) is the object type used to store the contents of each file in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) +to your Git database on {% data variables.product.product_name %}. Blobs leverage [these custom media types](#custom-media-types-for-blobs). You can read more about the use of media types in the API [here](/rest/overview/media-types). + +### Custom media types for blobs + +These are the supported media types for blobs. + + application/json + application/vnd.github.VERSION.raw + +For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/git/commits.md b/translations/zh-CN/content/rest/git/commits.md new file mode 100644 index 0000000000..18c14bb2ac --- /dev/null +++ b/translations/zh-CN/content/rest/git/commits.md @@ -0,0 +1,14 @@ +--- +title: Commits +intro: 'A Git commit is a snapshot of the hierarchy ([Git tree](/rest/reference/git#trees)) and the contents of the files ([Git blob](/rest/reference/git#blobs)) in a Git repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/git/index.md b/translations/zh-CN/content/rest/git/index.md new file mode 100644 index 0000000000..da1de11653 --- /dev/null +++ b/translations/zh-CN/content/rest/git/index.md @@ -0,0 +1,24 @@ +--- +title: Git database +intro: 'The Git Database API enables you to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update Git references (branch heads and tags).' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/git + - /rest/reference/git +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /blobs + - /commits + - /refs + - /tags + - /trees +--- + +The Git Database API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the Git Database API, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/git/refs.md b/translations/zh-CN/content/rest/git/refs.md new file mode 100644 index 0000000000..55b5f8122a --- /dev/null +++ b/translations/zh-CN/content/rest/git/refs.md @@ -0,0 +1,15 @@ +--- +title: References +intro: 'A Git reference (`git ref`) is just a file that contains a Git commit SHA-1 hash.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is just a Git reference that stores the new Git commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v1/Git-Internals-Git-References) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/git/tags.md b/translations/zh-CN/content/rest/git/tags.md new file mode 100644 index 0000000000..101fde046a --- /dev/null +++ b/translations/zh-CN/content/rest/git/tags.md @@ -0,0 +1,14 @@ +--- +title: Tags +intro: 'A Git tag is similar to a [Git reference](/rest/reference/git#refs), but the Git commit that it points to never changes.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags) to your Git database on {% data variables.product.product_name %}. The Git tags API only supports [annotated tag objects](https://git-scm.com/book/en/v1/Git-Internals-Git-References#Tags), not lightweight tags. diff --git a/translations/zh-CN/content/rest/git/trees.md b/translations/zh-CN/content/rest/git/trees.md new file mode 100644 index 0000000000..7471c1d66a --- /dev/null +++ b/translations/zh-CN/content/rest/git/trees.md @@ -0,0 +1,14 @@ +--- +title: Trees +intro: 'A Git tree object creates the hierarchy between files in a Git repository. ' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Tree-Objects) to your Git database on {% data variables.product.product_name %}. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/gitignore.md b/translations/zh-CN/content/rest/gitignore.md new file mode 100644 index 0000000000..0a641c3994 --- /dev/null +++ b/translations/zh-CN/content/rest/gitignore.md @@ -0,0 +1,24 @@ +--- +title: Gitignore +intro: 'The Gitignore API fetches `.gitignore` templates that can be used to ignore files and directories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/gitignore +--- + +When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). + +### Custom media types for gitignore + +You can use this custom media type when getting a gitignore template. + + application/vnd.github.VERSION.raw + +For more information, see "[Media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/index.md b/translations/zh-CN/content/rest/index.md index 969127dea5..773fa86484 100644 --- a/translations/zh-CN/content/rest/index.md +++ b/translations/zh-CN/content/rest/index.md @@ -1,7 +1,7 @@ --- title: GitHub REST API shortTitle: REST API -intro: '要创建集成、检索数据和自动化工作流程，请使用 {% data variables.product.prodname_dotcom %} REST API 构建。' +intro: 'To create integrations, retrieve data, and automate your workflows, build with the {% data variables.product.prodname_dotcom %} REST API.' introLinks: quickstart: /rest/guides/getting-started-with-the-rest-api featuredLinks: @@ -31,7 +31,49 @@ versions: ghec: '*' children: - /overview - - /reference - /guides + - /actions + - /activity + - /apps + - /billing + - /branches + - /checks + - /codes-of-conduct + - /code-scanning + - /codespaces + - /collaborators + - /commits + - /dependabot + - /dependency-graph + - /deploy-keys + - /deployments + - /emojis + - /enterprise-admin + - /gists + - /git + - /gitignore + - /interactions + - /issues + - /licenses + - /markdown + - /meta + - /metrics + - /migrations + - /oauth-authorizations + - /orgs + - /packages + - /pages + - /projects + - /pulls + - /rate-limit + - /reactions + - /releases + - /repos + - /scim + - /search + - /secret-scanning + - /teams + - /users + - /webhooks --- diff --git a/translations/zh-CN/content/rest/interactions/index.md b/translations/zh-CN/content/rest/interactions/index.md new file mode 100644 index 0000000000..10c5349a73 --- /dev/null +++ b/translations/zh-CN/content/rest/interactions/index.md @@ -0,0 +1,19 @@ +--- +title: Interactions +intro: 'With the Interactions API, people with owner or admin access can set the interaction limit for the users in their organizations and repositories.' +redirect_from: + - /v3/interactions + - /rest/reference/interactions +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /repos + - /user +--- + +Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/interactions/orgs.md b/translations/zh-CN/content/rest/interactions/orgs.md new file mode 100644 index 0000000000..2185e2bb46 --- /dev/null +++ b/translations/zh-CN/content/rest/interactions/orgs.md @@ -0,0 +1,19 @@ +--- +title: Organization +intro: "The Organization Interactions API allows organization owners to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories." +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} in the organization. +* {% data reusables.interactions.contributor-user-limit-definition %} in the organization. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the organization. + +Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the [Repository](#repository) interactions endpoints instead. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/interactions/repos.md b/translations/zh-CN/content/rest/interactions/repos.md new file mode 100644 index 0000000000..5bba6ae46d --- /dev/null +++ b/translations/zh-CN/content/rest/interactions/repos.md @@ -0,0 +1,19 @@ +--- +title: Repository +intro: 'The Repository Interactions API allows people with owner or admin access to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} in the repository. +* {% data reusables.interactions.contributor-user-limit-definition %} in the repository. +* {% data reusables.interactions.collaborator-user-limit-definition %} in the repository. + +If an interaction limit is enabled for the user or organization that owns the repository, the limit cannot be changed for the individual repository. Instead, use the [User](#user) or [Organization](#organization) interactions endpoints to change the interaction limit. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/interactions/user.md b/translations/zh-CN/content/rest/interactions/user.md new file mode 100644 index 0000000000..b7fa0c6174 --- /dev/null +++ b/translations/zh-CN/content/rest/interactions/user.md @@ -0,0 +1,18 @@ +--- +title: User +intro: 'The User Interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories. + +Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the [Repository](#repository) interactions endpoints instead. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/issues/assignees.md b/translations/zh-CN/content/rest/issues/assignees.md new file mode 100644 index 0000000000..3d465a739e --- /dev/null +++ b/translations/zh-CN/content/rest/issues/assignees.md @@ -0,0 +1,12 @@ +--- +title: Assignees +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/issues/comments.md b/translations/zh-CN/content/rest/issues/comments.md new file mode 100644 index 0000000000..9d68676a6a --- /dev/null +++ b/translations/zh-CN/content/rest/issues/comments.md @@ -0,0 +1,14 @@ +--- +title: Comments +intro: 'The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Issue Comments use [these custom media types](#custom-media-types). You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/translations/zh-CN/content/rest/issues/events.md b/translations/zh-CN/content/rest/issues/events.md new file mode 100644 index 0000000000..e6eaa7a53c --- /dev/null +++ b/translations/zh-CN/content/rest/issues/events.md @@ -0,0 +1,14 @@ +--- +title: Events +intro: 'The Issue Events API can return different types of events triggered by activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[Events API](/developers/webhooks-and-events/github-event-types)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/issues/index.md b/translations/zh-CN/content/rest/issues/index.md new file mode 100644 index 0000000000..11fae409e7 --- /dev/null +++ b/translations/zh-CN/content/rest/issues/index.md @@ -0,0 +1,23 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +redirect_from: + - /v3/issues + - /rest/reference/issues +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /issues + - /assignees + - /comments + - /events + - /labels + - /milestones + - /timeline +--- diff --git a/translations/zh-CN/content/rest/issues/issues.md b/translations/zh-CN/content/rest/issues/issues.md new file mode 100644 index 0000000000..630bf7315f --- /dev/null +++ b/translations/zh-CN/content/rest/issues/issues.md @@ -0,0 +1,23 @@ +--- +title: Issues +intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### Custom media types for issues + +These are the supported media types for issues. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information about media types, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/issues/labels.md b/translations/zh-CN/content/rest/issues/labels.md new file mode 100644 index 0000000000..c2d910ec3e --- /dev/null +++ b/translations/zh-CN/content/rest/issues/labels.md @@ -0,0 +1,12 @@ +--- +title: Labels +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/issues/milestones.md b/translations/zh-CN/content/rest/issues/milestones.md new file mode 100644 index 0000000000..2ae71632ba --- /dev/null +++ b/translations/zh-CN/content/rest/issues/milestones.md @@ -0,0 +1,12 @@ +--- +title: Milestones +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/issues/timeline.md b/translations/zh-CN/content/rest/issues/timeline.md new file mode 100644 index 0000000000..4d7a73e4ca --- /dev/null +++ b/translations/zh-CN/content/rest/issues/timeline.md @@ -0,0 +1,16 @@ +--- +title: Timeline +intro: 'The Timeline Events API can return different types of events triggered by timeline activity in issues and pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information about the specific events that you can receive from the Issue Events API, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "[GitHub Events API](/developers/webhooks-and-events/github-event-types)." + +You can use this API to display information about issues and pull request or determine who should be notified of issue comments. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/licenses.md b/translations/zh-CN/content/rest/licenses.md new file mode 100644 index 0000000000..78619bfa73 --- /dev/null +++ b/translations/zh-CN/content/rest/licenses.md @@ -0,0 +1,35 @@ +--- +title: Licenses +intro: "The Licenses API lets you to retrieve popular open source licenses and information about a particular project's license file." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/licenses +--- + +The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's `LICENSE` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation. + +If a license is matched, the license key and name returned conforms to the [SPDX specification](https://spdx.org/). + +**Note:** These endpoints will also return a repository's license information: + +- [Get a repository](/rest/reference/repos#get-a-repository) +- [List repositories for a user](/rest/reference/repos#list-repositories-for-a-user) +- [List organization repositories](/rest/reference/repos#list-organization-repositories) +- [List forks](/rest/reference/repos#list-forks) +- [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user) +- [List team repositories](/rest/reference/teams#list-team-repositories) + +{% warning %} + +GitHub is a lot of things, but it’s not a law firm. As such, GitHub does not provide legal advice. Using the Licenses API or sending us an email about it does not constitute legal advice nor does it create an attorney-client relationship. If you have any questions about what you can and can't do with a particular license, you should consult with your own legal counsel before moving forward. In fact, you should always consult with your own lawyer before making any decisions that might have legal ramifications or that may impact your legal rights. + +GitHub created the License API to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers (at least most of us aren't) and that we make mistakes like everyone else. For that reason, GitHub provides the API on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API. + +{% endwarning %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/markdown.md b/translations/zh-CN/content/rest/markdown.md new file mode 100644 index 0000000000..2f782424e3 --- /dev/null +++ b/translations/zh-CN/content/rest/markdown.md @@ -0,0 +1,14 @@ +--- +title: Markdown +intro: 'The Markdown API enables you to render a markdown document as an HTML page or as raw text.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/markdown +--- diff --git a/translations/zh-CN/content/rest/meta.md b/translations/zh-CN/content/rest/meta.md new file mode 100644 index 0000000000..6ecb71fe20 --- /dev/null +++ b/translations/zh-CN/content/rest/meta.md @@ -0,0 +1,14 @@ +--- +title: Meta +intro: 'The Meta API returns meta information about {% data variables.product.product_name %} including the IP addresses of {% data variables.product.product_name %} services.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/meta +--- diff --git a/translations/zh-CN/content/rest/metrics/community.md b/translations/zh-CN/content/rest/metrics/community.md new file mode 100644 index 0000000000..725ad20ea0 --- /dev/null +++ b/translations/zh-CN/content/rest/metrics/community.md @@ -0,0 +1,10 @@ +--- +title: Community +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/metrics/index.md b/translations/zh-CN/content/rest/metrics/index.md new file mode 100644 index 0000000000..4f450b3a9e --- /dev/null +++ b/translations/zh-CN/content/rest/metrics/index.md @@ -0,0 +1,20 @@ +--- +title: Metrics +intro: 'The repository metrics API allows you to retrieve community profile, statistics, and traffic for your repository.' +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/reference/repository-metrics + - /rest/reference/metrics +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /community + - /statistics + - /traffic +--- diff --git a/translations/zh-CN/content/rest/metrics/statistics.md b/translations/zh-CN/content/rest/metrics/statistics.md new file mode 100644 index 0000000000..955c527812 --- /dev/null +++ b/translations/zh-CN/content/rest/metrics/statistics.md @@ -0,0 +1,31 @@ +--- +title: Statistics +intro: 'The Repository Statistics API allows you to fetch the data that {% data variables.product.product_name %} uses for visualizing different types of repository activity.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +### A word about caching + +Computing repository statistics is an expensive operation, so we try to return cached +data whenever possible. If the data hasn't been cached when you query a repository's +statistics, you'll receive a `202` response; a background job is also fired to +start compiling these statistics. Give the job a few moments to complete, and +then submit the request again. If the job has completed, that request will receive a +`200` response with the statistics in the response body. + +Repository statistics are cached by the SHA of the repository's default branch; pushing to the default branch resets the statistics cache. + +### Statistics exclude some types of commits + +The statistics exposed by the API match the statistics shown by [different repository graphs](/github/visualizing-repository-data-with-graphs/about-repository-graphs). + +To summarize: +- All statistics exclude merge commits. +- Contributor statistics also exclude empty commits. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/metrics/traffic.md b/translations/zh-CN/content/rest/metrics/traffic.md new file mode 100644 index 0000000000..9360f43231 --- /dev/null +++ b/translations/zh-CN/content/rest/metrics/traffic.md @@ -0,0 +1,12 @@ +--- +title: Traffic +intro: 'For repositories that you have push access to, the traffic API provides access to the information provided in your repository graph. ' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "Viewing traffic to a repository." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/migrations/index.md b/translations/zh-CN/content/rest/migrations/index.md new file mode 100644 index 0000000000..46ce2d736a --- /dev/null +++ b/translations/zh-CN/content/rest/migrations/index.md @@ -0,0 +1,21 @@ +--- +title: Migrations +intro: 'The Migration API lets you migrate the repositories and users of your organization from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.' +redirect_from: + - /v3/migrations + - /v3/migration + - /v3/migration/migrations + - /rest/reference/migrations +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /source-imports + - /users +--- diff --git a/translations/zh-CN/content/rest/migrations/orgs.md b/translations/zh-CN/content/rest/migrations/orgs.md new file mode 100644 index 0000000000..4ee5218d95 --- /dev/null +++ b/translations/zh-CN/content/rest/migrations/orgs.md @@ -0,0 +1,17 @@ +--- +title: Organization +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.organization_migrations_intro %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/migrations/source-imports.md b/translations/zh-CN/content/rest/migrations/source-imports.md new file mode 100644 index 0000000000..01bd775089 --- /dev/null +++ b/translations/zh-CN/content/rest/migrations/source-imports.md @@ -0,0 +1,87 @@ +--- +title: Source Imports +intro: '{% data variables.migrations.source_imports_intro %}' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) to find out the status of the import. + +A more detailed example can be seen in this diagram: + +``` ++---------+ +--------+ +---------------------+ +| Tooling | | GitHub | | Original Repository | ++---------+ +--------+ +---------------------+ + | | | + | Start import | | + |----------------------------->| | + | | | + | | Download source data | + | |--------------------------------------------->| + | | Begin streaming data | + | |<---------------------------------------------| + | | | + | Get import progress | | + |----------------------------->| | + | "status": "importing" | | + |<-----------------------------| | + | | | + | Get commit authors | | + |----------------------------->| | + | | | + | Map a commit author | | + |----------------------------->| | + | | | + | | | + | | Finish streaming data | + | |<---------------------------------------------| + | | | + | | Rewrite commits with mapped authors | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Map a commit author | | + |----------------------------->| | + | | Rewrite commits with mapped authors | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Get large files | | + |----------------------------->| | + | | | + | opt_in to Git LFS | | + |----------------------------->| | + | | Rewrite commits for large files | + | |------+ | + | | | | + | |<-----+ | + | | | + | | Update repository on GitHub | + | |------+ | + | | | | + | |<-----+ | + | | | + | Get import progress | | + |----------------------------->| | + | "status": "complete" | | + |<-----------------------------| | + | | | + | | | +``` \ No newline at end of file diff --git a/translations/zh-CN/content/rest/migrations/users.md b/translations/zh-CN/content/rest/migrations/users.md new file mode 100644 index 0000000000..185cc1a43e --- /dev/null +++ b/translations/zh-CN/content/rest/migrations/users.md @@ -0,0 +1,20 @@ +--- +title: Users +intro: 'The Users migrations API is only available to authenticated account owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '>3.3' + ghae: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)." + +{% data variables.migrations.user_migrations_intro %} For a list of migration data that you can download, see "[Download a user migration archive](#download-a-user-migration-archive)." + +To download an archive, you'll need to start a user migration first. Once the status of the migration is `exported`, you can download the migration. + +Once you've created a migration archive, it will be available to download for seven days. But, you can delete the user migration archive sooner if you'd like. You can unlock your repository when the migration is `exported` to begin using your repository again or delete the repository if you no longer need the source data. diff --git a/translations/zh-CN/content/rest/oauth-authorizations.md b/translations/zh-CN/content/rest/oauth-authorizations.md new file mode 100644 index 0000000000..2f6e8fab75 --- /dev/null +++ b/translations/zh-CN/content/rest/oauth-authorizations.md @@ -0,0 +1,17 @@ +--- +title: OAuth Authorizations +intro: 'The Migrations API is only available to authenticated organization owners.' +versions: + fpt: '*' + ghec: '*' + ghes: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/oauth-authorizations +--- + +You can use this API to manage the access OAuth applications have to your account. You can only access this API via [Basic Authentication](/rest/overview/other-authentication-methods#basic-authentication) using your username and password, not tokens. + +If you or your users have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication). \ No newline at end of file diff --git a/translations/zh-CN/content/rest/orgs/blocking.md b/translations/zh-CN/content/rest/orgs/blocking.md new file mode 100644 index 0000000000..9e0982fa5d --- /dev/null +++ b/translations/zh-CN/content/rest/orgs/blocking.md @@ -0,0 +1,13 @@ +--- +title: Blocking users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +The token used to authenticate the call must have the `admin:org` scope in order to make any blocking calls for an organization. Otherwise, the response returns `HTTP 404`. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/orgs/custom-roles.md b/translations/zh-CN/content/rest/orgs/custom-roles.md new file mode 100644 index 0000000000..6944dff7d0 --- /dev/null +++ b/translations/zh-CN/content/rest/orgs/custom-roles.md @@ -0,0 +1,14 @@ +--- +title: Custom Repository Roles +intro: '' +versions: + fpt: '*' + ghes: '>=3.4' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +redirect_from: + - /rest/orgs/custom_roles +--- diff --git a/translations/zh-CN/content/rest/orgs/index.md b/translations/zh-CN/content/rest/orgs/index.md new file mode 100644 index 0000000000..917eba0b84 --- /dev/null +++ b/translations/zh-CN/content/rest/orgs/index.md @@ -0,0 +1,23 @@ +--- +title: Organizations +intro: 'The Organizations API gives you access to control and manage all your {% data variables.product.product_name %} organizations.' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/orgs + - /rest/reference/orgs +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /orgs + - /blocking + - /custom-roles + - /members + - /outside-collaborators + - /webhooks +--- diff --git a/translations/zh-CN/content/rest/orgs/members.md b/translations/zh-CN/content/rest/orgs/members.md new file mode 100644 index 0000000000..40c46bda07 --- /dev/null +++ b/translations/zh-CN/content/rest/orgs/members.md @@ -0,0 +1,12 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/orgs/orgs.md b/translations/zh-CN/content/rest/orgs/orgs.md new file mode 100644 index 0000000000..d9d89ac9cb --- /dev/null +++ b/translations/zh-CN/content/rest/orgs/orgs.md @@ -0,0 +1,13 @@ +--- +title: Organizations +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/translations/zh-CN/content/rest/orgs/outside-collaborators.md b/translations/zh-CN/content/rest/orgs/outside-collaborators.md new file mode 100644 index 0000000000..8975f3a093 --- /dev/null +++ b/translations/zh-CN/content/rest/orgs/outside-collaborators.md @@ -0,0 +1,12 @@ +--- +title: Outside Collaborators +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/orgs/webhooks.md b/translations/zh-CN/content/rest/orgs/webhooks.md new file mode 100644 index 0000000000..97ae08ff1c --- /dev/null +++ b/translations/zh-CN/content/rest/orgs/webhooks.md @@ -0,0 +1,35 @@ +--- +title: Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in an organization. {% data reusables.webhooks.webhooks-rest-api-links %} + +For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)." + +### Scopes & Restrictions + +All actions against organization webhooks require the authenticated user to be an admin of the organization being managed. Additionally, OAuth tokens require the `admin:org_hook` scope. For more information, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps)." + +In order to protect sensitive data which may be present in webhook configurations, we also enforce the following access control rules: + +- OAuth applications cannot list, view, or edit webhooks which they did not create. +- Users cannot list, view, or edit webhooks which were created by OAuth applications. + +### Receiving Webhooks + +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +For more best practices, [see our guide](/guides/best-practices-for-integrators/). + +#### Webhook headers + +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/webhooks/event-payloads/#delivery-headers) for details. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/overview/libraries.md b/translations/zh-CN/content/rest/overview/libraries.md index 21d1505d2d..d4b1b55702 100644 --- a/translations/zh-CN/content/rest/overview/libraries.md +++ b/translations/zh-CN/content/rest/overview/libraries.md @@ -26,7 +26,7 @@ topics: {% warning %} -警告：截至 2021 年 10 月下旬，官方 Octokit 库目前尚未维护。 +警告：截至 2021 年 10 月下旬，官方 Octokit 库目前尚未维护。 更多信息请参阅 [octokit.js 存储库中的此讨论](https://github.com/octokit/octokit.js/discussions/620)。 {% endwarning %} diff --git a/translations/zh-CN/content/rest/overview/permissions-required-for-github-apps.md b/translations/zh-CN/content/rest/overview/permissions-required-for-github-apps.md index 9525ffe325..8c83ba3650 100644 --- a/translations/zh-CN/content/rest/overview/permissions-required-for-github-apps.md +++ b/translations/zh-CN/content/rest/overview/permissions-required-for-github-apps.md @@ -909,7 +909,7 @@ _团队_ - [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (:write) {% endif %} -{% ifversion fpt or ghes > 3.0 or ghec %} +{% ifversion ghes > 3.0 or ghec %} ### 对于“密码扫描警报”的权限 - [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) diff --git a/translations/zh-CN/content/rest/packages.md b/translations/zh-CN/content/rest/packages.md new file mode 100644 index 0000000000..32204571ad --- /dev/null +++ b/translations/zh-CN/content/rest/packages.md @@ -0,0 +1,23 @@ +--- +title: Packages +intro: 'With the {% data variables.product.prodname_registry %} API, you can manage packages for your {% data variables.product.prodname_dotcom %} repositories and organizations.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/packages +--- + +The {% data variables.product.prodname_registry %} API enables you to manage packages using the REST API.{% ifversion fpt or ghec or ghes > 3.1 or ghae %} To learn more about restoring or deleting packages, see "[Restoring and deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)."{% endif %} + +To use this API, you must authenticate using a personal access token. + - To access package metadata, your token must include the `read:packages` scope. + - To delete packages and package versions, your token must include the `read:packages` and `delete:packages` scopes. + - To restore packages and package versions, your token must include the `read:packages` and `write:packages` scopes. + +If your `package_type` is `npm`, `maven`, `rubygems`, or `nuget`, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. If your package is in the {% data variables.product.prodname_container_registry %}, then your `package_type` is `container` and your token does not need the `repo` scope to access or manage this `package_type`. `container` packages offer granular permissions separate from a repository. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)." + +If you want to use the {% data variables.product.prodname_registry %} API to access resources in an organization with SSO enabled, then you must enable SSO for your personal access token. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} diff --git a/translations/zh-CN/content/rest/pages.md b/translations/zh-CN/content/rest/pages.md new file mode 100644 index 0000000000..2864c8aae6 --- /dev/null +++ b/translations/zh-CN/content/rest/pages.md @@ -0,0 +1,14 @@ +--- +title: Pages +intro: 'The GitHub Pages API allows you to interact with GitHub Pages sites and build information.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/pages +--- \ No newline at end of file diff --git a/translations/zh-CN/content/rest/projects/cards.md b/translations/zh-CN/content/rest/projects/cards.md new file mode 100644 index 0000000000..f92c719935 --- /dev/null +++ b/translations/zh-CN/content/rest/projects/cards.md @@ -0,0 +1,12 @@ +--- +title: Cards +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/projects/collaborators.md b/translations/zh-CN/content/rest/projects/collaborators.md new file mode 100644 index 0000000000..a68e1809bc --- /dev/null +++ b/translations/zh-CN/content/rest/projects/collaborators.md @@ -0,0 +1,13 @@ +--- +title: Collaborators +intro: "This API allows you to interact with an organization's projects." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/translations/zh-CN/content/rest/projects/columns.md b/translations/zh-CN/content/rest/projects/columns.md new file mode 100644 index 0000000000..e3c0985574 --- /dev/null +++ b/translations/zh-CN/content/rest/projects/columns.md @@ -0,0 +1,12 @@ +--- +title: Columns +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/projects/index.md b/translations/zh-CN/content/rest/projects/index.md new file mode 100644 index 0000000000..7afcf086c6 --- /dev/null +++ b/translations/zh-CN/content/rest/projects/index.md @@ -0,0 +1,20 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +redirect_from: + - /v3/projects + - /rest/reference/projects +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /projects + - /cards + - /collaborators + - /columns +--- diff --git a/translations/zh-CN/content/rest/projects/projects.md b/translations/zh-CN/content/rest/projects/projects.md new file mode 100644 index 0000000000..ff85668198 --- /dev/null +++ b/translations/zh-CN/content/rest/projects/projects.md @@ -0,0 +1,12 @@ +--- +title: Projects +intro: 'The Projects API lets you create, list, update, delete and customize projects in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/zh-CN/content/rest/pulls/comments.md b/translations/zh-CN/content/rest/pulls/comments.md new file mode 100644 index 0000000000..c18aa3d812 --- /dev/null +++ b/translations/zh-CN/content/rest/pulls/comments.md @@ -0,0 +1,26 @@ +--- +title: Review Comments +intro: 'Pull request review comments are comments on a portion of the unified diff made during a pull request review.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +Commit comments and issue comments are different from pull request review comments. You apply commit comments directly to a commit and you apply issue comments without referencing a portion of the unified diff. For more information, see "[Create a commit comment](/rest/reference/commits#create-a-commit-comment)" and "[Create an issue comment](/rest/reference/issues#create-an-issue-comment)." + +### Custom media types for pull request review comments + +These are the supported media types for pull request review comments. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + +For more information, see "[Custom media types](/rest/overview/media-types)." \ No newline at end of file diff --git a/translations/zh-CN/content/rest/pulls/index.md b/translations/zh-CN/content/rest/pulls/index.md new file mode 100644 index 0000000000..17a7f54a5d --- /dev/null +++ b/translations/zh-CN/content/rest/pulls/index.md @@ -0,0 +1,20 @@ +--- +title: Pulls +intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' +redirect_from: + - /v3/pulls + - /rest/reference/pulls +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /pulls + - /comments + - /review-requests + - /reviews +--- diff --git a/translations/zh-CN/content/rest/pulls/pulls.md b/translations/zh-CN/content/rest/pulls/pulls.md new file mode 100644 index 0000000000..7e094d8d90 --- /dev/null +++ b/translations/zh-CN/content/rest/pulls/pulls.md @@ -0,0 +1,46 @@ +--- +title: Pulls +intro: 'The Pulls API allows you to list, view, edit, create, and even merge pull requests.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](/rest/reference/issues#comments). + +Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like manipulating assignees, labels and milestones, are provided within [the Issues API](/rest/reference/issues). + +### Custom media types for pull requests + +These are the supported media types for pull requests. + + application/vnd.github.VERSION.raw+json + application/vnd.github.VERSION.text+json + application/vnd.github.VERSION.html+json + application/vnd.github.VERSION.full+json + application/vnd.github.VERSION.diff + application/vnd.github.VERSION.patch + +For more information, see "[Custom media types](/rest/overview/media-types)." + +If a diff is corrupt, contact {% data variables.contact.contact_support %}. Include the repository name and pull request ID in your message. + +### Link Relations + +Pull Requests have these possible link relations: + +Name | Description +-----|-----------| +`self`| The API location of this Pull Request. +`html`| The HTML location of this Pull Request. +`issue`| The API location of this Pull Request's [Issue](/rest/reference/issues). +`comments`| The API location of this Pull Request's [Issue comments](/rest/reference/issues#comments). +`review_comments`| The API location of this Pull Request's [Review comments](/rest/reference/pulls#comments). +`review_comment`| The [URL template](/rest#hypermedia) to construct the API location for a [Review comment](/rest/reference/pulls#comments) in this Pull Request's repository. +`commits`|The API location of this Pull Request's [commits](#list-commits-on-a-pull-request). +`statuses`| The API location of this Pull Request's [commit statuses](/rest/reference/commits#commit-statuses), which are the statuses of its `head` branch. diff --git a/translations/zh-CN/content/rest/pulls/review-requests.md b/translations/zh-CN/content/rest/pulls/review-requests.md new file mode 100644 index 0000000000..dc43b989bb --- /dev/null +++ b/translations/zh-CN/content/rest/pulls/review-requests.md @@ -0,0 +1,14 @@ +--- +title: Review Requests +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/pulls/reviews.md b/translations/zh-CN/content/rest/pulls/reviews.md new file mode 100644 index 0000000000..8912d09ecb --- /dev/null +++ b/translations/zh-CN/content/rest/pulls/reviews.md @@ -0,0 +1,13 @@ +--- +title: Reviews +intro: 'Pull Request Reviews are groups of Pull Request Review Comments on the Pull Request, grouped together with a state and optional body comment.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + diff --git a/translations/zh-CN/content/rest/rate-limit.md b/translations/zh-CN/content/rest/rate-limit.md new file mode 100644 index 0000000000..502ba87c86 --- /dev/null +++ b/translations/zh-CN/content/rest/rate-limit.md @@ -0,0 +1,33 @@ +--- +title: Rate limit +intro: 'With the Rate Limit API, you can check the current rate limit status of various REST APIs.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/rate-limit +--- + +The REST API overview documentation describes the [rate limit rules](/rest/overview/resources-in-the-rest-api#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below. + +### Understanding your rate limit status + +The Search API has a [custom rate limit](/rest/reference/search#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations#rate-limit) that is separate from and calculated differently than rate limits in the REST API. + +For these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four +objects: + +* The `core` object provides your rate limit status for all non-search-related resources in the REST API. + +* The `search` object provides your rate limit status for the [Search API](/rest/reference/search). + +* The `graphql` object provides your rate limit status for the [GraphQL API]({% ifversion ghec%}/free-pro-team@latest{% endif %}/graphql). + +* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint. + +For more information on the headers and values in the rate limit response, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limit-http-headers)." diff --git a/translations/zh-CN/content/rest/reactions.md b/translations/zh-CN/content/rest/reactions.md new file mode 100644 index 0000000000..6ba29b6b1d --- /dev/null +++ b/translations/zh-CN/content/rest/reactions.md @@ -0,0 +1,20 @@ +--- +title: Reactions +intro: 'The Reactions API enables you to create, list and delete the reactions on comments.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/reactions +--- + +### Reaction types + +When creating a reaction, the allowed values for the `content` parameter are as follows (with the corresponding emoji for reference): + +{% data reusables.repositories.reaction_list %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/reference/actions.md b/translations/zh-CN/content/rest/reference/actions.md deleted file mode 100644 index ffdc12e11f..0000000000 --- a/translations/zh-CN/content/rest/reference/actions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 操作 -intro: '通过 Actions API，您可以管理和控制组织或仓库的 {% data variables.product.prodname_actions %}。' -redirect_from: - - /v3/actions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/activity.md b/translations/zh-CN/content/rest/reference/activity.md deleted file mode 100644 index 39b7b738a7..0000000000 --- a/translations/zh-CN/content/rest/reference/activity.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 活动 -intro: Activity API 允许您列出事件和订阅，并管理通知、星标和关注认证用户。 -redirect_from: - - /v3/activity -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/apps.md b/translations/zh-CN/content/rest/reference/apps.md deleted file mode 100644 index 156e662afe..0000000000 --- a/translations/zh-CN/content/rest/reference/apps.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 应用 -intro: GitHub Apps API 使您能够检索有关安装的信息以及有关 GitHub 应用程序的特定信息。 -redirect_from: - - /v3/apps -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/billing.md b/translations/zh-CN/content/rest/reference/billing.md deleted file mode 100644 index 441b78aed1..0000000000 --- a/translations/zh-CN/content/rest/reference/billing.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: 计费 -intro: '使用计费 API，可以监视用户或组织的费用和使用情况 {% data variables.product.prodname_actions %} 及 {% data variables.product.prodname_registry %}。' -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.4' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/branches.md b/translations/zh-CN/content/rest/reference/branches.md deleted file mode 100644 index 1dc5503cc7..0000000000 --- a/translations/zh-CN/content/rest/reference/branches.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 分支 -intro: 分支 API 允许您修改分支及其保护设置。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/checks.md b/translations/zh-CN/content/rest/reference/checks.md deleted file mode 100644 index 74fe8fccbf..0000000000 --- a/translations/zh-CN/content/rest/reference/checks.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 检查 -intro: '使用 Checks API，您可以构建 {% data variables.product.prodname_github_apps %} ，针对仓库中的代码更改运行强大的检查。' -redirect_from: - - /v3/checks -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/code-scanning.md b/translations/zh-CN/content/rest/reference/code-scanning.md deleted file mode 100644 index 84228437b0..0000000000 --- a/translations/zh-CN/content/rest/reference/code-scanning.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: 代码扫描 -intro: 代码扫描 API 可让您从仓库检索和更新代码扫描警报和分析。 -redirect_from: - - /v3/code-scanning -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -type: reference -topics: - - API - - Code scanning - - REST -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/codes-of-conduct.md b/translations/zh-CN/content/rest/reference/codes-of-conduct.md deleted file mode 100644 index 08b8c5f1bb..0000000000 --- a/translations/zh-CN/content/rest/reference/codes-of-conduct.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 行为准则 -intro: 行为准则 API 可让您检索有关特定仓库行为准则的信息。 -redirect_from: - - /v3/codes_of_conduct - - /v3/codes-of-conduct -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/codespaces.md b/translations/zh-CN/content/rest/reference/codespaces.md deleted file mode 100644 index 3a07a37eb0..0000000000 --- a/translations/zh-CN/content/rest/reference/codespaces.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Codespaces -intro: '{% data variables.product.prodname_codespaces %} API 允许您使用 REST API 管理代码空间。' -product: '{% data reusables.gated-features.codespaces %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/collaborators.md b/translations/zh-CN/content/rest/reference/collaborators.md deleted file mode 100644 index b204776844..0000000000 --- a/translations/zh-CN/content/rest/reference/collaborators.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 协作者 -intro: 协作者 API 允许您在存储库中添加、邀请和删除协作者。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/commits.md b/translations/zh-CN/content/rest/reference/commits.md deleted file mode 100644 index 9302a439ae..0000000000 --- a/translations/zh-CN/content/rest/reference/commits.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 提交 -intro: 提交 API 允许您列出、查看和比较存储库中的提交。 您还可以与提交注释和提交状态进行交互。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/dependabot.md b/translations/zh-CN/content/rest/reference/dependabot.md deleted file mode 100644 index 09825a3bde..0000000000 --- a/translations/zh-CN/content/rest/reference/dependabot.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Dependabot -intro: '使用 {% data variables.product.prodname_dependabot %} 机密 API，您可以管理和控制组织或存储库的 {% data variables.product.prodname_dependabot %} 机密。' -versions: - fpt: '*' - ghes: '>=3.4' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/deploy_keys.md b/translations/zh-CN/content/rest/reference/deploy_keys.md deleted file mode 100644 index 2a49dbdf47..0000000000 --- a/translations/zh-CN/content/rest/reference/deploy_keys.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Deploy Keys -intro: 'The Deploy Keys API allows to create an SSH key that is stored on your server and grants access to a GitHub repository.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - \ No newline at end of file diff --git a/translations/zh-CN/content/rest/reference/deployments.md b/translations/zh-CN/content/rest/reference/deployments.md deleted file mode 100644 index 196d332a4e..0000000000 --- a/translations/zh-CN/content/rest/reference/deployments.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 部署 -intro: 部署 API 允许您创建和删除部署和部署环境。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/emojis.md b/translations/zh-CN/content/rest/reference/emojis.md deleted file mode 100644 index 05b0229fe3..0000000000 --- a/translations/zh-CN/content/rest/reference/emojis.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 表情符号 -intro: '使用 Emojis API，您可以列出和查看在 {% data variables.product.product_name %} 使用的所有可用表情符号。' -redirect_from: - - /v3/emojis - - /v3/misc -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/enterprise-admin.md b/translations/zh-CN/content/rest/reference/enterprise-admin.md deleted file mode 100644 index c68a10d42d..0000000000 --- a/translations/zh-CN/content/rest/reference/enterprise-admin.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: GitHub Enterprise administration -intro: You can use these endpoints to administer your enterprise. -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/enterprise-admin - - /v3/enterprise -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 -shortTitle: Enterprise administration ---- - - diff --git a/translations/zh-CN/content/rest/reference/gists.md b/translations/zh-CN/content/rest/reference/gists.md deleted file mode 100644 index f478255f6b..0000000000 --- a/translations/zh-CN/content/rest/reference/gists.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Gist -intro: 'Gists API 允许授权用户在 {% data variables.product.product_name %} 上列出、创建、更新和删除公共 gist。' -redirect_from: - - /v3/gists -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/git.md b/translations/zh-CN/content/rest/reference/git.md deleted file mode 100644 index 8aee10ba77..0000000000 --- a/translations/zh-CN/content/rest/reference/git.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Git 数据库 -intro: 'Git 数据库 API 使您能够在 {% data variables.product.product_name %} 上的 Git 数据库中读取和写入原始 Git 对象，并列出和更新 Git 引用（分支头部和标记）。' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/git -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/gitignore.md b/translations/zh-CN/content/rest/reference/gitignore.md deleted file mode 100644 index 8cdd487cfb..0000000000 --- a/translations/zh-CN/content/rest/reference/gitignore.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Gitignore -intro: Gitignore API 获取可用于忽略文件和目录的 `.gitignore` 模板。 -redirect_from: - - /v3/gitignore -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/index.md b/translations/zh-CN/content/rest/reference/index.md deleted file mode 100644 index 2f211b5499..0000000000 --- a/translations/zh-CN/content/rest/reference/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: 参考 -shortTitle: 参考 -intro: 查看参考文档以了解 GitHub REST API 中可用的资源。 -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -children: - - /actions - - /activity - - /apps - - /billing - - /branches - - /checks - - /codes-of-conduct - - /code-scanning - - /codespaces - - /collaborators - - /commits - - /dependabot - - /dependency-graph - - /deploy_keys - - /deployments - - /emojis - - /enterprise-admin - - /gists - - /git - - /gitignore - - /interactions - - /issues - - /licenses - - /markdown - - /meta - - /metrics - - /migrations - - /oauth-authorizations - - /orgs - - /packages - - /pages - - /projects - - /pulls - - /rate-limit - - /reactions - - /releases - - /repos - - /scim - - /search - - /secret-scanning - - /teams - - /users - - /webhooks ---- - diff --git a/translations/zh-CN/content/rest/reference/interactions.md b/translations/zh-CN/content/rest/reference/interactions.md deleted file mode 100644 index 6d3b542fae..0000000000 --- a/translations/zh-CN/content/rest/reference/interactions.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 互动 -intro: 通过 Interactions API，拥有所有者或管理员访问权限的人可以为其组织和仓库中的用户设置互动限制。 -redirect_from: - - /v3/interactions -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/issues.md b/translations/zh-CN/content/rest/reference/issues.md deleted file mode 100644 index 2b6978ce5a..0000000000 --- a/translations/zh-CN/content/rest/reference/issues.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 议题 -intro: Issues API 使您能够查看和管理议题，包括议题受理人、评论、标签和里程碑。 -redirect_from: - - /v3/issues -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/licenses.md b/translations/zh-CN/content/rest/reference/licenses.md deleted file mode 100644 index bd4be4a411..0000000000 --- a/translations/zh-CN/content/rest/reference/licenses.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 许可 -intro: Licenses API 可让您检索热门开源许可证，以及有关特定项目许可文件的信息。 -redirect_from: - - /v3/licenses -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/markdown.md b/translations/zh-CN/content/rest/reference/markdown.md deleted file mode 100644 index e2bc098377..0000000000 --- a/translations/zh-CN/content/rest/reference/markdown.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Markdown -intro: Markdown API 可让您渲染 markdown 文档作为 HTML 页面或原始文本。 -redirect_from: - - /v3/markdown -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/meta.md b/translations/zh-CN/content/rest/reference/meta.md deleted file mode 100644 index 99ac3f9bd2..0000000000 --- a/translations/zh-CN/content/rest/reference/meta.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 元数据 -intro: 'Meta API 返回关于 {% data variables.product.product_name %} 的元信息，包括 {% data variables.product.product_name %} 服务的 IP 地址。' -redirect_from: - - /v3/meta -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/metrics.md b/translations/zh-CN/content/rest/reference/metrics.md deleted file mode 100644 index 860454ed49..0000000000 --- a/translations/zh-CN/content/rest/reference/metrics.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Metrics -intro: 存储库指标 API 允许您检索存储库的社区配置文件、统计信息和流量。 -allowTitleToDifferFromFilename: true -redirect_from: - - /rest/reference/repository-metrics -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/migrations.md b/translations/zh-CN/content/rest/reference/migrations.md deleted file mode 100644 index 682027b256..0000000000 --- a/translations/zh-CN/content/rest/reference/migrations.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 迁移 -intro: 'Migration API 可让您将组织的仓库和用户从 {% data variables.product.prodname_dotcom_the_website %} 迁移到 {% data variables.product.prodname_ghe_server %}。' -redirect_from: - - /v3/migrations - - /v3/migration - - /v3/migration/migrations -versions: - fpt: '*' - ghec: '*' - ghes: '>3.3' - ghae: issue-6184 -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/oauth-authorizations.md b/translations/zh-CN/content/rest/reference/oauth-authorizations.md deleted file mode 100644 index f374ea55b7..0000000000 --- a/translations/zh-CN/content/rest/reference/oauth-authorizations.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: OAuth 授权 -redirect_from: - - /v3/oauth_authorizations - - /v3/oauth-authorizations -versions: - ghes: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/orgs.md b/translations/zh-CN/content/rest/reference/orgs.md deleted file mode 100644 index 25f7b8f567..0000000000 --- a/translations/zh-CN/content/rest/reference/orgs.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 组织 -intro: 'Organizations API 允许您控制和管理所有 {% data variables.product.product_name %} 组织。' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/orgs -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/packages.md b/translations/zh-CN/content/rest/reference/packages.md deleted file mode 100644 index 57b9faaf69..0000000000 --- a/translations/zh-CN/content/rest/reference/packages.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Packages -intro: '通过 {% data variables.product.prodname_registry %} API，您可以管理 {% data variables.product.prodname_dotcom %} 仓库和组织的软件包。' -product: '{% data reusables.gated-features.packages %}' -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/pages.md b/translations/zh-CN/content/rest/reference/pages.md deleted file mode 100644 index 47c77757d3..0000000000 --- a/translations/zh-CN/content/rest/reference/pages.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 页面 -intro: GitHub Pages API 允许您与 GitHub Pages 站点交互并构建信息。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/projects.md b/translations/zh-CN/content/rest/reference/projects.md deleted file mode 100644 index fa1f47dc11..0000000000 --- a/translations/zh-CN/content/rest/reference/projects.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 项目 -intro: Projects API 允许您在仓库中创建、列出、更新、删除和自定义项目。 -redirect_from: - - /v3/projects -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/pulls.md b/translations/zh-CN/content/rest/reference/pulls.md deleted file mode 100644 index 5d66e2233e..0000000000 --- a/translations/zh-CN/content/rest/reference/pulls.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 拉取 -intro: 拉取 API 允许您列出、查看、编辑、创建甚至合并拉取请求。 -redirect_from: - - /v3/pulls -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/rate-limit.md b/translations/zh-CN/content/rest/reference/rate-limit.md deleted file mode 100644 index a11860eb49..0000000000 --- a/translations/zh-CN/content/rest/reference/rate-limit.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 速率限制 -intro: 使用速率限制 API，您可以检查各种 REST API 的当前速率限制状态。 -redirect_from: - - /v3/rate_limit - - /v3/rate-limit -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/reactions.md b/translations/zh-CN/content/rest/reference/reactions.md deleted file mode 100644 index 9cf4549090..0000000000 --- a/translations/zh-CN/content/rest/reference/reactions.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 反应 -intro: 反应 API 使您能够创建、列出和删除评论中的反应。 -redirect_from: - - /v3/reactions -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/releases.md b/translations/zh-CN/content/rest/reference/releases.md deleted file mode 100644 index 953d2a207b..0000000000 --- a/translations/zh-CN/content/rest/reference/releases.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 版本发布 -intro: 发行版 API 允许您创建、修改和删除版本以及发布资产。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/repos.md b/translations/zh-CN/content/rest/reference/repos.md deleted file mode 100644 index c25d170283..0000000000 --- a/translations/zh-CN/content/rest/reference/repos.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 仓库 -intro: '仓库 API 允许创建、管理以及控制公共和私有 {% data variables.product.product_name %} 仓库的工作流程。' -allowTitleToDifferFromFilename: true -redirect_from: - - /v3/repos -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/scim.md b/translations/zh-CN/content/rest/reference/scim.md deleted file mode 100644 index 04db551e47..0000000000 --- a/translations/zh-CN/content/rest/reference/scim.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: SCIM -intro: '您可以使用 SCIM API 控制和管理您的 {% data variables.product.product_name %} 组织成员访问。' -redirect_from: - - /v3/scim -versions: - fpt: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/search.md b/translations/zh-CN/content/rest/reference/search.md deleted file mode 100644 index e7eaa865ab..0000000000 --- a/translations/zh-CN/content/rest/reference/search.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 搜索 -intro: '{% data variables.product.product_name %} 搜索 API 允许您高效地搜索特定项目。' -redirect_from: - - /v3/search -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/secret-scanning.md b/translations/zh-CN/content/rest/reference/secret-scanning.md deleted file mode 100644 index 272fe06284..0000000000 --- a/translations/zh-CN/content/rest/reference/secret-scanning.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: 秘密扫描 -intro: 使用机密扫描 API 从存储库中检索和更新机密警报。 -versions: - fpt: '*' - ghes: '*' - ghec: '*' - ghae: '*' -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/teams.md b/translations/zh-CN/content/rest/reference/teams.md deleted file mode 100644 index 2e421abcbd..0000000000 --- a/translations/zh-CN/content/rest/reference/teams.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 团队 -intro: '通过团队 API，您可以在您的 {% data variables.product.product_name %} 组织中创建和管理团队。' -redirect_from: - - /v3/teams -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/users.md b/translations/zh-CN/content/rest/reference/users.md deleted file mode 100644 index dedfb4471a..0000000000 --- a/translations/zh-CN/content/rest/reference/users.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 用户 -intro: 用户 API 允许获取有关经过验证的用户的公共和私人信息。 -redirect_from: - - /v3/users -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/reference/webhooks.md b/translations/zh-CN/content/rest/reference/webhooks.md deleted file mode 100644 index 0af83e0ab0..0000000000 --- a/translations/zh-CN/content/rest/reference/webhooks.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Web 挂钩 -intro: Web 挂钩 API 允许您为存储库创建和管理 web 挂钩。 -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - API -miniTocMaxHeadingLevel: 3 ---- - - diff --git a/translations/zh-CN/content/rest/releases/assets.md b/translations/zh-CN/content/rest/releases/assets.md new file mode 100644 index 0000000000..44956c13a1 --- /dev/null +++ b/translations/zh-CN/content/rest/releases/assets.md @@ -0,0 +1,13 @@ +--- +title: Release Assets +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/releases/index.md b/translations/zh-CN/content/rest/releases/index.md new file mode 100644 index 0000000000..c3447b9110 --- /dev/null +++ b/translations/zh-CN/content/rest/releases/index.md @@ -0,0 +1,18 @@ +--- +title: Releases +intro: 'The releases API allows you to create, modify, and delete releases and release assets.' +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /releases + - /assets +redirect_from: + - /rest/reference/releases +--- diff --git a/translations/zh-CN/content/rest/releases/releases.md b/translations/zh-CN/content/rest/releases/releases.md new file mode 100644 index 0000000000..fa1cb398fc --- /dev/null +++ b/translations/zh-CN/content/rest/releases/releases.md @@ -0,0 +1,19 @@ +--- +title: Releases +intro: 'The Releases API allows you to create, modify, and delete releases and release assets. +' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +{% note %} + +**Note:** The Releases API replaces the Downloads API. You can retrieve the download count and browser download URL from the endpoints in this API that return releases and release assets. + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/repos/autolinks.md b/translations/zh-CN/content/rest/repos/autolinks.md new file mode 100644 index 0000000000..ba9b5afafd --- /dev/null +++ b/translations/zh-CN/content/rest/repos/autolinks.md @@ -0,0 +1,16 @@ +--- +title: Autolinks +intro: 'To help streamline your workflow, you can use the API to add autolinks to external resources like JIRA issues and Zendesk tickets.' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." + +{% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use the Autolinks API. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/repos/contents.md b/translations/zh-CN/content/rest/repos/contents.md new file mode 100644 index 0000000000..a402506eeb --- /dev/null +++ b/translations/zh-CN/content/rest/repos/contents.md @@ -0,0 +1,34 @@ +--- +title: Contents +intro: 'These API endpoints let you create, modify, and delete Base64 encoded content in a repository.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +To request the raw format or rendered HTML (when supported), use custom media types for repository contents. + +### Custom media types for repository contents + +[READMEs](/rest/reference/repos#get-a-repository-readme), [files](/rest/reference/repos#get-repository-content), and [symlinks](/rest/reference/repos#get-repository-content) support the following custom media types: + + application/vnd.github.VERSION.raw + application/vnd.github.VERSION.html + +Use the `.raw` media type to retrieve the contents of the file. + +For markup files such as Markdown or AsciiDoc, you can retrieve the rendered HTML using the `.html` media type. Markup languages are rendered to HTML using our open-source [Markup library](https://github.com/github/markup). + +[All objects](/rest/reference/repos#get-repository-content) support the following custom media type: + + application/vnd.github.VERSION.object + +Use the `object` media type parameter to retrieve the contents in a consistent object format regardless of the content type. For example, instead of an array of objects +for a directory, the response will be an object with an `entries` attribute containing the array of objects. + +You can read more about the use of media types in the API [here](/rest/overview/media-types). \ No newline at end of file diff --git a/translations/zh-CN/content/rest/repos/forks.md b/translations/zh-CN/content/rest/repos/forks.md new file mode 100644 index 0000000000..5a7928f9aa --- /dev/null +++ b/translations/zh-CN/content/rest/repos/forks.md @@ -0,0 +1,12 @@ +--- +title: Forks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/repos/index.md b/translations/zh-CN/content/rest/repos/index.md new file mode 100644 index 0000000000..7232e7da73 --- /dev/null +++ b/translations/zh-CN/content/rest/repos/index.md @@ -0,0 +1,23 @@ +--- +title: Repositories +intro: 'The Repos API allows to create, manage and control the workflow of public and private {% data variables.product.product_name %} repositories.' +allowTitleToDifferFromFilename: true +redirect_from: + - /v3/repos + - /rest/reference/repos +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /repos + - /autolinks + - /contents + - /forks + - /lfs + - /tags +--- diff --git a/translations/zh-CN/content/rest/repos/lfs.md b/translations/zh-CN/content/rest/repos/lfs.md new file mode 100644 index 0000000000..3b11137030 --- /dev/null +++ b/translations/zh-CN/content/rest/repos/lfs.md @@ -0,0 +1,13 @@ +--- +title: Git LFS +intro: '' +versions: + fpt: '*' + ghes: '>=3.3' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/repos/repos.md b/translations/zh-CN/content/rest/repos/repos.md new file mode 100644 index 0000000000..8941c62602 --- /dev/null +++ b/translations/zh-CN/content/rest/repos/repos.md @@ -0,0 +1,13 @@ +--- +title: Repositories +intro: 'The Repos API allows to create, manage and control the workflow of public and private GitHub Enterprise Server repositories.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/repos/tags.md b/translations/zh-CN/content/rest/repos/tags.md new file mode 100644 index 0000000000..7685300da2 --- /dev/null +++ b/translations/zh-CN/content/rest/repos/tags.md @@ -0,0 +1,10 @@ +--- +title: Tags +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- diff --git a/translations/zh-CN/content/rest/scim.md b/translations/zh-CN/content/rest/scim.md new file mode 100644 index 0000000000..8f63ea1bb9 --- /dev/null +++ b/translations/zh-CN/content/rest/scim.md @@ -0,0 +1,54 @@ +--- +title: SCIM +intro: 'You can control and manage your GitHub organization members access using SCIM API.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/scim +--- + +### SCIM Provisioning for Organizations + +The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.product_name %} organization membership. The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API is based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). The {% data variables.product.product_name %} SCIM endpoint that an IdP should use is: `{% data variables.product.api_url_code %}/scim/v2/organizations/{org}/`. + +{% note %} + +**Notes:** + - The SCIM API is available only to organizations on [{% data variables.product.prodname_ghe_cloud %}](/billing/managing-billing-for-your-github-account/about-billing-for-github-accounts) with [SAML SSO](/rest/overview/other-authentication-methods#authenticating-for-saml-sso) enabled. {% data reusables.scim.enterprise-account-scim %} For more information about SCIM, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)." + - The SCIM API cannot be used with {% data variables.product.prodname_emus %}. + +{% endnote %} + +### Authenticating calls to the SCIM API + +You must authenticate as an owner of a {% data variables.product.product_name %} organization to use its SCIM API. The API expects an [OAuth 2.0 Bearer](/developers/apps/authenticating-with-github-apps) token to be included in the `Authorization` header. You may also use a personal access token, but you must first [authorize it for use with your SAML SSO organization](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). + +### Mapping of SAML and SCIM data + +{% data reusables.scim.nameid-and-username-must-match %} + +### Supported SCIM User attributes + +Name | Type | Description +-----|------|-------------- +`userName`|`string` | The username for the user. +`name.givenName`|`string` | The first name of the user. +`name.familyName`|`string` | The last name of the user. +`emails` | `array` | List of user emails. +`externalId` | `string` | This identifier is generated by the SAML provider, and is used as a unique ID by the SAML provider to match against a GitHub user. You can find the `externalID` for a user either at the SAML provider, or using the [List SCIM provisioned identities](#list-scim-provisioned-identities) endpoint and filtering on other known attributes, such as a user's GitHub username or email address. +`id` | `string` | Identifier generated by the GitHub SCIM endpoint. +`active` | `boolean` | Used to indicate whether the identity is active (true) or should be deprovisioned (false). + +{% note %} + +**Note:** Endpoint URLs for the SCIM API are case sensitive. For example, the first letter in the `Users` endpoint must be capitalized: + +```shell +GET /scim/v2/organizations/{org}/Users/{scim_user_id} +``` + +{% endnote %} diff --git a/translations/zh-CN/content/rest/search.md b/translations/zh-CN/content/rest/search.md new file mode 100644 index 0000000000..a463da9363 --- /dev/null +++ b/translations/zh-CN/content/rest/search.md @@ -0,0 +1,175 @@ +--- +title: Search +intro: 'The GitHub Search API lets you to search for the specific item efficiently.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/search +--- + +The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} Search API provides **up to 1,000 results for each search**. + +You can narrow your search using queries. To learn more about the search query syntax, see "[Constructing a search query](/rest/reference/search#constructing-a-search-query)." + +### Ranking search results + +Unless another sort option is provided as a query parameter, results are sorted by best match in descending order. Multiple factors are combined to boost the most relevant item to the top of the result list. + +### Rate limit + +{% data reusables.enterprise.rate_limit %} + +The Search API has a custom rate limit. For requests using [Basic +Authentication](/rest#authentication), [OAuth](/rest#authentication), or [client +ID and secret](/rest#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to +30 requests per minute. For unauthenticated requests, the rate limit allows you +to make up to 10 requests per minute. + +See the [rate limit documentation](/rest/reference/rate-limit) for details on +determining your current rate limit status. + +### Constructing a search query + +Each endpoint in the Search API uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoint in the Search API for an example that includes the endpoint and query parameters. + +A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: + +``` +SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N +``` + +For example, if you wanted to search for all _repositories_ owned by `defunkt` that +contained the word `GitHub` and `Octocat` in the README file, you would use the +following query with the _search repositories_ endpoint: + +``` +GitHub Octocat in:readme user:defunkt +``` + +**Note:** Be sure to use your language's preferred HTML-encoder to construct your query strings. For example: +```javascript +// JavaScript +const queryString = 'q=' + encodeURIComponent('GitHub Octocat in:readme user:defunkt'); +``` + +See "[Searching on GitHub](/search-github/searching-on-github)" +for a complete list of available qualifiers, their format, and an example of +how to use them. For information about how to use operators to match specific +quantities, dates, or to exclude results, see "[Understanding the search syntax](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax/)." + +### Limitations on query length + +The Search API does not support queries that: +- are longer than 256 characters (not including operators or qualifiers). +- have more than five `AND`, `OR`, or `NOT` operators. + +These search queries will return a "Validation failed" error message. + +### Timeouts and incomplete results + +To keep the Search API fast for everyone, we limit how long any individual query +can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), +the API returns the matches that were already found prior to the timeout, and +the response has the `incomplete_results` property set to `true`. + +Reaching a timeout does not necessarily mean that search results are incomplete. +More results might have been found, but also might not. + +### Access errors or missing search results + +You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a `422 Unprocessable Entry` error with a "Validation Failed" message. For example, your search will fail if your query includes `repo:`, `user:`, or `org:` qualifiers that request resources that you don't have access to when you sign in on {% data variables.product.prodname_dotcom %}. + +When your search query requests multiple resources, the response will only contain the resources that you have access to and will **not** provide an error message listing the resources that were not returned. + +For example, if your search query searches for the `octocat/test` and `codertocat/test` repositories, but you only have access to `octocat/test`, your response will show search results for `octocat/test` and nothing for `codertocat/test`. This behavior mimics how search works on {% data variables.product.prodname_dotcom %}. + +### Text match metadata + +On GitHub, you can use the context provided by code snippets and highlights in search results. The Search API offers additional metadata that allows you to highlight the matching search terms when displaying search results. + +![code-snippet-highlighting](/assets/images/text-match-search-api.png) + +Requests can opt to receive those text fragments in the response, and every fragment is accompanied by numeric offsets identifying the exact location of each matching search term. + +To get this metadata in your search results, specify the `text-match` media type in your `Accept` header. + +```shell +application/vnd.github.v3.text-match+json +``` + +When you provide the `text-match` media type, you will receive an extra key in the JSON payload called `text_matches` that provides information about the position of your search terms within the text and the `property` that includes the search term. Inside the `text_matches` array, each object includes +the following attributes: + +Name | Description +-----|-----------| +`object_url` | The URL for the resource that contains a string property matching one of the search terms. +`object_type` | The name for the type of resource that exists at the given `object_url`. +`property` | The name of a property of the resource that exists at `object_url`. That property is a string that matches one of the search terms. (In the JSON returned from `object_url`, the full content for the `fragment` will be found in the property with this name.) +`fragment` | A subset of the value of `property`. This is the text fragment that matches one or more of the search terms. +`matches` | An array of one or more search terms that are present in `fragment`. The indices (i.e., "offsets") are relative to the fragment. (They are not relative to the _full_ content of `property`.) + +#### Example + +Using cURL, and the [example issue search](#search-issues-and-pull-requests) above, our API +request would look like this: + +``` shell +curl -H 'Accept: application/vnd.github.v3.text-match+json' \ +'{% data variables.product.api_url_pre %}/search/issues?q=windows+label:bug+language:python+state:open&sort=created&order=asc' +``` + +The response will include a `text_matches` array for each search result. In the JSON below, we have two objects in the `text_matches` array. + +The first text match occurred in the `body` property of the issue. We see a fragment of text from the issue body. The search term (`windows`) appears twice within that fragment, and we have the indices for each occurrence. + +The second text match occurred in the `body` property of one of the issue's comments. We have the URL for the issue comment. And of course, we see a fragment of text from the comment body. The search term (`windows`) appears once within that fragment. + +```json +{ + "text_matches": [ + { + "object_url": "https://api.github.com/repositories/215335/issues/132", + "object_type": "Issue", + "property": "body", + "fragment": "comprehensive windows font I know of).\n\nIf we can find a commonly distributed windows font that supports them then no problem (we can use html font tags) but otherwise the '(21)' style is probably better.\n", + "matches": [ + { + "text": "windows", + "indices": [ + 14, + 21 + ] + }, + { + "text": "windows", + "indices": [ + 78, + 85 + ] + } + ] + }, + { + "object_url": "https://api.github.com/repositories/215335/issues/comments/25688", + "object_type": "IssueComment", + "property": "body", + "fragment": " right after that are a bit broken IMHO :). I suppose we could have some hack that maxes out at whatever the font does...\n\nI'll check what the state of play is on Windows.\n", + "matches": [ + { + "text": "Windows", + "indices": [ + 163, + 170 + ] + } + ] + } + ] +} +``` diff --git a/translations/zh-CN/content/rest/secret-scanning.md b/translations/zh-CN/content/rest/secret-scanning.md new file mode 100644 index 0000000000..fad846994e --- /dev/null +++ b/translations/zh-CN/content/rest/secret-scanning.md @@ -0,0 +1,23 @@ +--- +title: Secret Scanning +intro: 'Use the Secret Scanning API to retrieve and update secret alerts from a repository.' +versions: + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +redirect_from: + - /rest/reference/secret-scanning +--- + +{% data reusables.secret-scanning.api-beta %} + +The {% data variables.product.prodname_secret_scanning %} API lets you{% ifversion fpt or ghec or ghes > 3.1 or ghae %}: + +- Enable or disable {% data variables.product.prodname_secret_scanning %}{% if secret-scanning-push-protection %} and push protection{% endif %} for a repository. For more information, see "[Repositories](/rest/reference/repos#update-a-repository)" and expand the "Properties of the `security_and_analysis` object" section in the REST API documentation. +- Retrieve and update {% data variables.product.prodname_secret_scanning_GHAS %} alerts from a repository. For further details, see the sections below. +{%- else %} retrieve and update {% data variables.product.prodname_secret_scanning %} alerts from a repository.{% endif %} + +For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." diff --git a/translations/zh-CN/content/rest/teams/discussion-comments.md b/translations/zh-CN/content/rest/teams/discussion-comments.md new file mode 100644 index 0000000000..0dde5647e0 --- /dev/null +++ b/translations/zh-CN/content/rest/teams/discussion-comments.md @@ -0,0 +1,14 @@ +--- +title: Discussion Comments +intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/teams/discussions.md b/translations/zh-CN/content/rest/teams/discussions.md new file mode 100644 index 0000000000..1a6cc51805 --- /dev/null +++ b/translations/zh-CN/content/rest/teams/discussions.md @@ -0,0 +1,14 @@ +--- +title: Discussions +intro: "The Team Discussions API allows you to get, create, edit, and delete discussion posts on a team's page." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](//organizations/collaborating-with-your-team/about-team-discussions/)." To learn more about commenting on a discussion post, see the [team discussion comments API](/rest/reference/teams#discussion-comments). This API is only available to authenticated members of the team's organization. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/teams/external-groups.md b/translations/zh-CN/content/rest/teams/external-groups.md new file mode 100644 index 0000000000..ab172bd084 --- /dev/null +++ b/translations/zh-CN/content/rest/teams/external-groups.md @@ -0,0 +1,24 @@ +--- +title: External Groups +intro: 'The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.' +versions: + fpt: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. + +{% ifversion ghec %} +{% note %} + +**Notes:** + +- The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." +- If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/teams/index.md b/translations/zh-CN/content/rest/teams/index.md new file mode 100644 index 0000000000..fc2c3a44cb --- /dev/null +++ b/translations/zh-CN/content/rest/teams/index.md @@ -0,0 +1,22 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your {% data variables.product.product_name %} organization.' +redirect_from: + - /v3/teams + - /rest/reference/teams +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /teams + - /discussion-comments + - /discussions + - /external-groups + - /members + - /team-sync +--- diff --git a/translations/zh-CN/content/rest/teams/members.md b/translations/zh-CN/content/rest/teams/members.md new file mode 100644 index 0000000000..fdcee06601 --- /dev/null +++ b/translations/zh-CN/content/rest/teams/members.md @@ -0,0 +1,23 @@ +--- +title: Members +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's organization. OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + +{% ifversion fpt or ghes or ghec %} +{% note %} + +**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% endnote %} + +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/teams/team-sync.md b/translations/zh-CN/content/rest/teams/team-sync.md new file mode 100644 index 0000000000..3b6dfa15dd --- /dev/null +++ b/translations/zh-CN/content/rest/teams/team-sync.md @@ -0,0 +1,21 @@ +--- +title: Team Synchronization +intro: 'The Team Synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups.' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + +To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see "Authorizing a personal access token for use with a SAML single sign-on organization." + +You can manage GitHub team members through your IdP with team synchronization. Team synchronization must be enabled to use the Team Synchronization API. For more information, see "Synchronizing teams between your identity provider and GitHub." + +{% note %} + +**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)". + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/teams/teams.md b/translations/zh-CN/content/rest/teams/teams.md new file mode 100644 index 0000000000..fa741a215e --- /dev/null +++ b/translations/zh-CN/content/rest/teams/teams.md @@ -0,0 +1,14 @@ +--- +title: Teams +intro: 'With the Teams API, you can create and manage teams in your GitHub organization.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +This API is only available to authenticated members of the team's [organization](/rest/reference/orgs). OAuth access tokens require the `read:org` [scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). {% data variables.product.prodname_dotcom %} generates the team's `slug` from the team `name`. diff --git a/translations/zh-CN/content/rest/users/blocking.md b/translations/zh-CN/content/rest/users/blocking.md new file mode 100644 index 0000000000..297347554f --- /dev/null +++ b/translations/zh-CN/content/rest/users/blocking.md @@ -0,0 +1,11 @@ +--- +title: Blocking Users +intro: '' +versions: + fpt: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/users/emails.md b/translations/zh-CN/content/rest/users/emails.md new file mode 100644 index 0000000000..1526e6e0a6 --- /dev/null +++ b/translations/zh-CN/content/rest/users/emails.md @@ -0,0 +1,13 @@ +--- +title: Emails +intro: '' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Management of email addresses via the API requires that you authenticate through basic auth, or through OAuth with a correct scope for the endpoint. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/users/followers.md b/translations/zh-CN/content/rest/users/followers.md new file mode 100644 index 0000000000..b93b9303cd --- /dev/null +++ b/translations/zh-CN/content/rest/users/followers.md @@ -0,0 +1,12 @@ +--- +title: Followers +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- \ No newline at end of file diff --git a/translations/zh-CN/content/rest/users/gpg-keys.md b/translations/zh-CN/content/rest/users/gpg-keys.md new file mode 100644 index 0000000000..8cc12ab55d --- /dev/null +++ b/translations/zh-CN/content/rest/users/gpg-keys.md @@ -0,0 +1,14 @@ +--- +title: GPG Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +The data returned in the `public_key` response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what is returned by the APIs on this page. This key is not suitable to be used directly by programs like GPG. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/users/index.md b/translations/zh-CN/content/rest/users/index.md new file mode 100644 index 0000000000..22145785f5 --- /dev/null +++ b/translations/zh-CN/content/rest/users/index.md @@ -0,0 +1,22 @@ +--- +title: Users +intro: The Users API allows to get public and private information about the authenticated user. +redirect_from: + - /v3/users + - /rest/reference/users +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /users + - /blocking + - /emails + - /followers + - /gpg-keys + - /keys +--- diff --git a/translations/zh-CN/content/rest/users/keys.md b/translations/zh-CN/content/rest/users/keys.md new file mode 100644 index 0000000000..ac61f9554f --- /dev/null +++ b/translations/zh-CN/content/rest/users/keys.md @@ -0,0 +1,13 @@ +--- +title: Git SSH Keys +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- \ No newline at end of file diff --git a/translations/zh-CN/content/rest/users/users.md b/translations/zh-CN/content/rest/users/users.md new file mode 100644 index 0000000000..e299587e74 --- /dev/null +++ b/translations/zh-CN/content/rest/users/users.md @@ -0,0 +1,14 @@ +--- +title: Users +intro: 'The Users API allows to get public and private information about the authenticated user.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +--- + +Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a `{username}` parameter then the response will be for the logged in user (and you must pass [authentication information](/rest/overview/resources-in-the-rest-api#authentication) with your request).{% ifversion fpt or ghes or ghec %} Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the `user` scope.{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/content/rest/webhooks/index.md b/translations/zh-CN/content/rest/webhooks/index.md new file mode 100644 index 0000000000..fb833f3c0b --- /dev/null +++ b/translations/zh-CN/content/rest/webhooks/index.md @@ -0,0 +1,79 @@ +--- +title: Webhooks +intro: The webhooks API allows you to create and manage webhooks for your repositories. +allowTitleToDifferFromFilename: true +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +children: + - /repo-config + - /repo-deliveries + - /repos +redirect_from: + - /rest/reference/webhooks +--- + +Repository webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in a repository. {% data reusables.webhooks.webhooks-rest-api-links %} + +If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks). + +In addition to the REST API, {% data variables.product.prodname_dotcom %} can also serve as a [PubSubHubbub](#pubsubhubbub) hub for repositories. + +## Receiving Webhooks + +In order for {% data variables.product.product_name %} to send webhook payloads, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS. + +### Webhook headers + +{% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/developers/webhooks-and-events/webhook-events-and-payloads#delivery-headers) for details. + +## PubSubHubbub + +GitHub can also serve as a [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub) hub for all repositories. PSHB is a simple publish/subscribe protocol that lets servers register to receive updates when a topic is updated. The updates are sent with an HTTP POST request to a callback URL. +Topic URLs for a GitHub repository's pushes are in this format: + +`https://github.com/{owner}/{repo}/events/{event}` + +The event can be any available webhook event. For more information, see "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads)." + +### Response format + +The default format is what [existing post-receive hooks should expect](/post-receive-hooks/): A JSON body sent as the `payload` parameter in a POST. You can also specify to receive the raw JSON body with either an `Accept` header, or a `.json` extension. + + Accept: application/json + https://github.com/{owner}/{repo}/events/push.json + +### Callback URLs + +Callback URLs can use the `http://` protocol. + + # Send updates to postbin.org + http://postbin.org/123 + +### Subscribing + +The GitHub PubSubHubbub endpoint is: `{% data variables.product.api_url_code %}/hub`. A successful request with curl looks like: + +``` shell +curl -u "user" -i \ + {% data variables.product.api_url_pre %}/hub \ + -F "hub.mode=subscribe" \ + -F "hub.topic=https://github.com/{owner}/{repo}/events/push" \ + -F "hub.callback=http://postbin.org/123" +``` + +PubSubHubbub requests can be sent multiple times. If the hook already exists, it will be modified according to the request. + +#### Parameters + +Name | Type | Description +-----|------|-------------- +``hub.mode``|`string` | **Required**. Either `subscribe` or `unsubscribe`. +``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. +``hub.callback``|`string` | The URI to receive the updates to the topic. +``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes > 3.0 or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghes < 3.0 %}`X-Hub-Signature` header{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. \ No newline at end of file diff --git a/translations/zh-CN/content/rest/webhooks/repo-config.md b/translations/zh-CN/content/rest/webhooks/repo-config.md new file mode 100644 index 0000000000..5653146886 --- /dev/null +++ b/translations/zh-CN/content/rest/webhooks/repo-config.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Configuration +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/webhooks/repo-deliveries.md b/translations/zh-CN/content/rest/webhooks/repo-deliveries.md new file mode 100644 index 0000000000..ee3f49cc36 --- /dev/null +++ b/translations/zh-CN/content/rest/webhooks/repo-deliveries.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhook Deliveries +intro: '' +versions: + fpt: '*' + ghes: '>=3.2' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/rest/webhooks/repos.md b/translations/zh-CN/content/rest/webhooks/repos.md new file mode 100644 index 0000000000..51d4dd89a8 --- /dev/null +++ b/translations/zh-CN/content/rest/webhooks/repos.md @@ -0,0 +1,13 @@ +--- +title: Repository Webhooks +intro: '' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- diff --git a/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index f43d8132aa..88bb1ae2c5 100644 --- a/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -35,6 +35,8 @@ shortTitle: 赞助贡献者 使用信用卡赞助帐户后，更改将立即生效。 {% data reusables.sponsors.prorated-sponsorship %} +We may share certain limited tax information with sponsored accounts. For more information, see "[Tax information](#tax-information)." + {% data reusables.sponsors.manage-updates-for-orgs %} 您可以选择是否公开显示您的赞助。 一次性赞助在一个月内保持可见。 @@ -51,6 +53,17 @@ shortTitle: 赞助贡献者 {% endnote %} +## 税务信息 + +As a sponsor, you acknowledge that we may disclose to the owner of each account you sponsor the following limited information about your sponsorship payments to the account, since the inception of the Sponsors Program: + +- Transaction date +- Amount paid +- The country, state, and province from where payment was made +- Whether payment was made by a business or individual + +This information is necessary to enable payment and reporting of any taxes arising from such sponsorship payments. + ## 赞助帐户 在赞助帐户之前，您必须拥有经过验证的电子邮件地址。 更多信息请参阅“[验证电子邮件地址](/github/getting-started-with-github/verifying-your-email-address)”。 diff --git a/translations/zh-CN/data/features/innersource-fork-policies.yml b/translations/zh-CN/data/features/innersource-fork-policies.yml deleted file mode 100644 index 121bf587df..0000000000 --- a/translations/zh-CN/data/features/innersource-fork-policies.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -#Reference: #6035 #6036 #6037 -#Documentation for enterprise policies that define where forks can be created. -versions: - ghec: '*' - ghes: '>3.5' - ghae: 'issue-6035' diff --git a/translations/zh-CN/data/reusables/actions/reusable-workflow-calling-syntax.md b/translations/zh-CN/data/reusables/actions/reusable-workflow-calling-syntax.md index 116eb98b32..cd4c7c9179 100644 --- a/translations/zh-CN/data/reusables/actions/reusable-workflow-calling-syntax.md +++ b/translations/zh-CN/data/reusables/actions/reusable-workflow-calling-syntax.md @@ -1,4 +1,4 @@ -* `{owner}/{repo}/{path}/{filename}@{ref}`{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %} for reusable workflows in public {% ifversion ghes or ghec or ghae %}or internal{% endif %} repositories. -* `./{path}/{filename}` for reusable workflows in the same repository.{% endif %} +* `{owner}/{repo}/.github/workflows/{filename}@{ref}`{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %} for reusable workflows in public {% ifversion ghes or ghec or ghae %}or internal{% endif %} repositories. +* `./.github/workflows/{filename}` for reusable workflows in the same repository.{% endif %} `{ref}` can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security. 更多信息请参阅“[GitHub Actions 的安全性增强](/actions/learn-github-actions/security-hardening-for-github-actions#reusing-third-party-workflows)”。 {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6000 %}If you use the second syntax option (without `{owner}/{repo}` and `@{ref}`) the called workflow is from the same commit as the caller workflow.{% endif %} diff --git a/translations/zh-CN/data/reusables/dependabot/private-dependencies-note.md b/translations/zh-CN/data/reusables/dependabot/private-dependencies-note.md index 8a9fd456d6..1eaaef5d35 100644 --- a/translations/zh-CN/data/reusables/dependabot/private-dependencies-note.md +++ b/translations/zh-CN/data/reusables/dependabot/private-dependencies-note.md @@ -1 +1 @@ -在运行安全性或版本更新时，有些生态系统必须能够解决来自其来源的所有依赖项，以验证版本更新是否成功。 如果清单或锁定文件包含任何私有依赖项，{% data variables.product.prodname_dependabot %} 必须能够访问这些依赖项所在的位置。 组织所有者可以授予 {% data variables.product.prodname_dependabot %} 访问包含同一个组织内项目依赖项的私有仓库. 更多信息请参阅“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)”。 您可以在仓库的 _dependabot.yml_ 配置文件中配置对私有注册表的访问。 For more information, see "[Configuration options for the dependabot.yml file](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)." +在运行安全性或版本更新时，有些生态系统必须能够解决来自其来源的所有依赖项，以验证版本更新是否成功。 如果清单或锁定文件包含任何私有依赖项，{% data variables.product.prodname_dependabot %} 必须能够访问这些依赖项所在的位置。 组织所有者可以授予 {% data variables.product.prodname_dependabot %} 访问包含同一个组织内项目依赖项的私有仓库. 更多信息请参阅“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)”。 您可以在仓库的 _dependabot.yml_ 配置文件中配置对私有注册表的访问。 更多信息请参阅“[dependabot.yml 文件的配置选项](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)。” diff --git a/translations/zh-CN/data/reusables/gated-features/security-center.md b/translations/zh-CN/data/reusables/gated-features/security-center.md index f895759a49..e05e282403 100644 --- a/translations/zh-CN/data/reusables/gated-features/security-center.md +++ b/translations/zh-CN/data/reusables/gated-features/security-center.md @@ -3,4 +3,4 @@ {% elsif ghec or ghes %} The security overview for your organization is available if you have a license for {% data variables.product.prodname_GH_advanced_security %}. {% data reusables.advanced-security.more-info-ghas %} {% elsif fpt %} -The security overview is available for organizations that use {% data variables.product.prodname_enterprise %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)." {% endif %} \ No newline at end of file +The security overview is available for organizations that use {% data variables.product.prodname_enterprise %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. 更多信息请参阅“[关于 {% data variables.product.prodname_GH_advanced_security %}](/get-started/learning-about-github/about-github-advanced-security)”。 {% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/repositories/you-can-fork.md b/translations/zh-CN/data/reusables/repositories/you-can-fork.md index de390a3d08..850c66173d 100644 --- a/translations/zh-CN/data/reusables/repositories/you-can-fork.md +++ b/translations/zh-CN/data/reusables/repositories/you-can-fork.md @@ -1,11 +1,7 @@ -{% ifversion ghae %} -If the policies for your enterprise permit forking private and internal repositories, you can fork a repository to your personal account or an organization where you have repository creation permissions. 更多信息请参阅“[组织中的角色](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)”。 +{% ifversion ghae %}If the policies for your enterprise permit forking internal and private repositories, you{% else %}You{% endif %} can fork a repository to your personal account or any organization where you have repository creation permissions. 更多信息请参阅“[组织中的角色](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)”。 -{% elsif ghes or ghec %} -You can fork a private or internal repository to your personal account or an organization on -{% data variables.product.product_location %} where you have repository creation permissions, if settings for the repository and your enterprise policies allow forking. +{% ifversion fpt or ghes or ghec %} + +If you have access to a private repository and the owner permits forking, you can fork the repository to your personal account or any organization on {% ifversion fpt or ghec %}{% data variables.product.prodname_team %}{% else %}{% data variables.product.product_location %}{% endif %} where you have repository creation permissions. {% ifversion fpt or ghec %}您不能将私有仓库复刻到使用 {% data variables.product.prodname_free_team %} 的组织。 更多信息请参阅“[GitHub 的产品](/articles/githubs-products)”。{% endif %} -{% elsif fpt %} -If you have access to a private repository and the owner permits forking, you can fork the repository to your personal account, or an organization on -{% data variables.product.prodname_team %} where you have repository creation permissions. You cannot fork a private repository to an organization using {% data variables.product.prodname_free_team %}. 更多信息请参阅“[GitHub's products](/articles/githubs-products)”。 {% endif %} diff --git a/translations/zh-CN/data/reusables/rest-reference/dependency-graph/dependency-review.md b/translations/zh-CN/data/reusables/rest-reference/dependency-graph/dependency-review.md index 559e0f0243..0e2b8417af 100644 --- a/translations/zh-CN/data/reusables/rest-reference/dependency-graph/dependency-review.md +++ b/translations/zh-CN/data/reusables/rest-reference/dependency-graph/dependency-review.md @@ -2,4 +2,4 @@ {% data reusables.dependency-review.dependency-review-api-beta-note %} -The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." \ No newline at end of file +The Dependency Review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. 有关依赖项审查的详细信息，请参阅“[关于依赖项审查](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)”。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/sponsors/sponsorship-details.md b/translations/zh-CN/data/reusables/sponsors/sponsorship-details.md index af2fca2d88..00c6836080 100644 --- a/translations/zh-CN/data/reusables/sponsors/sponsorship-details.md +++ b/translations/zh-CN/data/reusables/sponsors/sponsorship-details.md @@ -1 +1 @@ -You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your personal account or an organization. 有多个赞助等级可供选择，一次性或月度支付金额和福利由被赞助帐户设定。 您的赞助将分享您帐户的现有帐单日期、付款方式和收据。 +You can sponsor anyone with a sponsored developer profile or sponsored organization profile on behalf of your personal account or an organization. 有多个赞助等级可供选择，一次性或月度支付金额和福利由被赞助帐户设定。 Your sponsorship will share your account’s existing billing date, payment method, and receipt.